Billhighway Cloud API

<back to all web services

CreditCardDonationRefund

The following routes are available for this service:
POST/api/creditcard/DonationRefund
import Foundation
import ServiceStack

public class CreditCardDonationRefund : CreditCardDonationRefund
{
    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 RefundResponse : CreditCardCloudServiceResponse
{
    public var isOverpayment:Bool?
    public var paymentNotFound:Bool?

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

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

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        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 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(){}
}


Swift CreditCardDonationRefund 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/DonationRefund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ConfirmationId: 0,
	Amount: 0,
	Memo: String,
	ReasonId: 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
}