Billhighway Cloud API

VerifyTokenRq

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

import Foundation
import ServiceStack

public class VerifyTokenRq : Codable
{
    public var header:ApiClientHeader?
    public var integrationType:String?
    public var nationalId:Int?
    public var chapterId:Int?
    public var integrationPartnerId:Int?
    public var token:String?
    public var verificationTypes:String?

    required public init(){}
}

public class ApiClientHeader : Codable
{
    public var clientId:Int?
    public var referrer:String?
    public var ipAddress:String?
    public var loggedInUserId:Int?
    public var groupId:Int?
    public var task:String?
    public var machine:String?
    public var location:String?
    public var createdBy:Int?
    public var campaignId:Int?
    public var reCaptchaScore:Double?

    required public init(){}
}

public class VerifyTokenRs : Codable
{
    public var cardRef:String?
    public var success:Bool?
    public var message:String?

    required public init(){}
}

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