Billhighway Cloud API

<back to all web services

VerifyTokenRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifytoken
import 'package:servicestack/servicestack.dart';

class VerifyTokenRs implements IConvertible
{
    String? CardRef;
    bool? Success;
    String? Message;

    VerifyTokenRs({this.CardRef,this.Success,this.Message});
    VerifyTokenRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CardRef = json['CardRef'];
        Success = json['Success'];
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CardRef': CardRef,
        'Success': Success,
        'Message': Message
    };

    getTypeName() => "VerifyTokenRs";
    TypeContext? context = _ctx;
}

class ApiClientHeader implements IConvertible
{
    int? ClientId;
    String? Referrer;
    String? IpAddress;
    int? LoggedInUserId;
    int? GroupId;
    String? Task;
    String? Machine;
    String? Location;
    int? CreatedBy;
    int? CampaignId;
    double? ReCaptchaScore;

    ApiClientHeader({this.ClientId,this.Referrer,this.IpAddress,this.LoggedInUserId,this.GroupId,this.Task,this.Machine,this.Location,this.CreatedBy,this.CampaignId,this.ReCaptchaScore});
    ApiClientHeader.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ClientId = json['ClientId'];
        Referrer = json['Referrer'];
        IpAddress = json['IpAddress'];
        LoggedInUserId = json['LoggedInUserId'];
        GroupId = json['GroupId'];
        Task = json['Task'];
        Machine = json['Machine'];
        Location = json['Location'];
        CreatedBy = json['CreatedBy'];
        CampaignId = json['CampaignId'];
        ReCaptchaScore = JsonConverters.toDouble(json['ReCaptchaScore']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ClientId': ClientId,
        'Referrer': Referrer,
        'IpAddress': IpAddress,
        'LoggedInUserId': LoggedInUserId,
        'GroupId': GroupId,
        'Task': Task,
        'Machine': Machine,
        'Location': Location,
        'CreatedBy': CreatedBy,
        'CampaignId': CampaignId,
        'ReCaptchaScore': ReCaptchaScore
    };

    getTypeName() => "ApiClientHeader";
    TypeContext? context = _ctx;
}

class VerifyTokenRq implements IConvertible
{
    ApiClientHeader? Header;
    String? IntegrationType;
    int? NationalId;
    int? ChapterId;
    int? IntegrationPartnerId;
    String? Token;
    String? VerificationTypes;

    VerifyTokenRq({this.Header,this.IntegrationType,this.NationalId,this.ChapterId,this.IntegrationPartnerId,this.Token,this.VerificationTypes});
    VerifyTokenRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Header = JsonConverters.fromJson(json['Header'],'ApiClientHeader',context!);
        IntegrationType = json['IntegrationType'];
        NationalId = json['NationalId'];
        ChapterId = json['ChapterId'];
        IntegrationPartnerId = json['IntegrationPartnerId'];
        Token = json['Token'];
        VerificationTypes = json['VerificationTypes'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Header': JsonConverters.toJson(Header,'ApiClientHeader',context!),
        'IntegrationType': IntegrationType,
        'NationalId': NationalId,
        'ChapterId': ChapterId,
        'IntegrationPartnerId': IntegrationPartnerId,
        'Token': Token,
        'VerificationTypes': VerificationTypes
    };

    getTypeName() => "VerifyTokenRq";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'VerifyTokenRs': TypeInfo(TypeOf.Class, create:() => VerifyTokenRs()),
    'ApiClientHeader': TypeInfo(TypeOf.Class, create:() => ApiClientHeader()),
    'VerifyTokenRq': TypeInfo(TypeOf.Class, create:() => VerifyTokenRq()),
});

Dart 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>