GET/////
Retrieve an array of reward entries for a specific reward account.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the reward account. Allowable Values: Existing reward account token |
URL query parameters
| Fields | Description |
|---|---|
| start_date datetime Optional | Starting date and time of a date range from which to return resources, in UTC. Allowable Values: format: yyyy-MM-ddThh:mm:ssZ |
| end_date datetime Optional | Ending date and time of a date range from which to return resources, in UTC. Allowable Values: format: yyyy-MM-ddThh:mm:ssZ |
| count integer Optional | Number of resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by_created string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names, such as createdTime. Do not sort by field names that appear in response bodies, such as created_time.Allowable Values: createdTime, -createdTime |
| status string Required | Status of the reward entries in the returned array. Allowable Values: PENDING, POSTED |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of resources returned. Allowable Values: 1–100 |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Returned | List of reward entry objects. Allowable Values: Valid array of one or more reward entry objects |
| data[].token string Returned | Unique identifier of the reward entry. Allowable Values: 36 char max |
| data[].reward_account_token string Returned | Unique identifier of the reward account for which to return reward entries. Allowable Values: 36 char max |
| data[].rule_token string Conditionally returned | Unique identifier of the rule used to determine the value of the reward entry. Allowable Values: 36 char max |
| data[].transaction_amount decimal Conditionally returned | Transaction amount to which the rule was applied. Used to determine the value of the reward entry. Allowable Values: Format: 0.00 |
| data[].value decimal Returned | Value of the reward entry. Allowable Values: Format: 0.00 |
| data[].related_journal_entry_token string Conditionally returned | Unique identifier of the related journal entry to which the rule was applied that triggered the reward entry. Allowable Values: 36 char max Existing journal entry token |
| data[].related_redemption_token string Conditionally returned | Unique identifier of the related redemption token that triggered the reward entry. Allowable Values: 36 char max |
| data[].related_entry_token string Conditionally returned | Unique identifier of the related reward entry token for a given dispute. Allowable Values: 36 char max |
| data[].note string Returned | Note providing information on the reward entry. Allowable Values: 255 char max |
| data[].created_time datetime Conditionally returned | Date and time when the reward entry was created on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 5,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"token": "12959312-675e-44e9-b6be-9dc7a0d996bd",
"reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
"rule_token": "b125a2ea-477d-410f-b6a1-283b8eddb3cd",
"transaction_amount": 100,
"value": 200,
"note": "Account awarded 5000 bonus points for completing customer feedback survey.",
"related_journal_entry_token": "64794ba4-9094-466f-b11a-b3d1daf17293",
"created_time": "2024-01-01T20:37:11Z"
},
{
"token": "12959312-675e-44e9-b6be-9dc7a0d996bd",
"reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
"rule_token": "b125a2ea-477d-410f-b6a1-283b8eddb3cd",
"transaction_amount": 500,
"value": 50,
"note": "Account awarded 5000 bonus points for completing customer feedback survey.",
"related_journal_entry_token": "64794ba4-9094-466f-b11a-b3d1daf17293",
"related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
"created_time": "2024-01-02T20:37:11Z"
},
{
"token": "4391dd08-b91f-47be-8577-dc080d4e51a5",
"reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
"rule_token": "5fd9cb86-1ecf-4eb9-beea-db308b051797",
"value": 200,
"note": "Account awarded 5000 bonus points for completing customer feedback survey.",
"created_time": "2024-01-03T20:37:11Z"
},
{
"token": "4d0ff4ee-ee97-48a8-9494-70edcf456aab",
"reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
"value": 20000,
"related_journal_entry_token": "64794ba4-9094-466f-b11a-b3d1daf17293",
"related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
"note": "Customer called in, one time reward for error in statement.",
"created_time": "2024-01-04T20:37:11Z"
},
{
"token": "1417c942-2eba-4238-ac44-d04db1f411cd",
"reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
"value": -1000,
"note": "Account awarded 5000 bonus points for completing customer feedback survey.",
"related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
"created_time": "2024-01-04T20:37:11Z"
}
]
}