Billhighway Cloud API

CreditCardPaymentRefund

The following routes are available for this service:
POST	/api/CreditCard/Payment/Refund	Performs a credit card payment refund against	Performs a credit card payment refund.

**CreditCardPaymentRefundResult** Parameters:
Name	Parameter	Data Type	Required
TransactionRecordID	form	long	No
FailureType	form	PaymentFailureType	No
IsOverpayment	form	bool	No
PaymentNotFound	form	bool	No

**CreditCardCloudServiceResponse** Parameters:
Name	Parameter	Data Type	Required
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
IsError	form	bool	No

**PaymentFailureType** Enum:
Name	Value
None	0
Gateway	1
PaymentTransaction	2
KeyProcurment	3
CardVerification	4

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

<CreditCardPaymentRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Header xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <CampaignId>0</CampaignId>
    <ClientId>0</ClientId>
    <CreatedBy>0</CreatedBy>
    <GroupId>0</GroupId>
    <IpAddress>String</IpAddress>
    <Location>String</Location>
    <LoggedInUserId>0</LoggedInUserId>
    <Machine>String</Machine>
    <Referrer>String</Referrer>
    <Task>String</Task>
  </Header>
  <RefundInfo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Amount>0</Amount>
    <CurrencyCode>String</CurrencyCode>
    <GatewayTransactionId>String</GatewayTransactionId>
    <MemberPaymentId>0</MemberPaymentId>
    <Memo>String</Memo>
    <ReasonId>0</ReasonId>
    <Type>None</Type>
    <UserId>0</UserId>
  </RefundInfo>
</CreditCardPaymentRefund>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditCardPaymentRefundResult 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>
  <FailureType>None</FailureType>
  <IsOverpayment>false</IsOverpayment>
  <PaymentNotFound>false</PaymentNotFound>
  <TransactionRecordID>0</TransactionRecordID>
</CreditCardPaymentRefundResult>