Billhighway Cloud API

<back to all web services

GetDonation

The following routes are available for this service:
GET/v1.1/Donations/Get/{id}
GET/v1.2/Donations/Get/{id}
DonationReceiptsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StatusformstringNo
CampaignNameformstringNo
CampaignIdformintNo
DateformstringNo
AmountformdecimalNo
CreditCardformCreditCardUsedNo
LocationformDonationLocationNo
TransactionformDonationTransactionNo
CreditCardUsed Parameters:
NameParameterData TypeRequiredDescription
CardHolderNameformstringNo
IconformstringNo
CaptureSourceformstringNo
Last4DigitsformstringNo
TypeformstringNo
DonationLocation Parameters:
NameParameterData TypeRequiredDescription
LongitudeformdoubleNo
LatitudeformdoubleNo
DonationTransaction Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StatusformstringNo
DetailUriformstringNo
CancelUriformstringNo
CreatedByformintNo
ClientIdformintNo
GroupIdformintNo

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.

GET /v1.1/Donations/Get/{id} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationReceiptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <Amount>0</Amount>
  <CampaignId>0</CampaignId>
  <CampaignName>String</CampaignName>
  <CreditCard>
    <CaptureSource>String</CaptureSource>
    <CardHolderName>String</CardHolderName>
    <Icon>String</Icon>
    <Last4Digits>String</Last4Digits>
    <Type>String</Type>
  </CreditCard>
  <Date>String</Date>
  <Id>0</Id>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <Status>String</Status>
  <Transaction>
    <CancelUri>String</CancelUri>
    <ClientId>0</ClientId>
    <CreatedBy>0</CreatedBy>
    <DetailUri>String</DetailUri>
    <GroupId>0</GroupId>
    <Id>0</Id>
    <Status>String</Status>
  </Transaction>
</DonationReceiptsResponse>