Billhighway Cloud API

<back to all web services

CreditCardRefund

The following routes are available for this service:
POST/api/creditcard/refundPerforms a credit card refundPerform 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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserId: 0,
	GroupId: 0,
	Location: String,
	CurrencyCode: String,
	GatewayConfirmationNumber: String,
	RefundAmount: 0,
	Memo: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsOverpayment: False,
	PaymentNotFound: False,
	IsDuplicate: False,
	IsSuccessful: False,
	ErrorCode: String,
	Message: String,
	GatewayId: 0,
	ConfirmationNumber: String,
	NetworkTransactionId: String,
	IsError: True
}