Account Rewards
Use the /credit/accounts/{account_token}/rewards
endpoint to create a one-time reward on a credit account.
Creating a reward triggers the creation of a journal entry belonging to the REWARD
group.
For more on reward journal entries, see Rewards in the About Credit Account Journal Entries guide.
For the reward programs that are associated with a reward policy on a bundle, see Reward Programs.
Create account reward
Copy section link
Action: POST
Endpoint: /credit/accounts/{account_token}/rewards
Create a reward for an existing credit account.
URL path parameters
Copy section link
Fields | Description |
---|---|
account_token
string
|
The unique identifier of the credit account for which you want to create a reward. Send a Allowable Values: Existing account token |
Request body
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the reward. Allowable Values: 36 char max |
description
string
|
Description of the reward. Allowable Values: 255 char max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
amount
decimal
|
Amount of the reward. Allowable Values: 0 min |
note
string
|
Additional information about the reward. Allowable Values: 255 char max |
Response body
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the reward. If in the Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the account on which the reward exists. Allowable Values: 36 char max |
type
string
|
Type of reward. Allowable Values:
|
description
string
|
Description of the reward. Allowable Values: 255 char max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
amount
decimal
|
Amount of the reward. Allowable Values: 0 min |
applied_to_amount
decimal
|
The total amount to which a percentage reward method is applied (for example, if a 3% reward is applied to 100, then 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
|
Method, either a flat amount or a percentage. Returned for auto-cash back reward types only. Allowable Values:
|
value
decimal
|
Value of the percentage or flat amount. Returned for auto-cash back reward types only. Allowable Values: Format: 0.00 |
note
string
|
Additional information about the reward. Allowable Values: 255 char max |
updated_time
datetime
|
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
|
Date and time when the reward was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |