GET/////
Retrieve rewards balances 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 |
Response body
| Fields | Description |
|---|---|
| billing_cycle_opening_date datetime Returned | Opening date of the billing cycle for which rewards were accrued, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| billing_cycle_closing_date datetime Returned | Closing date of the billing cycle for which rewards were accrued, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| total_spend_this_cycle decimal Returned | Total amount spent during a given billing cycle, minus any refunds or disputes, even if transactions did not result in a reward. Used to determine reward accrual. Allowable Values: Format: 0.00 |
| points_balance object Returned | Pending and total accrual balance (in points) for the reward account. Allowable Values: accrued_this_cycle, total_reward_balance |
| points_balance.accrued_this_cycle decimal Returned | Pending balance (in points) for a reward account. Allowable Values: Any integer |
| points_balance.total_reward_balance decimal Returned | Total reward balance (in points) for a reward account. Allowable Values: Any integer |
| reward_values array of objects Returned | List of possible reward conversion values. Allowable Values: Valid array of one or more reward_values objects |
| reward_values[].redemption_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 |
| reward_values[].conversion_rate decimal Returned | Conversion rate of the reward account’s points, if they were used for this redemption type. Allowable Values: 0.001 min Format: 0.000 |
| reward_values[].conversion_increment decimal Returned | Allowed point increments that the reward account must have to use this redemption type. Allowable Values: Any integer |
| retrieved_time datetime Conditionally returned | Retrieval date of the reward account’s accrual balance, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"billing_cycle_opening_date": "2023-12-25T20:37:11Z",
"billing_cycle_closing_date": "2024-01-24T20:37:11Z",
"total_spend_this_cycle": 5832,
"points_balance": {
"accrued_this_cycle": 10000,
"total_reward_balance": 25000
},
"reward_values": [
{
"redemption_type": "STATEMENT_CREDIT",
"conversion_rate": 0.001,
"conversion_increment": 10
}
],
"retrieved_time": "2024-01-05T20:37:11Z"
}