> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List fees > Get paginated list of fees ## OpenAPI ````yaml openapi-v2.json get /fees openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 2.5.0 servers: - description: Production url: https://api.synctera.com/v2 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v2 security: - bearerAuth: [] tags: - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Create and manage spending controls name: Spend Controls (beta) - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Rates name: Rates - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: API for point-in-time account balances name: account_balances - description: Requests to create and manage webhooks name: Webhooks - description: > Vendor-agnostic daily snapshots of a credit account's state (balances, past-due status, per-bucket breakdown). Populated first from LoanPro, but not specific to it. Internal-only: there is no public write path, only an internal sync job. name: Credit Account Daily Snapshots - description: Tenant Config name: Tenant Config - description: Create and manage documents. name: Documents - description: Request to create and manage statements name: Statements - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create and manage disputes name: Disputes - description: Requests to simulate card payments name: Card Simulations - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: >- Aggregated write-off amounts for lending accounts, computed from posted transactions. name: Write Off Amounts - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: Apple Pay APIs name: Apple Pay - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Lending Config name: Lending Config - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Payments related to lending accounts name: Payments - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Manage negative balance processes name: Negative Balance - description: Create and manage wire transfers name: Wires - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Create and manage tenant-level transaction limits name: Tenant Limits (beta) - description: Create and manage transactions name: Transactions (beta) - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: Autopay payment records for billing periods name: Autopays - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Requests to create and manage API keys name: API Keys - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: > The fintech profile document resource is used to track the approval status of any documents which must be reviewed by a bank. This includes regulatory documents which will be presented to the fintech's end users, and also any documents that help the bank understand the fintech's fitness for duty. name: Fintech Profile - description: Billing rates name: Billing Rates - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Create and manage Synctera Pay templates name: SyncteraPay - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to configure vendors. name: Vendor Configurations - description: Requests to create licenses name: Licenses - description: Requests to create and manage card disputes name: Card Disputes - description: Requests to Admins to grant permissions to user name: Request Permissions - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Bulk card issuance name: Bulk Issuance - description: Requests to search financial institutions name: Institutions (Beta) - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Create and manage scheduled transactions name: Scheduled Transactions (internal) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: | Saved prefills for the internal transfer form name: Internal Transfer Templates - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Configuration and management of transaction monitoring rules name: Transaction Monitoring - description: Create a credit application. name: Applications (beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Billing period summaries name: Billing Period Summaries - description: Requests to initiate customer verification. name: KYC/KYB Verifications - description: Requests to grant, list, update, and revoke role bindings name: Role Bindings - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: | Requests to create and manage fees name: Fees (beta) - description: Manage credit disputes name: Credit Disputes paths: /fees: summary: Fees get: tags: - Fees summary: List fees description: | Get paginated list of fees operationId: listFees parameters: - $ref: '#/components/parameters/fee_end_time_query' - $ref: '#/components/parameters/fee_account_id_query' - $ref: '#/components/parameters/fee_subtype_query' - $ref: '#/components/parameters/fee_id_query' - $ref: '#/components/parameters/fee_derived_from_uuid_query' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/fee_start_time_query' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/fee_description_query' - $ref: '#/components/parameters/fee_fee_template_id_query' responses: '200': content: application/json: schema: $ref: '#/components/schemas/fee_list' description: List of fees '401': $ref: '#/components/responses/unauthorized1' '403': $ref: '#/components/responses/forbidden1' '500': $ref: '#/components/responses/internal_server_error1' components: parameters: fee_end_time_query: description: Return fees created before this time. example: '2010-05-06T12:23:34.321Z' in: query name: end_time schema: format: date-time type: string fee_account_id_query: description: Return fees for the specified account. in: query name: account_id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array fee_subtype_query: explode: false in: query name: subtype schema: $ref: '#/components/schemas/fee_subtype' style: form fee_id_query: description: > Return the fee with the specified id. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form fee_derived_from_uuid_query: description: > 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. explode: false in: query name: derived_from_uuid schema: example: 54702cd9-789a-4a89-b2c6-ee168d26c540 items: format: uuid type: string type: array style: form page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string fee_start_time_query: description: Return fees created at or after this time. example: '2010-05-06T12:23:34.321Z' in: query name: start_time schema: format: date-time type: string limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer fee_description_query: description: >- Return fees with the specified description. A * character can be used as a wildcard to match any characters. example: Premium Customer ATM Fee in: query name: description schema: type: string fee_fee_template_id_query: description: > Return fees resources with a fee template of the specified id. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: fee_template_id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form schemas: fee_list: allOf: - $ref: '#/components/schemas/paginated_response' - properties: fees: description: Array of fees items: $ref: '#/components/schemas/fee_response' type: array required: - fees type: object title: List of fees fee_subtype: description: | A short string representing the sub-type of the fee. This will be used as the subtype of the resulting transaction. enum: - ACCOUNT_FUNDING_AFT - ACCOUNT_FUNDING_AFT_REVERSAL - 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 - CHECK_ISSUANCE - CHECK_ISSUANCE_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 type: string paginated_response: properties: next_page_token: description: >- 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 type: string title: Paginated List response type: object fee_response: allOf: - $ref: '#/components/schemas/fee_base' - properties: creation_time: description: The timestamp representing when the fee was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string currency: description: >- currency of the fee, as a three character ISO 4217 alphabetic currency code. example: USD type: string derived_from_uuid: description: > The UUID of the transaction that triggered this fee (for trigger-based fees). Absent for manually-created fees or scheduled fees. example: 1a943c51-e4ff-4e57-9558-08cab6b96300 format: uuid type: string description: description: The description of the fee template. example: Premium Customer ATM Fee type: string fee_category: description: | The fee category that triggered this fee. Absent for manually-created fees. example: ach:outgoing_debit type: string fee_config_id: description: | The ID of the fee config this fee was generated from. Absent for manually-created fees. example: 5c943c51-e4ff-4e57-9558-08cab6b96398 format: uuid type: string fee_product_id: description: | The ID of the fee product this fee was generated from. Absent for manually-created fees. example: 7d943c51-e4ff-4e57-9558-08cab6b96312 format: uuid type: string hold_id: description: > The centinel hold UUID, present while the fee is held pending sufficient balance. example: 0246d1a3-2e6b-4309-b249-0f0b8aa755e6 format: uuid nullable: true type: string id: description: The ID of the fee. example: 44943c51-e4ff-4e57-9558-08cab6b96321 format: uuid type: string internal_account_id: description: >- The ID of internal_account that is the destination of the fee transfer. example: 42943c51-e4ff-4e57-9558-08cab6b963c8 format: uuid type: string last_updated_time: description: The timestamp representing when the fee was last updated example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string original_hold_amount: description: > For auth-time fees: the amount of the parent hold at authorization time. Used to calculate proportional fee settlement when the parent hold is partially settled. example: 10000 format: int64 nullable: true type: integer parent_hold_id: description: > For auth-time fees: the centinel pending transaction UUID of the main transaction hold that this fee was batched with. Used to look up associated fees when the parent hold finalizes. example: 3b943c51-e4ff-4e57-9558-08cab6b96400 format: uuid nullable: true type: string status: $ref: '#/components/schemas/feeward_status' subtype: $ref: '#/components/schemas/fee_subtype' tenant: $ref: '#/components/schemas/tenant_id1' transaction_id: description: > The ID of the resulting transaction. For held fees this is the hold UUID (which is preserved as the transaction ID when the hold is later posted). For posted fees it is the settled transaction UUID. Null for pending and cancelled fees that were never held. example: 11943c51-e4ff-4e57-9558-08cab6b96333 format: uuid nullable: true type: string required: - account_id - amount - creation_time - currency - description - id - internal_account_id - last_updated_time - status - subtype - template_id - tenant title: Fee response object type: object error1: description: Synctera error responses in API v1 implement a custom error schema. properties: code: description: > A machine-readable string that identifies the error for programmatic use. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'Missing required fields: first_name, dob' type: string status: description: HTTP status code for this response example: 400 type: integer title: Synctera error response type: object fee_base: properties: account_id: description: The ID of the business or customer account being charged the fee. example: 12943c51-e4ff-4e57-9558-08cab6b96364 format: uuid type: string amount: description: > 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 type: integer metadata: $ref: '#/components/schemas/metadata' note: description: An optional note for this instance of the fee. example: Reduced account fee based on phone call with customer type: string reference_id: description: >- An optional reference ID that uniquely identifies this fee instance. This ID will be included in the posted fee transaction. example: '1234567890' maxLength: 128 type: string template_id: description: > 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 format: uuid type: string title: Common properties for fee schemas type: object feeward_status: description: The posting status of the fee. enum: - cancelled - held - pending - posted type: string tenant_id1: description: | The id of the tenant containing the resource. example: abcdef_ghijkl type: string metadata: description: > Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data. type: object responses: unauthorized1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Unauthorized forbidden1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Forbidden internal_server_error1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````