Billhighway Cloud API

<back to all web services

VerifyTokenRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifytoken
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type VerifyTokenRs() = 
        member val CardRef:String = null with get,set
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type ApiClientHeader() = 
        member val ClientId:Int32 = new Int32() with get,set
        member val Referrer:String = null with get,set
        member val IpAddress:String = null with get,set
        member val LoggedInUserId:Int32 = new Int32() with get,set
        member val GroupId:Int32 = new Int32() with get,set
        member val Task:String = null with get,set
        member val Machine:String = null with get,set
        member val Location:String = null with get,set
        member val CreatedBy:Int32 = new Int32() with get,set
        member val CampaignId:Int32 = new Int32() with get,set
        member val ReCaptchaScore:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type VerifyTokenRq() = 
        member val Header:ApiClientHeader = null with get,set
        member val IntegrationType:String = null with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapterId:Int32 = new Int32() with get,set
        member val IntegrationPartnerId:Int32 = new Int32() with get,set
        member val Token:String = null with get,set
        member val VerificationTypes:String = null with get,set

F# 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>