Billhighway Cloud API

<back to all web services

CoreChargeRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/charge
import Foundation
import ServiceStack

public class CoreChargeRq : IChargeRequest, Codable
{
    // @ApiMember(ParameterType="path")
    public var integrationType:String?

    public var nationalId:Int?
    public var chapterId:Int?
    public var storedAccountId:Int?
    public var contextIntegrationPartnerId:Int?
    public var callerIntegrationPartnerId:Int?
    public var userId:Int?
    public var authenticationId:Int?
    public var chargeType:String?
    public var token:String?
    // @ApiMember(Format="decimal", ParameterType="model")
    public var amount:Double?

    public var Description:String?
    public var invoices:[Int:Double] = [:]
    public var createdById:Int?
    public var referenceIds:[ReferenceIdTypedAssociationItem] = []
    public var transactionId:Int?

    required public init(){}
}

public class ReferenceIdTypedAssociationItem : Codable
{
    public var value:String?
    public var type:String?

    required public init(){}
}

public class CoreChargeRs : Codable
{
    public var transactionId:String?
    public var storedAccountId:Int?
    public var nationalId:Int?
    public var chapterId:Int?
    public var chargeType:String?
    public var integrationType:String?
    public var contextIntegrationPartnerId:Int?
    public var callerIntegrationPartnerId:Int?
    public var gatewayResponse:CoreChargeGatewaySaleResponse?
    public var chargeDetails:CoreChargeDetails?

    required public init(){}
}

public class CoreChargeGatewaySaleResponse : Codable
{
    public var failureType:String?
    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?

    required public init(){}
}

public class CoreChargeDetails : Codable
{
    public var paymentType:String?
    public var amount:Int?
    public var integrationType:String?
    public var currency:String?
    public var cardDetails:CoreCreditCardChargeDetails?

    required public init(){}
}

public class CoreCreditCardChargeDetails : Codable
{
    public var cardType:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var last4:String?
    public var address:CreditCardBillingAddressItem?
    public var verificationResult:CreditCardChargeVerificationResult?

    required public init(){}
}

public class CreditCardBillingAddressItem : Codable
{
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var postalCode:String?
    public var region:String?
    public var country:String?
    public var attributes:[AttributeItem] = []

    required public init(){}
}

public class AttributeItem : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class CreditCardChargeVerificationResult : Codable
{
    public var networkVerificationAttempted:Bool?
    public var cvvVerificationResult:String?
    public var addressVerificationResult:String?
    public var postalCodeVerificationResult:String?

    required public init(){}
}

Swift CoreChargeRq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /integrations/api/{integrationType}/core/charge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"integrationType":"String","NationalId":0,"ChapterId":0,"StoredAccountId":0,"ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"UserId":0,"AuthenticationId":0,"ChargeType":"String","Token":"String","Amount":0,"Description":"String","Invoices":{"0":0},"CreatedById":0,"ReferenceIds":[{"Value":"String","Type":"String"}],"TransactionId":0}

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

{"TransactionId":"String","StoredAccountId":0,"NationalId":0,"ChapterId":0,"ChargeType":"String","IntegrationType":"String","ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"GatewayResponse":{"FailureType":"String","IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String"},"ChargeDetails":{"PaymentType":"String","Amount":0,"IntegrationType":"String","Currency":"String","CardDetails":{"CardType":"String","ExpMonth":0,"ExpYear":0,"Last4":"String","Address":{"Address1":"String","Address2":"String","City":"String","PostalCode":"String","Region":"String","Country":"String","Attributes":[{"Name":"String","Value":"String"}]},"VerificationResult":{"NetworkVerificationAttempted":false,"CvvVerificationResult":"String","AddressVerificationResult":"String","PostalCodeVerificationResult":"String"}}}}