Billhighway Cloud API

<back to all web services

IvrCcPaymentRequest

The following routes are available for this service:
POST/ivr/payment/cc
import Foundation
import ServiceStack

public class IvrCcPaymentRequest : IvrCcPaymentRequest
{
    public var paymentChoice:String?

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

    private enum CodingKeys : String, CodingKey {
        case paymentChoice
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        paymentChoice = try container.decodeIfPresent(String.self, forKey: .paymentChoice)
    }

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

public class IvrCcPaymentResponse : IvrCcPaymentResponse
{
    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)
    }
}


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

{
	PaymentChoice: String,
	UserID: 0,
	CardNumber: String,
	CvcNumber: String,
	CardType: String,
	ExpirationMonthYear: String,
	OtherAmount: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TransactionId: String,
	ErrorCode: String,
	ErrorMessage: String,
	GatewayConfirmationNumber: String,
	IsError: True
}