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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CreditCardRefund extends CreditCardRefund
    {
        
    }

    public static class RefundResponse extends CreditCardCloudServiceResponse
    {
        public Boolean IsOverpayment = null;
        public Boolean PaymentNotFound = null;
        
        public Boolean getIsOverpayment() { return IsOverpayment; }
        public RefundResponse setIsOverpayment(Boolean value) { this.IsOverpayment = value; return this; }
        public Boolean isPaymentNotFound() { return PaymentNotFound; }
        public RefundResponse setPaymentNotFound(Boolean value) { this.PaymentNotFound = value; return this; }
    }

    public static class CreditCardCloudServiceResponse implements IHaveErrorField
    {
        public Boolean IsDuplicate = null;
        public Boolean IsSuccessful = null;
        public String ErrorCode = null;
        public String Message = null;
        public Integer GatewayId = null;
        public String ConfirmationNumber = null;
        public String NetworkTransactionId = null;
        public Boolean IsError = null;
        
        public Boolean getIsDuplicate() { return IsDuplicate; }
        public CreditCardCloudServiceResponse setIsDuplicate(Boolean value) { this.IsDuplicate = value; return this; }
        public Boolean getIsSuccessful() { return IsSuccessful; }
        public CreditCardCloudServiceResponse setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public CreditCardCloudServiceResponse setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public CreditCardCloudServiceResponse setMessage(String value) { this.Message = value; return this; }
        public Integer getGatewayId() { return GatewayId; }
        public CreditCardCloudServiceResponse setGatewayId(Integer value) { this.GatewayId = value; return this; }
        public String getConfirmationNumber() { return ConfirmationNumber; }
        public CreditCardCloudServiceResponse setConfirmationNumber(String value) { this.ConfirmationNumber = value; return this; }
        public String getNetworkTransactionId() { return NetworkTransactionId; }
        public CreditCardCloudServiceResponse setNetworkTransactionId(String value) { this.NetworkTransactionId = value; return this; }
        public Boolean getIsError() { return IsError; }
        public CreditCardCloudServiceResponse setIsError(Boolean value) { this.IsError = value; return this; }
    }

}

Java 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
}