Billhighway Cloud API

VerifyTokenRq

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VerifyTokenRs:
    card_ref: Optional[str] = None
    success: Optional[bool] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiClientHeader:
    client_id: Optional[int] = None
    referrer: Optional[str] = None
    ip_address: Optional[str] = None
    logged_in_user_id: Optional[int] = None
    group_id: Optional[int] = None
    task: Optional[str] = None
    machine: Optional[str] = None
    location: Optional[str] = None
    created_by: Optional[int] = None
    campaign_id: Optional[int] = None
    re_captcha_score: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VerifyTokenRq:
    header: Optional[ApiClientHeader] = None
    integration_type: Optional[str] = None
    national_id: Optional[int] = None
    chapter_id: Optional[int] = None
    integration_partner_id: Optional[int] = None
    token: Optional[str] = None
    verification_types: Optional[str] = None

Python 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
}