Billhighway Cloud API

CreditCardRefund

The following routes are available for this service:
POST	/api/creditcard/refund	Performs a credit card refund	Perform a partial, or full low level credit card charge reversal WITHOUT recording debit. This should be used only in conjunction with code that records the debit.


export class CreditCardCloudServiceResponse implements IHaveErrorField
{
    public IsDuplicate?: boolean;
    public IsSuccessful?: boolean;
    public ErrorCode?: string;
    public Message?: string;
    public GatewayId?: number;
    public ConfirmationNumber?: string;
    public NetworkTransactionId?: string;
    public IsError?: boolean;

    public constructor(init?: Partial<CreditCardCloudServiceResponse>) { (Object as any).assign(this, init); }
}

export class RefundResponse extends CreditCardCloudServiceResponse
{
    public IsOverpayment?: boolean;
    public PaymentNotFound?: boolean;

    public constructor(init?: Partial<RefundResponse>) { super(init); (Object as any).assign(this, init); }
}

export class CreditCardRefund extends CreditCardRefund
{

    public constructor(init?: Partial<CreditCardRefund>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CreditCardRefund DTOs

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

<CreditCardRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <CurrencyCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CurrencyCode>
  <GatewayConfirmationNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</GatewayConfirmationNumber>
  <GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</GroupId>
  <Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Location>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <RefundAmount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</RefundAmount>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</UserId>
</CreditCardRefund>

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>