Skip to main content
GET
List fees

Authorizations

Authorization
string
header
required

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

Query Parameters

id
string<uuid>[]

Return the fee with the specified id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

fee_template_id
string<uuid>[]

Return fees resources with a fee template of the specified id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

description
string

Return fees with the specified description. A * character can be used as a wildcard to match any characters.

subtype
enum<string>

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
start_time
string<date-time>

Return fees created at or after this time.

end_time
string<date-time>

Return fees created before this time.

account_id
string<uuid>[]

Return fees for the specified account.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

derived_from_uuid
string<uuid>[]

Return fees that were derived from (triggered by) the specified transaction UUID. Useful for surfacing the fees associated with a given posted/pending transaction. Multiple IDs can be provided as a comma-separated list.

Example:

"54702cd9-789a-4a89-b2c6-ee168d26c540"

limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

List of fees

fees
Fee response object · object[]
required

Array of fees

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"