Billhighway Cloud API

<back to all web services

VerifyTokenRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifytoken
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.DTO.Charges.Api.Request
Imports BH.CloudAPI.Common.DTO
Imports BH.CloudAPI.DTO.Charges.Api.Response

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class ApiClientHeader
            Public Overridable Property ClientId As Integer
            Public Overridable Property Referrer As String
            Public Overridable Property IpAddress As String
            Public Overridable Property LoggedInUserId As Integer
            Public Overridable Property GroupId As Integer
            Public Overridable Property Task As String
            Public Overridable Property Machine As String
            Public Overridable Property Location As String
            Public Overridable Property CreatedBy As Integer
            Public Overridable Property CampaignId As Integer
            Public Overridable Property ReCaptchaScore As Nullable(Of Decimal)
        End Class
    End Namespace

    Namespace BH.CloudAPI.DTO.Charges.Api.Request

        Public Partial Class VerifyTokenRq
            Public Overridable Property Header As ApiClientHeader
            Public Overridable Property IntegrationType As String
            Public Overridable Property NationalId As Integer
            Public Overridable Property ChapterId As Integer
            Public Overridable Property IntegrationPartnerId As Integer
            Public Overridable Property Token As String
            Public Overridable Property VerificationTypes As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.DTO.Charges.Api.Response

        Public Partial Class VerifyTokenRs
            Public Overridable Property CardRef As String
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET 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>