Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
rewards_participant_parameters object data
Name | Type | Description |
sign_up_on (optional) | Date | The date that the rewards participant signed up - If not specified, defaults to the current date
|
sign_up_by_unit_identifier (optional) | Unit identifier | The unit that signed up the rewards participant - If not specified, defaults to the logged in user's unit
The allowed unit identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
enable_automatic_spend (optional) | Boolean | Defines whether the rewards participant requires automatic spend on purchase events or not |
minimum_wallet_balance (optional) | Float | The minimum wallet balance that should be available in order for an automatic awards spending to be applied. |
minimum_spend_amount (optional) | Float | The minimum amount that can be spend by that specific rewards participant during auto spend |
maximum_spend_amount (optional) | Float | The maximum amount that can be spend by that specific rewards participant during auto spend |
participating_schemes_set (mandatory) | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint |
authorised_rewards_participating_merchants_set (optional) | Set of Rewards Participating Merchants | It defines the list of merchants which are authorised to perform automatic awards spending on that specific rewards participant. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled |
Referred Parameter Objects Data
rewards participant schemes object parameter data
Name | Type | Description |
|---|
sign_up_on (mandatory) | Date | The date that the rewards participant signed up for that specific reward scheme |
email_address (semi-optional) | String | The email address that is associated with the unique reference code and was used while signing up to a reward scheme based on supported domains This available and mandatory only it is required by the specific reward scheme (that is domain specific) and the reference code generation method is set to "AUTO_GENERATED" |
reference_code (semi-optional) | String | The unique reference code that was used while signing up to that specific reward scheme This is available and mandatory only if it is required by the specific reward scheme (that is domain specific) or if an email is defined instead of a reward scheme |
sign_up_by_business_unit_identifier (mandatory) | Business Unit identifier | The business unit that signed up the rewards participant to that specific reward scheme. The allowed business unit identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
sign_up_by_unit_identifier (mandatory) | Unit identifier | The unit that signed up the rewards participant to that specific reward scheme. The allowed unit identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
reward_scheme_identifier (semi-optional) | Reward Scheme Identifier | The reward scheme that the rewards participant has joint. The allowed reward scheme identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the reward scheme | name (semi-optional) | String | The name of the reward scheme | alternative_code (semi-optional) | String | The alternative code of the reward scheme |
|
authorised rewards participating merchants parameters object data
Name | Type | Description |
|---|
rewards_participating_merchant_identifier (mandatory) | Rewards Participating Merchant Identifier | The rewards participating merchant that should be authorised to perform automatic awards spending. The allowed rewards participating merchant identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rewards participating merchant | business_unit_identifier (semi-optional) | Business Unit Identifier | The identifier of the business unit that represents the rewards participating merchant. The allowed business unit identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the business unit | name (semi-optional) | String | The code of the business unit | code (semi-optional) | String | The code of the business unit |
| unit_identifier (semi-optional) | Unit Identifier | The identifier of the unit that represents the rewards participating merchant. The allowed unit identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
|