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.

import Foundation
import ServiceStack

public class CreditCardPaymentRefund : CreditCardPaymentRefund
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class CreditCardPaymentRefundResult : CreditCardCloudServiceResponse
{
    public var transactionRecordID:Int?
    public var failureType:PaymentFailureType?
    public var isOverpayment:Bool?
    public var paymentNotFound:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case transactionRecordID
        case failureType
        case isOverpayment
        case paymentNotFound
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        transactionRecordID = try container.decodeIfPresent(Int.self, forKey: .transactionRecordID)
        failureType = try container.decodeIfPresent(PaymentFailureType.self, forKey: .failureType)
        isOverpayment = try container.decodeIfPresent(Bool.self, forKey: .isOverpayment)
        paymentNotFound = try container.decodeIfPresent(Bool.self, forKey: .paymentNotFound)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if transactionRecordID != nil { try container.encode(transactionRecordID, forKey: .transactionRecordID) }
        if failureType != nil { try container.encode(failureType, forKey: .failureType) }
        if isOverpayment != nil { try container.encode(isOverpayment, forKey: .isOverpayment) }
        if paymentNotFound != nil { try container.encode(paymentNotFound, forKey: .paymentNotFound) }
    }
}

public class CreditCardCloudServiceResponse : IHaveErrorField, Codable
{
    public var isDuplicate:Bool?
    public var isSuccessful:Bool?
    public var errorCode:String?
    public var message:String?
    public var gatewayId:Int?
    public var confirmationNumber:String?
    public var networkTransactionId:String?
    public var isError:Bool?

    required public init(){}
}

public enum PaymentFailureType : Int, Codable
{
    case None = 0
    case Gateway = 1
    case PaymentTransaction = 2
    case KeyProcurment = 3
    case CardVerification = 4
}

Swift CreditCardPaymentRefund 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/Payment/Refund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
}