| Excerpt |
|---|
This method creates an access token. Single access tokens can be created by each call. |
...
Name | Type | Description | |||||||||||
token | String | The token retrieved from the login method | |||||||||||
authentication_code (mandatory on conditions) | String | The authentication code of the access token that will be created. This information is not mandatory if set to be generated automatically, in the definition or the classification. | |||||||||||
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. | |||||||||||
card_masked_number (optional) | String | The masked number of the credit card that will be related to the access token
| |||||||||||
accounts_receivable_identifier (semi-optional on conditions) | Accounts Receivable Identifier | The identifier of the accounts receivable that will be related to 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 to 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 to 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
| |||||||||||
custom_field_set (optional) | Set of Custom Fields | The custom fields that are associated with the access token If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value
| |||||||||||
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.
...