POST
/
fees
Create a fee
curl --request POST \
  --url https://api.synctera.com/v1/fees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "12943c51-e4ff-4e57-9558-08cab6b96364",
  "amount": 1000,
  "metadata": {},
  "note": "Reduced account fee based on phone call with customer",
  "template_id": "64943c51-e4ff-4e57-9558-08cab6b96352"
}'
{
  "account_id": "12943c51-e4ff-4e57-9558-08cab6b96364",
  "amount": 1000,
  "metadata": {},
  "note": "Reduced account fee based on phone call with customer",
  "template_id": "64943c51-e4ff-4e57-9558-08cab6b96352",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "description": "Premium Customer ATM Fee",
  "id": "44943c51-e4ff-4e57-9558-08cab6b96321",
  "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "subtype": "ACH_INCOMING_TRANSFER",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "11943c51-e4ff-4e57-9558-08cab6b96333"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Fee to create

​
account_id
string<uuid>
required

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

Example:

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

​
template_id
string<uuid>
required

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

Example:

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

​
amount
integer

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

Example:

1000

​
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 fee.

Example:

"Reduced account fee based on phone call with customer"

Response

Created fee

​
account_id
string<uuid>
required

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

Example:

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

​
amount
integer
required

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

Example:

1000

​
template_id
string<uuid>
required

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

Example:

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

​
creation_time
string<date-time>
required

The timestamp representing when the fee was created

Example:

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

​
currency
string
required

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

​
id
string<uuid>
required

The ID of the fee.

Example:

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

​
internal_account_id
string<uuid>
required

The ID of internal_account that is the destination of the fee transfer.

Example:

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

​
last_updated_time
string<date-time>
required

The timestamp representing when the fee was last updated

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,
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.

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 fee.

Example:

"Reduced account fee based on phone call with customer"