Skip to main content
GET
/
rewards
/
{reward_id}
Get Reward
curl --request GET \
  --url https://api.synctera.com/v2/rewards/{reward_id} \
  --header 'Authorization: Bearer <token>'
{
  "account_id": "12943c51-e4ff-4e57-9558-08cab6b96364",
  "amount": 1000,
  "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",
  "metadata": {},
  "note": "Reduced account reward based on phone call with customer",
  "derived_from_uuid": "55943c51-e4ff-4e57-9558-08cab6b96400",
  "reward_category": "cashback:card:mcc",
  "reward_config_id": "77943c51-e4ff-4e57-9558-08cab6b96600",
  "reward_product_id": "66943c51-e4ff-4e57-9558-08cab6b96500"
}

Documentation Index

Fetch the complete documentation index at: https://docs.synctera.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
reward_id
string<uuid>
required

The unique identifier of a reward

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6"

Response

Returned reward.

​
account_id
string<uuid>
required

The ID of the business or customer account being charged the reward.

Example:

"12943c51-e4ff-4e57-9558-08cab6b96364"

​
amount
integer
required

The amount of the reward in ISO 4217 minor currency units, e.g. cents. The internal account referenced by the reward template will be debited this amount. Defaults to the value in the reward template.

Example:

1000

​
template_id
string<uuid>
required

The ID of the reward template to use to create the reward. Values from the reward template will be used as defaults for the reward. Note that the reward template may have been updated since the reward was created and that such subsequent updates to the reward template do not affect existing rewards.

Example:

"64943c51-e4ff-4e57-9558-08cab6b96352"

​
creation_time
string<date-time>
required
read-only

The timestamp representing when the reward was created

Example:

"2010-05-06T12:23:34.321Z"

​
currency
string
required

currency of the reward, as a three character ISO 4217 alphabetic currency code.

Example:

"USD"

​
description
string
required

The description of the reward template.

Example:

"Referral Reward"

​
id
string<uuid>
required

The ID of the reward.

Example:

"44943c51-e4ff-4e57-9558-08cab6b96321"

​
internal_account_id
string<uuid>
required

The ID of internal_account that is the source of the reward transfer.

Example:

"42943c51-e4ff-4e57-9558-08cab6b963c8"

​
last_updated_time
string<date-time>
required
read-only

The timestamp representing when the reward was last updated

Example:

"2010-05-06T12:23:34.321Z"

​
subtype
enum<string>
required

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
​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
transaction_id
string<uuid>
required

The ID the resulting transaction resource.

Example:

"11943c51-e4ff-4e57-9558-08cab6b96333"

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

​
note
string

An optional note for this instance of the reward.

Example:

"Reduced account reward based on phone call with customer"

​
derived_from_uuid
string<uuid>

The ID of the transaction that triggered this automated reward, if applicable.

Example:

"55943c51-e4ff-4e57-9558-08cab6b96400"

​
reward_category
enum<string>

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

Available options:
cashback:card:mcc
​
reward_config_id
string<uuid>

The ID of the reward config that generated this automated reward, if applicable.

Example:

"77943c51-e4ff-4e57-9558-08cab6b96600"

​
reward_product_id
string<uuid>

The ID of the reward product that generated this automated reward, if applicable.

Example:

"66943c51-e4ff-4e57-9558-08cab6b96500"