/
5 minute read
April 11, 2023

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

Action: POST
Endpoint: /credit/accounts/{account_token}/rewards

Create a reward for an existing credit account.

URL path parameters

Fields Description

account_token

string
Required

The 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

A 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

Sample request body

JSON
Copied

Is this helpful?

Yes
No

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

description

string
Returned

Description of the reward.

Allowable Values:

255 char max

currency_code

string
Returned

A 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

The 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.

Returned for auto-cash back reward types only.

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
Copied

Is this helpful?

Yes
No

Subscribe to our developer newsletter