Billhighway Cloud API

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardDonationRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <ConfirmationId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ConfirmationId>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <ReasonId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ReasonId>
</CreditCardDonationRefund>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefundResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationNumber>String</ConfirmationNumber>
  <ErrorCode>String</ErrorCode>
  <GatewayId>0</GatewayId>
  <IsDuplicate>false</IsDuplicate>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <NetworkTransactionId>String</NetworkTransactionId>
  <IsOverpayment>false</IsOverpayment>
  <PaymentNotFound>false</PaymentNotFound>
</RefundResponse>