GET///
Retrieve conversion entries by reward program short code.
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 Conditionally returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Returned | List of conversion objects. Allowable Values: Valid array of one or more conversion objects |
| data[].token string Returned | Unique identifier of the conversion. Allowable Values: 36 char max |
| data[].bundle_token string Returned | Unique identifier of the bundle. Allowable Values: 36 char max |
| data[].type string 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 |
| data[].conversion_rate decimal Returned | Rate that points are worth when converting them using the REDEMPTION_TYPE indicated.Allowable Values: 0.001 min Format: 0.000 |
| data[].conversion_increment integer Returned | Static amount to reward if rule conditions are met. Allowable Values: Any integer |
| data[].currency string Conditionally returned | Type of currency used for the conversion rate. Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
| data[].is_active boolean Returned | A value of true indicates that the conversion is active.Allowable Values: true, falseDefault value: true |
| data[].created_time datetime Returned | Date and time when the conversion entry was created on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].updated_time datetime Returned | Date and time when the conversion entry was last updated on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"data": [
{
"token": "8a8cfd94-978a-4b03-80e0-ed57be0c6230",
"type": "STATEMENT_CREDIT",
"conversion_rate": 1.3,
"conversion_increment": 130,
"currency": "USD",
"is_active": true,
"bundle_token": "f0cf97cb-76f7-47a5-83e7-188b9e741cf9",
"created_time": "2024-01-04T20:37:11Z",
"updated_time": "2024-01-04T20:37:11Z"
}
]
}