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
CreditCardReference Parameters:
NameParameterData TypeRequiredDescription
GroupIdbodystringYes
CardNumberbodystringYes
CardTypebodystringYes

Allowable Values

  • AMEX
  • VISA
  • MC
  • DISC
  • DC
  • DCI
ExpirationMonthbodyintYes
ExpirationYearbodyintYes
CreditCardReferenceReply Parameters:
NameParameterData TypeRequiredDescription
CardTokenformstringNoSame as CardReference, however this field is deprecated
ErrorMessageformstringNo
ErrorCodeformintNo
IsErrorformboolNo
CardReferenceformstringNo

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
}