Skip to main content
Note
This feature is currently in beta and subject to change. To learn more about the Beta program for this feature, contact your Marqeta representative.
Use the /credit/rewards/configurations endpoint to manage the global configurations for a reward program. The global configurations for a reward account are defined in the reward policy on the reward account’s associated bundle.

​
Retrieve global configurations

Action: GET
Endpoint: /credit/rewards/configurations Retrieve global configuration by program short code.

​
URL query parameters

FieldsDescription
bundleToken

string

Required		Unique identifier of the bundle.

Allowable Values:

Existing bundle token

​
Response body

FieldsDescription
token

string

Returned		Unique identifier of the global configuration.

Allowable Values:

36 char max
program_short_code

string

Returned		Program short code.

Allowable Values:

36 char max
accrual_strategy

string

Returned		Reward accrual strategy for program. If no accrual_strategy is set, default is DEFAULT.

- DEFAULT - The rewards accrued are based on typical transaction event types such as authorization clearings and refunds.
- PAYMENT - The rewards accrued are based on payment event types such as completed payments and returned payments.

Allowable Values:

DEFAULT, PAYMENT
settlement_strategy

string

Returned		Reward settlement strategy for program.

- LIVE - The rewards accrued are posted to the reward account upon processing of the authorization clearing for the transaction.
- STATEMENT - The rewards accrued are posted to the reward account upon successful statement generation for the transactions.

Allowable Values:

LIVE, STATEMENT
global_rules

array of strings

Returned		Rule description object to apply on a brand-wide level.

Allowable Values:

Valid array of one or more global rules
bundle_token

string

Conditionally returned		Unique identifier of the bundle.

Allowable Values:

36 char max
created_time

datetime

Returned		Date and time when the global configuration was created on the Marqeta platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
updated_time

datetime

Returned		Date and time when the global configuration was last updated on the Marqeta platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

​
Sample response body

JSON
{
  "token": "ca8439c7-485f-4fa6-a099-2f77b57e3ce5",
  "program_short_code": "shortCodeValue",
  "accrual_strategy": "DEFAULT",
  "settlement_strategy": "STATEMENT",
  "global_rules": [
    "004d0fbb-8874-44ef-b222-c18de77e9acc",
    "f73877d3-7625-4737-883d-d27ab9f5f7e6"
  ],
  "bundle_token": "f0cf97cb-76f7-47a5-83e7-188b9e741cf9",
  "created_time": "2024-01-04T20:37:11Z",
  "updated_time": "2024-01-04T20:37:11Z"
}

​
Modify global rules

Action: PUT
Endpoint: /credit/rewards/configurations/rules Modify existing global rules for a reward program.

​
Request body

FieldsDescription
token

string

Required		Unique identifier of the global configuration.

Allowable Values:

36 char max
global_rules

array of strings

Optional		Rule description object to apply on a brand-wide level.

Allowable Values:

Valid array of one or more global rules

​
Sample request body

JSON
{
  "token": "ca8439c7-485f-4fa6-a099-2f77b57e3ce5",
  "global_rules": [
    "004d0fbb-8874-44ef-b222-c18de77e9acc",
    "f73877d3-7625-4737-883d-d27ab9f5f7e6"
  ]
}

​
Response body

FieldsDescription
token

string

Returned		Unique identifier of the global configuration.

Allowable Values:

36 char max
program_short_code

string

Returned		Program short code.

Allowable Values:

36 char max
accrual_strategy

string

Returned		Reward accrual strategy for program. If no accrual_strategy is set, default is DEFAULT.

- DEFAULT - The rewards accrued are based on typical transaction event types such as authorization clearings and refunds.
- PAYMENT - The rewards accrued are based on payment event types such as completed payments and returned payments.

Allowable Values:

DEFAULT, PAYMENT
settlement_strategy

string

Returned		Reward settlement strategy for program.

- LIVE - The rewards accrued are posted to the reward account upon processing of the authorization clearing for the transaction.
- STATEMENT - The rewards accrued are posted to the reward account upon successful statement generation for the transactions.

Allowable Values:

LIVE, STATEMENT
global_rules

array of strings

Returned		Rule description object to apply on a brand-wide level.

Allowable Values:

Valid array of one or more global rules
bundle_token

string

Conditionally returned		Unique identifier of the bundle.

Allowable Values:

36 char max
created_time

datetime

Returned		Date and time when the global configuration was created on the Marqeta platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
updated_time

datetime

Returned		Date and time when the global configuration was last updated on the Marqeta platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

​
Sample response body

JSON
{
  "token": "ca8439c7-485f-4fa6-a099-2f77b57e3ce5",
  "program_short_code": "shortCodeValue",
  "accrual_strategy": "DEFAULT",
  "settlement_strategy": "LIVE",
  "global_rules": [
    "004d0fbb-8874-44ef-b222-c18de77e9acc",
    "f73877d3-7625-4737-883d-d27ab9f5f7e6"
  ],
  "created_time": "2024-01-04T20:37:11Z",
  "updated_time": "2024-01-04T20:37:11Z"
}

Related topics

About Reward AccountsReward Rules ManagementAccount RewardsReward AccountsCredit Rewards