PUT//////
Modify existing redemption.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the reward account. Allowable Values: Existing reward account token |
| redemption_token string Required | Unique identifier of the reward redemption. Allowable Values: Existing redemption token |
Request body
| Fields | Description |
|---|---|
| note string Optional | Note explaining why the reward is being redeemed. Allowable Values: 255 char max |
| external_settlement_date_time datetime Optional | Date and time when the reward redemption was settled on the external platform. This field is returned if the reward redemption was handled outside of Marqeta’s credit platform. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample request body
JSON
{
"external_settlement_date_time": "2024-01-06T20:37:11Z"
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the reward redemption. Allowable Values: 36 char max |
| 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 |
| destination string Conditionally returned | Destination of the EXTERNAL redemption for the brand to track.Allowable Values: 255 char max |
| amount decimal Returned | Amount to redeem. Allowable Values: Format: 0.00 |
| conversion_rate decimal Conditionally returned | Rate that points are worth when converting them using the REDEMPTION_TYPE indicated.Allowable Values: 0.001 min Format: 0.000 |
| 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 |
| note string Conditionally returned | Note explaining why the reward is being redeemed. Allowable Values: 255 char max |
| sor_reward_token string Conditionally returned | Unique identifier of the system of reward (SOR) reward that was created to represent the reward redemption as a STATEMENT_CREDIT on a credit account. The SOR entry is a positive amount that is added to the account balance.Allowable Values: 36 char max |
| external_settlement_date_time datetime Conditionally returned | Date and time when the reward redemption was settled on your external platform, in UTC. This field is returned if you handled the reward redemption outside of Marqeta’s credit platform. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| receiving_account_token string Conditionally returned | Unique identifier of the external account receiving the reward redemption. This token is the payment source token. Allowable Values: 36 char max |
| created_time datetime Returned | Date and time when the reward redemption was created on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| updated_time datetime Conditionally returned | Date and time when the reward redemption was updated on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "7d34d209-e350-4bca-a678-29b9fbfe45d5",
"type": "EXTERNAL",
"destination": "MILEAGE_PLUS",
"amount": 900,
"conversion_rate": 1.3,
"note": "Redeeming reward balance to MILEAGE_PLUS Program at a rate of 1.3 miles per point",
"external_settlement_date_time": "2024-01-05T20:37:11Z",
"receiving_account_token": "c21b04ad-37de-4433-890a-3cece8adefc7",
"created_time": "2024-01-05T20:37:11Z",
"updated_time": "2024-01-06T20:37:11Z"
}