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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CardNumber>String</CardNumber>
  <CardType>String</CardType>
  <ExpirationMonth>0</ExpirationMonth>
  <ExpirationYear>0</ExpirationYear>
  <GroupId>String</GroupId>
</CreditCardReference>

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

<CreditCardReferenceReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CardReference>String</CardReference>
  <CardToken>String</CardToken>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <IsError>false</IsError>
</CreditCardReferenceReply>