Billhighway Cloud API

<back to all web services

VerifyTokenRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifytoken
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class VerifyTokenRq
    {
        public ApiClientHeader Header = null;
        public String IntegrationType = null;
        public Integer NationalId = null;
        public Integer ChapterId = null;
        public Integer IntegrationPartnerId = null;
        public String Token = null;
        public String VerificationTypes = null;
        
        public ApiClientHeader getHeader() { return Header; }
        public VerifyTokenRq setHeader(ApiClientHeader value) { this.Header = value; return this; }
        public String getIntegrationType() { return IntegrationType; }
        public VerifyTokenRq setIntegrationType(String value) { this.IntegrationType = value; return this; }
        public Integer getNationalId() { return NationalId; }
        public VerifyTokenRq setNationalId(Integer value) { this.NationalId = value; return this; }
        public Integer getChapterId() { return ChapterId; }
        public VerifyTokenRq setChapterId(Integer value) { this.ChapterId = value; return this; }
        public Integer getIntegrationPartnerId() { return IntegrationPartnerId; }
        public VerifyTokenRq setIntegrationPartnerId(Integer value) { this.IntegrationPartnerId = value; return this; }
        public String getToken() { return Token; }
        public VerifyTokenRq setToken(String value) { this.Token = value; return this; }
        public String getVerificationTypes() { return VerificationTypes; }
        public VerifyTokenRq setVerificationTypes(String value) { this.VerificationTypes = value; return this; }
    }

    public static class ApiClientHeader
    {
        public Integer ClientId = null;
        public String Referrer = null;
        public String IpAddress = null;
        public Integer LoggedInUserId = null;
        public Integer GroupId = null;
        public String Task = null;
        public String Machine = null;
        public String Location = null;
        public Integer CreatedBy = null;
        public Integer CampaignId = null;
        public BigDecimal ReCaptchaScore = null;
        
        public Integer getClientId() { return ClientId; }
        public ApiClientHeader setClientId(Integer value) { this.ClientId = value; return this; }
        public String getReferrer() { return Referrer; }
        public ApiClientHeader setReferrer(String value) { this.Referrer = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public ApiClientHeader setIpAddress(String value) { this.IpAddress = value; return this; }
        public Integer getLoggedInUserId() { return LoggedInUserId; }
        public ApiClientHeader setLoggedInUserId(Integer value) { this.LoggedInUserId = value; return this; }
        public Integer getGroupId() { return GroupId; }
        public ApiClientHeader setGroupId(Integer value) { this.GroupId = value; return this; }
        public String getTask() { return Task; }
        public ApiClientHeader setTask(String value) { this.Task = value; return this; }
        public String getMachine() { return Machine; }
        public ApiClientHeader setMachine(String value) { this.Machine = value; return this; }
        public String getLocation() { return Location; }
        public ApiClientHeader setLocation(String value) { this.Location = value; return this; }
        public Integer getCreatedBy() { return CreatedBy; }
        public ApiClientHeader setCreatedBy(Integer value) { this.CreatedBy = value; return this; }
        public Integer getCampaignId() { return CampaignId; }
        public ApiClientHeader setCampaignId(Integer value) { this.CampaignId = value; return this; }
        public BigDecimal getReCaptchaScore() { return ReCaptchaScore; }
        public ApiClientHeader setReCaptchaScore(BigDecimal value) { this.ReCaptchaScore = value; return this; }
    }

    public static class VerifyTokenRs
    {
        public String CardRef = null;
        public Boolean Success = null;
        public String Message = null;
        
        public String getCardRef() { return CardRef; }
        public VerifyTokenRs setCardRef(String value) { this.CardRef = value; return this; }
        public Boolean isSuccess() { return Success; }
        public VerifyTokenRs setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public VerifyTokenRs setMessage(String value) { this.Message = value; return this; }
    }

}

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