GET//////
Retrieve redemption amounts for a specified date range by redemption type.
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 |
Response body
| Fields | Description |
|---|---|
| start_date datetime Conditionally returned | Starting date and time of a date range from which to return the redemption balance, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| end_date datetime Conditionally returned | Ending date and time of a date range from which to return the redemption balance, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| redemptions array of objects Conditionally returned | List of each redemption total by type. Allowable Values: Valid array of one or more redemption objects |
| redemptions[].type string Conditionally returned | Type of redemption. - EXTERNAL - You issue the redemption on your external platform; Marqeta adjusts the reward account balance on the system of record.- STATEMENT_CREDIT - Marqeta issues the redemption as a statement credit on the associated account.NOTE: This creates a new journal entry on the account and cannot be undone. Allowable Values: EXTERNAL, STATEMENT_CREDIT |
| redemptions[].destination string Conditionally returned | The brand-managed program to which the reward balance was redeemed. Allowable Values: 255 char max |
| redemptions[].point_redeemed decimal Conditionally returned | Total points redeemed for redemption type for a reward account. Allowable Values: Any integer |
Sample response body
JSON
{
"start_date": "2023-01-05T20:37:11Z",
"end_date": "2024-01-05T20:37:11Z",
"redemptions": [
{
"type": "EXTERNAL",
"destination": "BRAND_WALLET",
"points_redeemed": 100000
},
{
"type": "EXTERNAL",
"destination": "MILEAGE_PLUS",
"points_redeemed": 5000
},
{
"type": "STATEMENT_CREDIT",
"points_redeemed": 5000
}
],
"retrieved_time": "2024-01-05T20:37:11Z"
}