| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| access_token_identifier (mandatory) | Access Token identifier | The identifier of the access token that should be returned as a result. The allowed access token identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
GET access_tokens/list
| Tip |
|---|
This method returns information related with multiple access tokens, which are related either with an accounts receivable or a rewards participant. Multiple access tokens are returned by each call.
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the access token. The available accounts receivable identifier fields are the following:
| ||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the access token. The available rewards participant identifier fields are the following:
| ||||||||
classification_identifier (optional) | Access Token Classification Identifier | The identifier of the access token classification that retrieved access tokens should have. If specified then only access tokens having that classification will be retrieved. The allowed access token classification identifier fields are the following:
| ||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description |
token | String | The token retrieved from the login method |
| number (mandatory) | Number | The number of access tokens that should be retrieved |
life_cycle_state (optional) | String | The life cycle state of the access tokens that should be retrieved. The allowed options are EFFECTIVE or NOT_EFFECTIVE or PENDING_VERIFICATION |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
authentication_code (optional) | String | The authentication code of the access token that will be created. If not specified then it will be generated automatically. | ||||||||
identifier (mandatory on conditions) | String | The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. | ||||||||
pass_code (mandatory on conditions) | String | The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. | ||||||||
accounts_receivable_identifier (semi-optional on conditions) | Accounts Receivable Identifier | The identifier of the accounts receivable that will be related with the access token. The available accounts receivable identifier fields are the following:
This information is semi-optional on conditions, if the Access Token Pass Code is auto-generated | ||||||||
rewards_participant_identifier (semi-optional on conditions) | Rewards Participant Identifier | The identifier of the rewards participant that will be related with the access token. The available rewards participant identifier fields are the following:
Note that if an accounts receivable is also specified, then the rewards participant should be owned by that accounts receivable
This information is semi-optional on conditions, if the Access Token Pass Code is auto-generated | ||||||||
classification_identifier (optional) | Access Token Classification Identifier | The identifier of the access token classification that will be related with the access token. The allowed access token classification identifier fields are the following:
| ||||||||
udf_string_1 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_2 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_3 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_4 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_5 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_6 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_7 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_8 (optional) | String | User Defined Field of type String
| ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date
| ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date
| ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date
| ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date
| ||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
- It is mandatory to specify one of the semi-optional on conditions parameters, when these conditions are met. At least one of those parameters needs to be specified.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| access_token_identifier (mandatory) | Access Token identifier | The identifier of the access token that should be updated. The allowed access token identifier fields are the following:
| ||||||
authentication_code (optional) | String | The authentication code of the access token that will be updated. Is specified as null then the authentication code will be regenerated automatically | ||||||
identifier (mandatory on conditions) | String | The identifier of the access token that will be update. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. | ||||||
pass_code (mandatory on conditions) | String | The pass code of the access token that will be updated. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. | ||||||
udf_string_1 (optional) | String | User Defined Field of type String
| ||||||
udf_string_2 (optional) | String | User Defined Field of type String
| ||||||
udf_string_3 (optional) | String | User Defined Field of type String
| ||||||
udf_string_4 (optional) | String | User Defined Field of type String
| ||||||
udf_string_5 (optional) | String | User Defined Field of type String
| ||||||
udf_string_6 (optional) | String | User Defined Field of type String
| ||||||
udf_string_7 (optional) | String | User Defined Field of type String
| ||||||
udf_string_8 (optional) | String | User Defined Field of type String
| ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float
| ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float
| ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float
| ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float
| ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date
| ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date
| ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date
| ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
POST access_tokens/verify
| Tip |
|---|
This method verifies access tokens which are in Pending Verification life cycle state. A single access token can be verified by each call.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| access_token_identifier (mandatory) | Access Token identifier | The identifier of the access token that should be verified. The allowed access token identifier fields are the following:
| ||||||
verification_code (mandatory) | String | The verification code which is needed in order to verify the access token | ||||||
pass_code (optional) | String | The pass code of the access token that will be provided during verification
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
POST access_tokens/reset_pass_code
| Tip |
|---|
This method resets an access token pass code to a random 6 digit number, by providing the access token authentication code or identifier. This method can be applied only on effective access tokens. A single access token can be update by each call.
...
Name | Type | Description | ||
token | String | The token retrieved from the login method | ||
authentication_code (semi-optional) | String | The authentication code of the access token | ||
identifier (semi-optional) | String | The identifier of the access token | ||
| fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
POST access_tokens/reset_verification_code
| Tip |
|---|
This method resets an access token verification code, by providing the access token authentication code or identifier. This method can be applied only on Pending Verification access tokens. A single access token can be update by each call.
...
Name | Type | Description |
token | String | The token retrieved from the login method |
authentication_code (semi-optional) | String | The authentication code of the access token |
identifier (semi-optional) | String | The identifier of the access token. |
| fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
POST access_tokens/generate_otp
| Tip |
|---|
This method generates a one-time password (OTP) for an access token, by providing the access token identifier. A single access token otp can be generated by each call.
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| access_token_identifier (mandatory) | Access Token identifier | The identifier of the access token for which a one-time password will be generated. The allowed access token identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...