Create a reward config

Create a new standalone reward config. Use PATCH /reward_products/ to associate it with a reward product.

POST /reward_configs

Create a reward config

cURL

curl --request POST \
  --url https://api.synctera.com/v1/reward_configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_config": {
    "config": {}
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
  "description": "1% cashback on all grocery purchases",
  "reverse_with_parent": false,
  "reward_type": "instant_cashback",
  "rule_config": {
    "mcc_cashback": {
      "mcc_ranges": [
        {
          "lower": "5411",
          "upper": "5499"
        }
      ]
    }
  }
}
'

201

{
  "amount_config": {
    "amount_type": "fixed",
    "config": {
      "fixed_amount": {
        "amount": 300
      },
      "percentage": {
        "basis_points": 300
      },
      "transaction_amount_tiered": {
        "tiers": [
          {
            "amount_type": "fixed",
            "config": {
              "fixed_amount": {
                "amount": 300
              },
              "percentage": {
                "basis_points": 300
              }
            },
            "up_to": 10000
          }
        ]
      }
    }
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "status": "active",
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "5c943c51-e4ff-4e57-9558-08cab6b96398",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "description": "1% cashback on all grocery purchases",
  "reverse_with_parent": false,
  "reward_type": "instant_cashback",
  "rule_config": {
    "mcc_cashback": {
      "mcc_ranges": [
        {
          "lower": "5411",
          "upper": "5499"
        }
      ]
    }
  },
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234"
}

Authorizations

Authorization · string · header · required

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

Headers

Idempotency-Key · string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Reward config to create

amount_config · object · required

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

Show child attributes

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

template_id · string<uuid> · required

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

Example:

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

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.

Show child attributes

status · enum<string>

Available options: active, inactive

Response

201

application/json

Created reward config

amount_config · object · required

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

Show child attributes

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.

Show child attributes

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"