Billhighway Cloud API

<back to all web services

VerifyTokenRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifytoken

export class VerifyTokenRs
{
    public CardRef?: string;
    public Success?: boolean;
    public Message?: string;

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

export class ApiClientHeader
{
    public ClientId?: number;
    public Referrer?: string;
    public IpAddress?: string;
    public LoggedInUserId?: number;
    public GroupId?: number;
    public Task?: string;
    public Machine?: string;
    public Location?: string;
    public CreatedBy?: number;
    public CampaignId?: number;
    public ReCaptchaScore?: number;

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

export class VerifyTokenRq
{
    public Header?: ApiClientHeader;
    public IntegrationType?: string;
    public NationalId?: number;
    public ChapterId?: number;
    public IntegrationPartnerId?: number;
    public Token?: string;
    public VerificationTypes?: string;

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

TypeScript VerifyTokenRq 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 /integrations/api/{integrationType}/core/verifytoken HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		ClientId: 0,
		Referrer: String,
		IpAddress: String,
		LoggedInUserId: 0,
		GroupId: 0,
		Task: String,
		Machine: String,
		Location: String,
		CreatedBy: 0,
		CampaignId: 0,
		ReCaptchaScore: 0
	},
	IntegrationType: String,
	NationalId: 0,
	ChapterId: 0,
	IntegrationPartnerId: 0,
	Token: String,
	VerificationTypes: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CardRef: String,
	Success: False,
	Message: String
}