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

<VerifyTokenRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api.Request">
  <ChapterId>0</ChapterId>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <d2p1:CampaignId>0</d2p1:CampaignId>
    <d2p1:ClientId>0</d2p1:ClientId>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:GroupId>0</d2p1:GroupId>
    <d2p1:IpAddress>String</d2p1:IpAddress>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:LoggedInUserId>0</d2p1:LoggedInUserId>
    <d2p1:Machine>String</d2p1:Machine>
    <d2p1:ReCaptchaScore>0</d2p1:ReCaptchaScore>
    <d2p1:Referrer>String</d2p1:Referrer>
    <d2p1:Task>String</d2p1:Task>
  </Header>
  <IntegrationPartnerId>0</IntegrationPartnerId>
  <IntegrationType>String</IntegrationType>
  <NationalId>0</NationalId>
  <Token>String</Token>
  <VerificationTypes>String</VerificationTypes>
</VerifyTokenRq>

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

<VerifyTokenRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api.Response">
  <CardRef>String</CardRef>
  <Message>String</Message>
  <Success>false</Success>
</VerifyTokenRs>