Billhighway Cloud API

<back to all web services

CreditCardDonation

The following routes are available for this service:
POST/v1.2/payments/creditcard
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreditCardDonation : CreditCardDonation(), ICanBeRecurring, IReturnLegacyException
{
}

@DataContract(Namespace="www.billhighway.com/api")
open class LegacyApiResponse : IHaveErrorField
{
    @DataMember
    var amount:BigDecimal? = null

    @DataMember
    var confirmationNumber:String? = null

    @DataMember
    var responseCode:String? = null

    @DataMember
    var responseDescription:String? = null

    @DataMember
    var resultCode:ResultCode? = null
}

enum class ResultCode(val value:Int)
{
    @SerializedName("0") Success(0),
    @SerializedName("-7") Duplicate(-7),
    @SerializedName("-6") NotAvailable(-6),
    @SerializedName("-5") NotFound(-5),
    @SerializedName("-4") GeneralError(-4),
    @SerializedName("-3") UnexpectedError(-3),
    @SerializedName("-2") CreditCardDeclined(-2),
    @SerializedName("-1") DataValidationFailure(-1),
}

Kotlin CreditCardDonation 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 /v1.2/payments/creditcard HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ClientId":0,"GroupId":0,"Amount":0,"NameOnCard":"String","CardNumber":"String","Cvv":"String","ExpMonth":"String","ExpYear":"String","Address":"String","City":"String","State":"String","PostalCode":"String","EmailAddress":"String","Phone":"String","Memo":"String","Occurs":"String","NumberOfOccurences":"String"}

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

{"amount":0,"confirmationNumber":"String","responseCode":"String","responseDescription":"String","resultCode":0}