Create a fee template

post https://api.synctera.com/v1/fee_templates

🚧
Beta
This is a Beta endpoint. Feedback from the community is welcome. Any breaking changes to this endpoint will be pre-announced.

Create a fee template
A fee template defines the properties of a fee that a fintech wishes to
use to easily charge their customers. The fintech can then create fee templates for different
amounts or categories of fees that represent different instances of services or charges

Body Params

Fee to create

🚧
Beta
This is a Beta endpoint. Feedback from the community is welcome. Any breaking changes to this endpoint will be pre-announced.

subtype

string

required

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

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.

currency

string

required

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

description

string

required

The description of the fee template.

internal_account_id

string

required

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

is_enabled

boolean

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

metadata

object

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

Responses

Response body

object

creation_time

date-time

required

The timestamp representing when the fee template was created

string

required

The ID of the fee template.

last_updated_time

date-time

required

The timestamp representing when the fee template was last modified

subtype

string

required

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

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 OVERDRAFT OVERDRAFT_REVERSAL OVER_THE_LIMIT OVER_THE_LIMIT_REVERSAL RETURNED_ITEM RETURNED_ITEM_REVERSAL RETURNED_PAYMENT RETURNED_PAYMENT_REVERSAL STOP_PAYMENT STOP_PAYMENT_REVERSAL SUBSCRIPTION SUBSCRIPTION_REVERSAL WIRE_TRANSFER WIRE_TRANSFER_REVERSAL

tenant

string

required

The id of the tenant containing the resource.

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.

currency

string

required

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

description

string

The description of the fee template.

internal_account_id

string

required

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

is_enabled

boolean

required

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

metadata

object

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

Has additional fields

Language

Credentials

Bearer

api_key

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.synctera.com/v1/fee_templates \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "subtype": "ACH_INCOMING_TRANSFER"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Create a fee template

🚧
Beta

🚧
Beta

🚧Beta

201Created fee template

400Bad request

401Unauthorized

403Forbidden

409Resource already exists

500Internal server error

🚧
Beta