POST////
Create a reward for an existing credit account.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the credit account for which you want to create a reward. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the reward. Allowable Values: 36 char max |
| description string Required | Description of the reward. Allowable Values: 255 char max |
| currency_code string Required | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| amount decimal Required | Amount of the reward. Allowable Values: 0 min |
| note string Optional | Additional information about the reward. Allowable Values: 255 char max |
| forced boolean Optional | Allows you to force the creation of a reward on an account. By default, reward creation is not permitted for accounts with a status of SUSPENDED or TERMINATED if more than 90 days have passed since the status transition.Allowable Values: true, false |
Sample request body
JSON
{
"token": "my_rewards_token1234",
"account_token": "my_account_token_12",
"type": "CASH_BACK",
"description": "$20 reward",
"currency_code": "USD",
"amount": 20,
"updated_time": "2023-09-03T22:53:57.895Z",
"created_time": "2023-09-03T22:53:57.895Z"
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the reward. If in the detail_object, unique identifier of the detail object.Allowable Values: 36 char max |
| account_token string Conditionally returned | Unique identifier of the account on which the reward exists. Allowable Values: 36 char max |
| type string Returned | Type of reward. Allowable Values: AUTO_CASH_BACK, CASH_BACK, STATEMENT_CREDIT |
| description string Returned | Description of the reward. Allowable Values: 255 char max |
| currency_code string Returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| amount decimal Returned | Amount of the reward. Allowable Values: 0 min |
| applied_to_amount decimal Conditionally returned | Total amount to which a percentage reward method is applied (for example, if a 3% reward is applied to 100, then 100 is the applied_to_amount value).This field is not applicable for a flat fee method. Returned for auto-cash back reward types only. Allowable Values: Format: 0.00 |
| method string Conditionally returned | Method, either a flat amount or a percentage. NOTE: Only FLAT is currently supported.Allowable Values: PERCENTAGE, FLAT |
| value decimal Conditionally returned | Value of the percentage or flat amount. Returned for auto-cash back reward types only. Allowable Values: Format: 0.00 |
| note string Conditionally returned | Additional information about the reward. Allowable Values: 255 char max |
| updated_time datetime Returned | Date and time when the reward was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the reward was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "my_rewards_token1234",
"account_token": "my_account_token_12",
"type": "CASH_BACK",
"description": "$20 reward",
"currency_code": "USD",
"amount": 20,
"updated_time": "2023-09-03T22:53:57.895Z",
"created_time": "2023-09-03T22:53:57.895Z"
}