Skip to main content
GET
/
reward_templates
List reward templates
curl --request GET \
  --url https://api.synctera.com/v2/reward_templates
{
  "reward_templates": [
    {
      "amount": 1000,
      "currency": "USD",
      "description": "Referral Reward",
      "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
      "is_enabled": true,
      "metadata": {},
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "85943c51-e4ff-4e57-9558-08cab6b96364",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "subtype": "ACCOUNT_OPENING_BONUS",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
id
string<uuid>[]

Return reward templates with the specified id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
description
string

Return reward templates with the specified description. A * character can be used as a wildcard to match any characters.

​
is_enabled
boolean

Return reward templates with the specified is_enabled flag.

​
sort_by
enum<string>[]

Specifies the sort order for the returned reward templates.

​
subtype
enum<string>

A short string representing the sub-type of the reward. This will be used as the subtype of the resulting transaction.

Available options:
ACCOUNT_OPENING_BONUS,
ACCOUNT_OPENING_BONUS_REVERSAL,
CASHBACK,
CASHBACK_REVERSAL,
INTEREST_RATE_BONUS,
INTEREST_RATE_BONUS_REVERSAL,
LOAN_INTEREST_RATE_REDUCTION,
LOAN_INTEREST_RATE_REDUCTION_REVERSAL,
MANUAL_ADJUSTMENT,
MANUAL_ADJUSTMENT_REVERSAL,
MILES,
MILES_REVERSAL,
MISCELLANEOUS,
MISCELLANEOUS_REVERSAL,
POINTS,
POINTS_REVERSAL,
REFERRAL_BONUS,
REFERRAL_BONUS_REVERSAL
​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

List of reward templates

​
reward_templates
reward template response object · object[]
required

Array of reward templates

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"