Billhighway Cloud API

<back to all web services

CreditCardDonationRefund

The following routes are available for this service:
POST/api/creditcard/DonationRefund
RefundResponse Parameters:
NameParameterData TypeRequiredDescription
IsOverpaymentformboolNo
PaymentNotFoundformboolNo
CreditCardCloudServiceResponse Parameters:
NameParameterData TypeRequiredDescription
IsDuplicateformboolNo
IsSuccessfulformboolNo
ErrorCodeformstringNo
MessageformstringNo
GatewayIdformint?No
ConfirmationNumberformstringNo
NetworkTransactionIdformstringNo
IsErrorformboolNo

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 /api/creditcard/DonationRefund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardDonationRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <ConfirmationId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ConfirmationId>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <ReasonId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ReasonId>
</CreditCardDonationRefund>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefundResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationNumber>String</ConfirmationNumber>
  <ErrorCode>String</ErrorCode>
  <GatewayId>0</GatewayId>
  <IsDuplicate>false</IsDuplicate>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <NetworkTransactionId>String</NetworkTransactionId>
  <IsOverpayment>false</IsOverpayment>
  <PaymentNotFound>false</PaymentNotFound>
</RefundResponse>