GET/////
Use this endpoint to retrieve the reward accounts rewards accrual by rule for a specified time frame. If you do not specify a time frame in your query parameters, the query defaults to the current billing cycle.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the reward account. Allowable Values: Existing reward account token |
Response body
| Fields | Description |
|---|---|
| start_date datetime Conditionally returned | Start date of rewards accrual retrieval, in UTC. Defaults to the billing cycle closing date. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| end_date datetime Conditionally returned | End date of rewards accrual retrieval, in UTC. Defaults to the billing cycle closing date. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| rules array of objects Conditionally returned | List of accrual information by rule. Allowable Values: Valid array of one or more rule accrual objects |
| rules[].description string Conditionally returned | Description of the rule, pulled from the rule entry. Allowable Values: 255 char max |
| rules[].total_spend decimal Conditionally returned | Total spend contributed to the reward accrual for this rule. Allowable Values: Any integer |
| rules[].total_rewards_earned decimal Conditionally returned | Total settled rewards accrued against the rule. Allowable Values: Any integer |
| retrieved_time datetime Conditionally returned | Retrieval date of the reward account’s accruals, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"start_date": "2023-12-25T20:37:11Z",
"end_date": "2024-01-24T20:37:11Z",
"rules": [
{
"description": "Earn 3x on agricultural services, contracted services, and purchases at Target.",
"total_spend": 12300,
"total_rewards_earned": 30000
},
{
"description": "Earn 5x on Lyft, up to $500.",
"total_spend": 600,
"total_rewards_earned": 2500
},
{
"description": "Earn 50 points by spending $50 at Target.",
"total_spend": 2500,
"total_rewards_earned": 50
},
{
"description": "Earn one point on all transactions.",
"total_spend": 5863,
"total_rewards_earned": 5000
}
],
"retrieved_time": "2024-01-05T20:37:11Z"
}