access_token_parameters

access_token_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing access token should be used. The supported values are the following:

ADD_NEW, ADD_EXISTING

The NEW option can be used only if access tokens are allowed to be created on creating reward participants, as specified in access token definitions

access_token_identifier

(mandatory on conditions)

Access Token identifier

An existing access token that should be used. This is applicable and mandatory if the action is set to EXISTING. Only effective access tokens can be used. The allowed access token identifier fields are the following:

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

String

The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code

pass_code

(mandatory on conditions)

String

The pass code of the access token, which is applicable and mandatory if the identifier is specified

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. Applicable only if the action is set to ADD_NEW

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. Applicable only if the action is set to ADD_NEW

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. Applicable only if the action is set to ADD_NEW

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of the classification

Available from CRM.COM R10.0.0

card_masked_number

(optional)

String

The masked number of the credit card that will be related to the access token

Applicable only when the authentication code is related with a credit card

Available from CRM.COM R16.2.0

udf_string_1

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW