Back to Index

GET v1/ClientAuthToken/{token}?languageCode={languageCode}

Gets a Client Authorization Token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

The one-time-use client authorization token (CAT).

string

Required

languageCode

Determines the Language of the response data. 2 Character ISO LanguageCode. Default is 'en'.

string

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

client_auth_token_status_response
NameDescriptionTypeAdditional information
client_auth_token

The one-time-use client authorization token (CAT).

string

None.

return_url

The URL used for redirection, when provided.

string

None.

type

The type of the action is represented here, if the CAT has been used, otherwise null. The name/value pair indicates which property will be populated with the payload.

client_auth_token_type

None.

card_token

The card_token assigned to the created credit card.

string

String length: inclusive between 0 and 32

bank_account_token

The bank_account_token assigned to the created bank account.

string

String length: inclusive between 0 and 32

active

True if the CAT has not expired and can be used for an authorization, otherwise false.

boolean

None.

authorized_datetime

The datetime when the CAT was used, or null if the CAT is active

date

None.

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "client_auth_token": "sample string 1",
  "return_url": "sample string 2",
  "type": {
    "name": "sample string 1",
    "code": "sample string 2"
  },
  "card_token": "sample string 3",
  "bank_account_token": "sample string 4",
  "active": true,
  "authorized_datetime": "2019-01-23T16:23:49.0975139-08:00",
  "success": true,
  "message": "sample string 7",
  "message_code": 8,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}