Billhighway Cloud API

<back to all web services

CreditCardPaymentRefund

The following routes are available for this service:
POST/api/CreditCard/Payment/RefundPerforms a credit card payment refund against Performs a credit card payment refund.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CreditCardPaymentRefund extends CreditCardPaymentRefund
    {
        
    }

    public static class CreditCardPaymentRefundResult extends CreditCardCloudServiceResponse
    {
        public Long TransactionRecordID = null;
        public PaymentFailureType FailureType = null;
        public Boolean IsOverpayment = null;
        public Boolean PaymentNotFound = null;
        
        public Long getTransactionRecordID() { return TransactionRecordID; }
        public CreditCardPaymentRefundResult setTransactionRecordID(Long value) { this.TransactionRecordID = value; return this; }
        public PaymentFailureType getFailureType() { return FailureType; }
        public CreditCardPaymentRefundResult setFailureType(PaymentFailureType value) { this.FailureType = value; return this; }
        public Boolean getIsOverpayment() { return IsOverpayment; }
        public CreditCardPaymentRefundResult setIsOverpayment(Boolean value) { this.IsOverpayment = value; return this; }
        public Boolean isPaymentNotFound() { return PaymentNotFound; }
        public CreditCardPaymentRefundResult 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; }
    }

    public static enum PaymentFailureType
    {
        @SerializedName("0") None(0),
        @SerializedName("1") Gateway(1),
        @SerializedName("2") PaymentTransaction(2),
        @SerializedName("3") KeyProcurment(3),
        @SerializedName("4") CardVerification(4);

        private final int value;
        PaymentFailureType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java CreditCardPaymentRefund DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

{"Header":{"ClientId":0,"Referrer":"String","IpAddress":"String","LoggedInUserId":0,"GroupId":0,"Task":"String","Machine":"String","Location":"String","CreatedBy":0,"CampaignId":0,"ReCaptchaScore":0},"RefundInfo":{"CurrencyCode":"String","GatewayTransactionId":"String","Amount":0,"Memo":"String","MemberPaymentId":0,"Type":0,"ReasonId":0,"UserId":0}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TransactionRecordID":0,"FailureType":0,"IsOverpayment":false,"PaymentNotFound":false,"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String","IsError":true}