Billhighway Cloud API

<back to all web services

CoreChargeDonationRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/donationcharge
CoreChargeDonationRq Parameters:
NameParameterData TypeRequiredDescription
integrationTypepathstringNo
NationalIdbodyintNo
ChapterIdbodyintNo
StoredAccountIdbodylongNo
ContextIntegrationPartnerIdbodyintNo
CallerIntegrationPartnerIdbodyintNo
UserIdbodyintNo
AuthenticationIdbodyintNo
ChargeTypebodystringNo
TokenbodystringNo
AmountbodydecimalNo
DescriptionbodystringNo
CampaignIdbodyintNo
CreatedByIdbodyintNo
TransactionIdbodylongNo
PartnerReferenceIdbodystringNo
CoreChargeDonationRs Parameters:
NameParameterData TypeRequiredDescription
TransactionIdformstringNo
StoredAccountIdformlongNo
NationalIdformintNo
ChapterIdformintNo
ChargeTypeformstringNo
IntegrationTypeformstringNo
ContextIntegrationPartnerIdformintNo
CallerIntegrationPartnerIdformintNo
GatewayResponseformCoreChargeGatewaySaleResponseNo
ChargeDetailsformCoreChargeDetailsNo
CoreChargeGatewaySaleResponse Parameters:
NameParameterData TypeRequiredDescription
FailureTypeformstringNo
IsDuplicateformboolNo
IsSuccessfulformboolNo
ErrorCodeformstringNo
MessageformstringNo
GatewayIdformintNo
ConfirmationNumberformstringNo
NetworkTransactionIdformstringNo
CoreChargeDetails Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
AmountformintNo
IntegrationTypeformstringNo
CurrencyformstringNo
CardDetailsformCoreCreditCardChargeDetailsNo
CoreCreditCardChargeDetails Parameters:
NameParameterData TypeRequiredDescription
CardTypeformstringNo
ExpMonthformintNo
ExpYearformintNo
Last4formstringNo
AddressformCreditCardBillingAddressItemNo
VerificationResultformCreditCardChargeVerificationResultNo
CreditCardBillingAddressItem Parameters:
NameParameterData TypeRequiredDescription
Address1formstringNo
Address2formstringNo
CityformstringNo
PostalCodeformstringNo
RegionformstringNo
CountryformstringNo
AttributesformList<AttributeItem>No
AttributeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
CreditCardChargeVerificationResult Parameters:
NameParameterData TypeRequiredDescription
NetworkVerificationAttemptedformboolNo
CvvVerificationResultformstringNo
AddressVerificationResultformstringNo
PostalCodeVerificationResultformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /integrations/api/{integrationType}/core/donationcharge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"integrationType":"String","NationalId":0,"ChapterId":0,"StoredAccountId":0,"ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"UserId":0,"AuthenticationId":0,"ChargeType":"String","Token":"String","Amount":0,"Description":"String","CampaignId":0,"CreatedById":0,"TransactionId":0,"PartnerReferenceId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TransactionId":"String","StoredAccountId":0,"NationalId":0,"ChapterId":0,"ChargeType":"String","IntegrationType":"String","ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"GatewayResponse":{"FailureType":"String","IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String"},"ChargeDetails":{"PaymentType":"String","Amount":0,"IntegrationType":"String","Currency":"String","CardDetails":{"CardType":"String","ExpMonth":0,"ExpYear":0,"Last4":"String","Address":{"Address1":"String","Address2":"String","City":"String","PostalCode":"String","Region":"String","Country":"String","Attributes":[{"Name":"String","Value":"String"}]},"VerificationResult":{"NetworkVerificationAttempted":false,"CvvVerificationResult":"String","AddressVerificationResult":"String","PostalCodeVerificationResult":"String"}}}}