Skip to main content
GET
Get a reward config

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

reward_config_id
string<uuid>
required

Unique identifier of a reward config.

Example:

"5c943c51-e4ff-4e57-9558-08cab6b96398"

Response

Reward config

amount_config
object
required

Amount calculation parameters for a fee config. amount_type determines which config field is used.

name
string
required

Human-readable name for this reward rule.

Example:

"Grocery Store Cashback"

reward_category
enum<string>
required

The category of event that triggers this reward. Trigger-based categories fire when a matching card transaction is posted.

Available options:
cashback:card:mcc
status
enum<string>
required
Available options:
active,
inactive
creation_time
string<date-time>
required
read-only
Example:

"2024-01-15T10:00:00Z"

id
string<uuid>
required

Unique identifier for this reward config.

Example:

"5c943c51-e4ff-4e57-9558-08cab6b96398"

last_updated_time
string<date-time>
required
read-only
Example:

"2024-06-01T12:00:00Z"

tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

description
string

Description of this reward rule.

Example:

"1% cashback on all grocery purchases"

reverse_with_parent
boolean

When true, reversals of the triggering transaction also reverse this reward.

Example:

false

reward_type
enum<string>

How the reward is delivered to the account holder. instant_cashback = credited to the account on every qualifying transaction. Future types (not yet implemented): accrued_cashback, vendor_points.

Available options:
instant_cashback
rule_config
object

Category-specific rule parameters. Provide the field that matches the reward_config's reward_category; all other fields must be omitted.

template_id
string<uuid>

ID of the reward template that provides accounting setup for automated reward posting. Required for trigger-based rewards.

Example:

"8b943c51-e4ff-4e57-9558-08cab6b96234"