Billhighway Cloud API

<back to all web services

CreditCardReference

The following routes are available for this service:
POST/payments/creditcard/token(Deprecated)(Deprecated)
POST/payments/creditcard/ref
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreditCardReference
{
    @ApiMember(IsRequired=true)
    var GroupId:String? = null

    @ApiMember(IsRequired=true)
    var CardNumber:String? = null

    @ApiMember(IsRequired=true)
    var CardType:String? = null

    @ApiMember(IsRequired=true)
    var ExpirationMonth:Int? = null

    @ApiMember(IsRequired=true)
    var ExpirationYear:Int? = null
}

open class CreditCardReferenceReply : IHaveErrorField
{
    /**
    * Same as CardReference, however this field is deprecated
    */
    @ApiMember(Description="Same as CardReference, however this field is deprecated")
    var CardToken:String? = null

    var ErrorMessage:String? = null
    var ErrorCode:Int? = null
    @ApiMember(ExcludeInSchema=true)
    var IsError:Boolean? = null

    var CardReference:String? = null
}

Kotlin CreditCardReference 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 /payments/creditcard/token HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupId: String,
	CardNumber: String,
	CardType: String,
	ExpirationMonth: 0,
	ExpirationYear: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CardToken: String,
	ErrorMessage: String,
	ErrorCode: 0,
	IsError: False,
	CardReference: String
}