Skip to main content
POST
/
fee_templates
Create a fee template
curl --request POST \
  --url https://api.synctera.com/v2/fee_templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "description": "Premium Customer ATM Fee",
  "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
  "subtype": "ACH_INCOMING_TRANSFER",
  "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": "ACH_INCOMING_TRANSFER",
  "tenant": "abcdef_ghijkl",
  "amount": 1000,
  "description": "Premium Customer ATM Fee",
  "metadata": {}
}

Body

application/json

Fee to create

​
currency
string
required

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

Example:

"USD"

​
description
string
required

The description of the fee template.

Example:

"Premium Customer ATM Fee"

​
internal_account_id
string<uuid>
required

The ID of default internal_account to use as the destination of the fee 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 fee. This will be used as the subtype of the resulting transaction.

Available options:
ACH_INCOMING_TRANSFER,
ACH_OUTGOING_TRANSFER,
APPLICATION,
ATM_BALANCE_INQUIRY,
ATM_WITHDRAWAL,
BALANCE_TRANSFER,
BILL_PAY,
CARD_DELIVERY,
CARD_REPLACEMENT,
CASH_ADVANCE,
CASH_DEPOSIT,
CROSS_BORDER_TRANSACTION,
EFT_TRANSFER,
FOREIGN_ATM,
FOREIGN_TRANSACTION,
INACTIVITY,
LATE_PAYMENT,
MAINTENANCE,
MISCELLANEOUS,
ORIGINATION,
OVER_THE_LIMIT,
OVERDRAFT,
RETURNED_ITEM,
RETURNED_PAYMENT,
STOP_PAYMENT,
SUBSCRIPTION,
WIRE_TRANSFER,
CHECK_ISSUANCE
​
amount
integer

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

Example:

1000

​
is_enabled
boolean

Whether the fee template is enabled. If false, fees 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 fee template

​
currency
string
required

currency for the fee, 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 destination of the fee transfer. Cannot be a system internal account.

Example:

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

​
is_enabled
boolean
required

Whether the fee template is enabled. If false, fees cannot be created from this template.

Example:

true

​
creation_time
string<date-time>
required

The timestamp representing when the fee template was created

Example:

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

​
id
string<uuid>
required

The ID of the fee template.

Example:

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

​
last_updated_time
string<date-time>
required

The timestamp representing when the fee template was last modified

Example:

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

​
subtype
enum<string>
required

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

Available options:
ACH_INCOMING_TRANSFER,
ACH_INCOMING_TRANSFER_REVERSAL,
ACH_OUTGOING_TRANSFER,
ACH_OUTGOING_TRANSFER_REVERSAL,
APPLICATION,
APPLICATION_REVERSAL,
ATM_BALANCE_INQUIRY,
ATM_BALANCE_INQUIRY_REVERSAL,
ATM_WITHDRAWAL,
ATM_WITHDRAWAL_REVERSAL,
BALANCE_TRANSFER,
BALANCE_TRANSFER_REVERSAL,
BILL_PAY,
BILL_PAY_REVERSAL,
CARD_DELIVERY,
CARD_DELIVERY_REVERSAL,
CARD_REPLACEMENT,
CARD_REPLACEMENT_REVERSAL,
CASH_ADVANCE,
CASH_ADVANCE_REVERSAL,
CASH_DEPOSIT,
CASH_DEPOSIT_REVERSAL,
CROSS_BORDER_TRANSACTION,
CROSS_BORDER_TRANSACTION_REVERSAL,
EFT_TRANSFER,
EFT_TRANSFER_REVERSAL,
FOREIGN_ATM,
FOREIGN_ATM_REVERSAL,
FOREIGN_TRANSACTION,
FOREIGN_TRANSACTION_REVERSAL,
INACTIVITY,
INACTIVITY_REVERSAL,
LATE_PAYMENT,
LATE_PAYMENT_REVERSAL,
MAINTENANCE,
MAINTENANCE_REVERSAL,
MISCELLANEOUS,
MISCELLANEOUS_REVERSAL,
ORIGINATION,
ORIGINATION_REVERSAL,
OVER_THE_LIMIT,
OVER_THE_LIMIT_REVERSAL,
OVERDRAFT,
OVERDRAFT_REVERSAL,
RETURNED_ITEM,
RETURNED_ITEM_REVERSAL,
RETURNED_PAYMENT,
RETURNED_PAYMENT_REVERSAL,
STOP_PAYMENT,
STOP_PAYMENT_REVERSAL,
SUBSCRIPTION,
SUBSCRIPTION_REVERSAL,
WIRE_TRANSFER,
WIRE_TRANSFER_REVERSAL,
CHECK_ISSUANCE,
CHECK_ISSUANCE_REVERSAL,
ACCOUNT_FUNDING_AFT,
ACCOUNT_FUNDING_AFT_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 fee in ISO 4217 minor currency units, e.g. cents. The internal account will be debited this amount. Can be overridden when creating a fee.

Example:

1000

​
description
string

The description of the fee template.

Example:

"Premium Customer ATM Fee"

​
metadata
object

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