Skip to main content
GET
/
rewards
List rewards
curl --request GET \
  --url https://api.synctera.com/v2/rewards
{
  "rewards": [
    {
      "account_id": "12943c51-e4ff-4e57-9558-08cab6b96364",
      "amount": 1000,
      "metadata": {},
      "note": "Reduced account reward based on phone call with customer",
      "template_id": "64943c51-e4ff-4e57-9558-08cab6b96352",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "description": "Referral Reward",
      "id": "44943c51-e4ff-4e57-9558-08cab6b96321",
      "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "subtype": "ACCOUNT_OPENING_BONUS",
      "tenant": "abcdef_ghijkl",
      "transaction_id": "11943c51-e4ff-4e57-9558-08cab6b96333"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
id
string<uuid>[]

Return the reward 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"

​
reward_template_id
string<uuid>[]

Return rewards resources with a reward template of 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 rewards with the specified description.

​
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
​
start_time
string<date-time>

Return rewards created at or after this time.

​
end_time
string<date-time>

Return rewards created before this time.

​
account_id
string<uuid>[]

Return rewards for the specified account.

Example:

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

​
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 rewards

​
rewards
Reward response object · object[]
required

Array of rewards

​
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"