POST | /integrations/api/{integrationType}/core/donationcharge |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
integrationType | path | string | No | |
NationalId | body | int | No | |
ChapterId | body | int | No | |
StoredAccountId | body | long | No | |
ContextIntegrationPartnerId | body | int | No | |
CallerIntegrationPartnerId | body | int | No | |
UserId | body | int | No | |
AuthenticationId | body | int | No | |
ChargeType | body | string | No | |
Token | body | string | No | |
Amount | body | decimal | No | |
Description | body | string | No | |
CampaignId | body | int | No | |
CreatedById | body | int | No | |
TransactionId | body | long | No | |
PartnerReferenceId | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransactionId | form | string | No | |
StoredAccountId | form | long | No | |
NationalId | form | int | No | |
ChapterId | form | int | No | |
ChargeType | form | string | No | |
IntegrationType | form | string | No | |
ContextIntegrationPartnerId | form | int | No | |
CallerIntegrationPartnerId | form | int | No | |
GatewayResponse | form | CoreChargeGatewaySaleResponse | No | |
ChargeDetails | form | CoreChargeDetails | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FailureType | form | string | No | |
IsDuplicate | form | bool | No | |
IsSuccessful | form | bool | No | |
ErrorCode | form | string | No | |
Message | form | string | No | |
GatewayId | form | int | No | |
ConfirmationNumber | form | string | No | |
NetworkTransactionId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentType | form | string | No | |
Amount | form | int | No | |
IntegrationType | form | string | No | |
Currency | form | string | No | |
CardDetails | form | CoreCreditCardChargeDetails | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardType | form | string | No | |
ExpMonth | form | int | No | |
ExpYear | form | int | No | |
Last4 | form | string | No | |
Address | form | CreditCardBillingAddressItem | No | |
VerificationResult | form | CreditCardChargeVerificationResult | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Address1 | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
PostalCode | form | string | No | |
Region | form | string | No | |
Country | form | string | No | |
Attributes | form | List<AttributeItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NetworkVerificationAttempted | form | bool | No | |
CvvVerificationResult | form | string | No | |
AddressVerificationResult | form | string | No | |
PostalCodeVerificationResult | form | string | No |
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
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"}}}}