Billhighway Cloud API

<back to all web services

CreateCardRef

The following routes are available for this service:
POST/api/creditcard/createcardrefCreates, records and returns a 'cardRef'Creates, records and returns a 'reference' to a credit card. This so called 'cardRef' can then be usedas an alternative value to pass to other credit card transactions such as Verfy or Sale potentially improving securityby not passing card numbers.
CreateCardRefResponse Parameters:
NameParameterData TypeRequiredDescription
CardRefformstringNo
CardTypeformCreditCardTypeNo
CreditCardCloudServiceResponse Parameters:
NameParameterData TypeRequiredDescription
IsDuplicateformboolNo
IsSuccessfulformboolNo
ErrorCodeformstringNo
MessageformstringNo
GatewayIdformint?No
ConfirmationNumberformstringNo
NetworkTransactionIdformstringNo
IsErrorformboolNo
CreditCardType Enum:
NameValue
AmericanExpress0
Discover1
MasterCard2
Visa3
DinersClub4
DinersCartBlanche5
Unknown6

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 /api/creditcard/createcardref HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UserId":0,"GroupId":0,"Location":"String","CurrencyCode":"String","CardType":0,"NameOnCard":"String","CardNumber":"String","ExpirationMonth":0,"ExpirationYear":0,"ValidationNum":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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