Billhighway Cloud API

<back to all web services

CreditCardSale

The following routes are available for this service:
POST/api/CreditCard/SalePerforms a credit card salePerforms a low level credit card charge WITHOUT recording credit the as a deposit or payment. This shouldbe used only in conjunction with code that records the credit.
import Foundation
import ServiceStack

public class CreditCardSale : CreditCardSale
{
    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 CreditCardSaleResult : CreditCardCloudServiceResponse
{
    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 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 CreditCardSale DTOs

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

HTTP + CSV

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

POST /api/CreditCard/Sale HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"UniqueId":"String","Location":"String","CurrencyCode":"String","NameOnCard":"String","Address1":"String","Address2":"String","City":"String","State":"String","PostalCode":"String","Country":"String","CardType":0,"CardNumber":"String","ExpMonth":0,"ExpYear":0,"CVV":"String","Amount":0,"ChapAndUser":"String","Description":"String","PayLinkID":0,"AutoPay":false,"StoreCardInfo":false,"PaymentSourceTypeID":0,"PaymentSourceID":0,"ProcessingType":0,"NetworkTransactionID":"String","ReCaptchaScore":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String","IsError":true}