Billhighway Cloud API

CreditCardReference

The following routes are available for this service:
POST	/payments/creditcard/token	(Deprecated)	(Deprecated)
POST	/payments/creditcard/ref


export class CreditCardReferenceReply implements IHaveErrorField
{
    /**
    * Same as CardReference, however this field is deprecated
    */
    // @ApiMember(Description="Same as CardReference, however this field is deprecated")
    public CardToken?: string;

    public ErrorMessage?: string;
    public ErrorCode?: number;
    // @ApiMember(ExcludeInSchema=true)
    public IsError?: boolean;

    public CardReference?: string;

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

export class CreditCardReference
{
    // @ApiMember(IsRequired=true)
    public GroupId?: string;

    // @ApiMember(IsRequired=true)
    public CardNumber?: string;

    // @ApiMember(IsRequired=true)
    public CardType?: string;

    // @ApiMember(IsRequired=true)
    public ExpirationMonth: number;

    // @ApiMember(IsRequired=true)
    public ExpirationYear: number;

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

TypeScript CreditCardReference 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 /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
}