Billhighway Cloud API

<back to all web services

VerifyTokenRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifytoken
VerifyTokenRq Parameters:
NameParameterData TypeRequiredDescription
HeaderbodyApiClientHeaderNo
IntegrationTypepathstringNo
NationalIdbodyintNo
ChapterIdbodyintNo
IntegrationPartnerIdbodyintNo
TokenbodystringNo
VerificationTypesbodystringNo
ApiClientHeader Parameters:
NameParameterData TypeRequiredDescription
ClientIdformintNo
ReferrerformstringNo
IpAddressformstringNo
LoggedInUserIdformintNo
GroupIdformintNo
TaskformstringNo
MachineformstringNo
LocationformstringNo
CreatedByformintNo
CampaignIdformintNo
ReCaptchaScoreformdecimal?No
VerifyTokenRs Parameters:
NameParameterData TypeRequiredDescription
CardRefformstringNo
SuccessformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Header":{"ClientId":0,"Referrer":"String","IpAddress":"String","LoggedInUserId":0,"GroupId":0,"Task":"String","Machine":"String","Location":"String","CreatedBy":0,"CampaignId":0,"ReCaptchaScore":0},"IntegrationType":"String","NationalId":0,"ChapterId":0,"IntegrationPartnerId":0,"Token":"String","VerificationTypes":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CardRef":"String","Success":false,"Message":"String"}