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.


export class CreditCardCloudServiceResponse implements IHaveErrorField
{
    public IsDuplicate?: boolean;
    public IsSuccessful?: boolean;
    public ErrorCode?: string;
    public Message?: string;
    public GatewayId?: number;
    public ConfirmationNumber?: string;
    public NetworkTransactionId?: string;
    public IsError?: boolean;

    public constructor(init?: Partial<CreditCardCloudServiceResponse>) { (Object as any).assign(this, init); }
}

export enum CreditCardType
{
    AmericanExpress = 0,
    Discover = 1,
    MasterCard = 2,
    Visa = 3,
    DinersClub = 4,
    DinersCartBlanche = 5,
    Unknown = 6,
}

export class CreateCardRefResponse extends CreditCardCloudServiceResponse
{
    public CardRef?: string;
    public CardType?: CreditCardType;

    public constructor(init?: Partial<CreateCardRefResponse>) { super(init); (Object as any).assign(this, init); }
}

export class CreateCardRef extends CreateCardRef
{

    public constructor(init?: Partial<CreateCardRef>) { super(init); (Object as any).assign(this, init); }
}

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

{
	CardRef: String,
	CardType: 0,
	IsDuplicate: False,
	IsSuccessful: False,
	ErrorCode: String,
	Message: String,
	GatewayId: 0,
	ConfirmationNumber: String,
	NetworkTransactionId: String,
	IsError: True
}