Billhighway Cloud API

<back to all web services

ConfirmDonation

The following routes are available for this service:
POST/v1.2/donations/confirm
POST/v1.1/donations/confirm
ConfirmDonationResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
SubTitleformstringNo
ImageSourceformstringNo
ConfirmationNumberformstringNo
ConfirmationMessageformstringNo
StatusformstringNo
ReceiptformReceiptNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1.2/donations/confirm HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ConfirmDonation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <DonationToken xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</DonationToken>
  <HasAgreedTerms xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">false</HasAgreedTerms>
  <Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <Receipt xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <EmailId>String</EmailId>
    <SmsPhone>String</SmsPhone>
  </Receipt>
  <Signature xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Signature>
</ConfirmDonation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConfirmDonationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationMessage>String</ConfirmationMessage>
  <ConfirmationNumber>String</ConfirmationNumber>
  <ImageSource>String</ImageSource>
  <Receipt>
    <DocGenServiceReceiptRequest>
      <ClientId>0</ClientId>
      <EmailTo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </EmailTo>
      <GroupId>0</GroupId>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Parameters>
      <TemplateType>0</TemplateType>
    </DocGenServiceReceiptRequest>
    <EmailReceiptRequest>
      <From>String</From>
      <Message>String</Message>
      <Subject>String</Subject>
      <To>String</To>
    </EmailReceiptRequest>
    <SmsReceiptRequest>
      <Message>String</Message>
      <To>String</To>
    </SmsReceiptRequest>
    <UseDocGenService>false</UseDocGenService>
  </Receipt>
  <Status>String</Status>
  <SubTitle>String</SubTitle>
  <Title>String</Title>
</ConfirmDonationResponse>