Skip to main content
POST
/
reward_templates
Create a reward template
curl --request POST \
  --url https://api.synctera.com/v2/reward_templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "description": "Referral Reward",
  "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
  "subtype": "ACCOUNT_OPENING_BONUS",
  "amount": 1000,
  "is_enabled": true,
  "metadata": {}
}
'
{
  "currency": "USD",
  "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
  "is_enabled": true,
  "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",
  "amount": 1000,
  "description": "Referral Reward",
  "metadata": {}
}

Body

application/json

Reward to create

​
currency
string
required

currency for 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"

​
internal_account_id
string<uuid>
required

The ID of default internal_account to use as the source of the reward transfer. Cannot be a system internal account.

Example:

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

​
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,
CASHBACK,
INTEREST_RATE_BONUS,
LOAN_INTEREST_RATE_REDUCTION,
MANUAL_ADJUSTMENT,
MILES,
MISCELLANEOUS,
POINTS,
REFERRAL_BONUS
​
amount
integer

The default amount of the reward in ISO 4217 minor currency units, e.g. cents. The internal account will be debited this amount. Can be overridden when creating a reward.

Example:

1000

​
is_enabled
boolean

Whether the reward template is enabled. If false, rewards cannot be created from this template.

Example:

true

​
metadata
object

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

Response

Created reward template

​
currency
string
required

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

Example:

"USD"

​
internal_account_id
string<uuid>
required

The ID of default internal_account to use as the source of the reward transfer. Cannot be a system internal account.

Example:

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

​
is_enabled
boolean
required

Whether the reward template is enabled. If false, rewards cannot be created from this template.

Example:

true

​
creation_time
string<date-time>
required

The timestamp representing when the reward template was created

Example:

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

​
id
string<uuid>
required

The ID of the reward template.

Example:

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

​
last_updated_time
string<date-time>
required

The timestamp representing when the reward template was last modified

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. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
amount
integer

The default amount of the reward in ISO 4217 minor currency units, e.g. cents. The internal account will be debited this amount. Can be overridden when creating a reward.

Example:

1000

​
description
string

The description of the reward template.

Example:

"Referral Reward"

​
metadata
object

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