Billhighway Cloud API

CreateCardRef

The following routes are available for this service:
POST	/api/creditcard/createcardref	Creates, 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:
Name	Parameter	Data Type	Required	Description
CardRef	form	string	No
CardType	form	CreditCardType	No

**CreditCardCloudServiceResponse** Parameters:
Name	Parameter	Data Type	Required
IsDuplicate	form	bool	No
IsSuccessful	form	bool	No
ErrorCode	form	string	No
Message	form	string	No
GatewayId	form	int?	No
ConfirmationNumber	form	string	No
NetworkTransactionId	form	string	No
IsError	form	bool	No

**CreditCardType** Enum:
Name	Value
AmericanExpress	0
Discover	1
MasterCard	2
Visa	3
DinersClub	4
DinersCartBlanche	5
Unknown	6

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

<CreateCardRef xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <CardNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CardNumber>
  <CardType xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">AmericanExpress</CardType>
  <CurrencyCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CurrencyCode>
  <ExpirationMonth xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ExpirationMonth>
  <ExpirationYear xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ExpirationYear>
  <GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</GroupId>
  <Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Location>
  <NameOnCard xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NameOnCard>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</UserId>
  <ValidationNum xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ValidationNum>
</CreateCardRef>

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

<CreateCardRefResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationNumber>String</ConfirmationNumber>
  <ErrorCode>String</ErrorCode>
  <GatewayId>0</GatewayId>
  <IsDuplicate>false</IsDuplicate>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <NetworkTransactionId>String</NetworkTransactionId>
  <CardRef>String</CardRef>
  <CardType>AmericanExpress</CardType>
</CreateCardRefResponse>