Skip to main content
GET
Get a fee config

Authorizations

Authorization
string
header
required

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

Path Parameters

fee_config_id
string<uuid>
required

Unique identifier of a fee config.

Example:

"5c943c51-e4ff-4e57-9558-08cab6b96398"

Response

Fee config

creation_time
string<date-time>
required
read-only
Example:

"2024-01-15T10:00:00Z"

id
string<uuid>
required

Unique identifier for this fee config.

Example:

"5c943c51-e4ff-4e57-9558-08cab6b96398"

last_updated_time
string<date-time>
required
read-only
Example:

"2024-06-01T12:00:00Z"

tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

amount_config
object
required

Amount calculation parameters for a fee config. amount_type determines which config field is used.

fee_category
enum<string>
required

The category of event that triggers or schedules this fee. Trigger-based categories (ach:, wire:, card:, account:) fire when a matching transaction is posted. Scheduled categories (schedule:*) fire on a time-based cadence.

Available options:
account:nsf,
account:overdraft,
account:statement_paper,
ach:incoming,
ach:incoming_credit_return,
ach:incoming_debit_return,
ach:outgoing,
ach:outgoing_credit,
ach:outgoing_credit_return,
ach:outgoing_debit,
card:atm_out_of_network,
card:atm_withdrawal,
card:cash_advance,
card:cash_advance_financial_services,
card:cash_advance_gaming_betting,
card:cash_advance_quasi_cash,
card:foreign_transaction,
card:mcc_based,
schedule:account_anniversary,
schedule:daily_while_overdrawn,
schedule:monthly,
schedule:monthly_if_below_minimum,
schedule:monthly_if_dormant,
wire:incoming,
wire:outgoing_domestic,
wire:outgoing_international
name
string
required

Human-readable name for this fee rule.

Example:

"ACH Outgoing Debit Fee"

status
enum<string>
required
Available options:
active,
inactive
description
string

Description of this fee rule.

Example:

"Charged when an ACH debit is initiated"

in_auth
boolean
default:false

When true, this fee is evaluated and held at authorization time (when the parent hold is created) rather than post-hoc when the transaction is posted. The fee hold is batched with the main hold in a single atomic centinel request.

Example:

false

respect_balance_checks
boolean

When true, posting this fee respects the account's balance constraints. If the account has insufficient balance at the time of posting, the fee is held rather than posted immediately. A daily retry job will attempt to post held fees once the account balance is sufficient.

Example:

false

reverse_with_parent
boolean

When true, reversals of the triggering transaction also reverse this fee.

Example:

true

rule_config
object

Category-specific rule parameters. Provide the field that matches the fee_config's fee_category; all other fields must be omitted.

template_id
string<uuid>

ID of the fee template that provides accounting setup (internal account, currency, subtype) for automated fee posting. Required for trigger-based and scheduled fees.

Example:

"8b943c51-e4ff-4e57-9558-08cab6b96234"