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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Status: String,
	CampaignName: String,
	CampaignId: 0,
	Date: String,
	Amount: 0,
	CreditCard: 
	{
		CardHolderName: String,
		Icon: String,
		CaptureSource: String,
		Last4Digits: String,
		Type: String
	},
	Location: 
	{
		Longitude: 0,
		Latitude: 0
	},
	Transaction: 
	{
		Id: 0,
		Status: String,
		DetailUri: String,
		CancelUri: String,
		CreatedBy: 0,
		ClientId: 0,
		GroupId: 0
	}
}