This method returns information related with the award reward transactions that were allocated against a specific spend reward transaction. Multiple award reward transactions are retrieved by each call.
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
reward_spend_transaction_identifier (semi-optional) | Spend Reward Transaction Identifier | The identifier of the spend reward transaction that should be retrieved. The allowed spend reward transaction 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
allocated_amount | Number | The amount that was allocated on the award reward transaction |
allocation_date | Date | The date that the amount was allocated |
| award_reward_transaction | Award Reward Transaction Object | The award reward transaction that the spend amount was allocated on |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data":
[
{
"allocated_amount": 1,
"allocation_date": "2016-10-12 16:19:06.0",
"award_reward_transaction":
{
"number": "2144",
"amount": 3,
"log_information":
{
"created_by_unit":
{
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit":
{
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-10-12T12:46:55",
"updated_date": "2016-10-12T12:46:55",
"updated_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"award_expiration_transaction": null,
"reward_offer":
{
"number": "198",
"name": "Addidas offer",
"description": null,
"id": "8213899F00134A40810E7C6E260DE707",
"life_cycle_state": "EFFECTIVE"
},
"currency_rate_period": null,
"id": "6475C97765014159A953DA743E304BAE",
"life_cycle_state": "POSTED",
"expiration_date": "2016-11-01T00:00:00",
"wallet_transaction": null,
"contribution_percentage": null,
"rewards_participant":
{
"number": "RP0000000405",
"accounts_receivable":
{
"number": "ACR0000000873",
"name": "ACR0000000873 Georgia Wallet",
"id": "3BE35D2C3CA04FBE9CC38803386E2466",
"life_cycle_state": "ACTIVE",
"account_owner":
{
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Wallet",
"id": "B43C0D84A9E04D2BB354561CE79A34FD",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Georgia",
"demographics":
{
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth":
{
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "24C03CEDC4054FD2A33A2D8776407BD7"
}
}
}
],
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}