Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Accounts

List accounts

Get a paginated list of accounts.

GENERAL_LEDGER accounts are not included by default. To include them, set include_general_ledger=true, or account_type=GENERAL_LEDGER.

Note: GENERAL_LEDGER accounts are in Alpha status, and cannot yet be created. We may make breaking changes.

get/accounts

Query parameters

customer_idCustomerId[]

A list of customer unique identifiers, with a comma separating any values.

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
is_any_payment_rail_enabledboolean

If true, return only accounts with at least one payment rail enabled. If false, return only accounts with no payment rails enabled. Internal transfers are not considered.

nicknamestring

Nickname of the account

is_account_out_of_areaboolean

Filter accounts by whether any account holder is outside the supported countries.

account_program_idstring[]

Account program ID(s). Multiple IDs can be provided as a comma-separated list.

account_numberstring[]

Account number(s). Multiple account numbers can be provided as a comma-separated list. When only a single account number is provided, any * characters in the string are wildcards, and match any characters.

last_namestring

Only return resources where the last_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:Smith
general_ledger_type'ACH_SETTLEMENT' | 'ACH_SUSPENSE' | 'ALLOCATED_SUSPENSE' | 'BANK_DRAFT' | 'BILLING_EXPENSE' | 'BILLING_REVENUE' | 'CARD_AFT_PREFUNDING' | 'CARD_OCT_SETTLEMENT' | 'CARD_SETTLEMENT' | 'CASH_SETTLEMENT' | 'CASH_SUSPENSE' | 'CHECK_SETTLEMENT' | 'DISPUTE_WRITE_OFF_PNL' | 'EFT_CA_SETTLEMENT' | 'EFT_CA_SUSPENSE' | 'EXTERNAL_CARD_AFT_SETTLEMENT' | 'EXTERNAL_CARD_OCT_SETTLEMENT' | 'FEDNOW_SETTLEMENT' | 'FEES' | 'FRAUD_LOSSES' | 'FUNDING_ACCOUNTS' | 'GENERAL_PNL' | 'INTEREST_PAYOUT' | 'INTERNATIONAL_WIRE_SETTLEMENT' | 'IN_STORE_CASH_SETTLEMENT' | 'LOC_INTEREST_INCOME' | 'LOC_INVESTOR_PORTFOLIO' | 'LOC_REPURCHASE' | 'MONEY_IN_AND_OUT' | 'NEGATIVE_BALANCE' | 'NETWORK_ADJUSTMENT' | 'NETWORK_CHARGEBACK' | 'NEW_FUNDING_ACCOUNT' | 'PROVISIONAL_CREDIT_PNL' | 'RESERVE' | 'REWARDS' | 'SC_INVESTOR_PORTFOLIO' | 'SC_REPURCHASE' | 'SYNCTERA_PAY_SUSPENSE' | 'USC_INTEREST_INCOME' | 'USC_INVESTOR_PORTFOLIO' | 'USC_REPURCHASE' | 'WIRE_SETTLEMENT' | 'WIRE_SUSPENSE' | 'WRITE_OFF'

The type of general ledger account. This is required when creating a general ledger account.

The type of the general ledger account

is_delinquentboolean

Filter accounts by whether the account is delinquent on minimum payments.

statusAccountStatus[]
first_namestring

Only return resources where the first_name or chosen_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:Alice
overflow_account_idstring[]

Overflow account ID(s). Multiple IDs can be provided as a comma-separated list. This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.

is_past_dueboolean

Filter accounts by whether the account is past due on minimum payments.

account_type'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING'

The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types:

  • SAVING: Savings account
  • CHECKING: Checking account
  • PREPAID: Prepaid account
  • LINE_OF_CREDIT: Line of Credit account
  • CREDIT_CARD: Credit Card account
  • CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering
  • CHARGE_UNSECURED: (alpha) Unsecured Charge account
  • REVOLVING_CREDIT_SECURED: Secured Revolving Credit account
  • REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account
  • GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator.

The type of the account

from_creation_timestring date-time
Example:2026-06-12T10:30:00Z

Only return accounts created at or after the given date and time.

business_idstring[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

overdraft_account_idstring[]

Overdraft account ID(s). Multiple IDs can be provided as a comma-separated list. This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.

spend_control_idsstring[]

List of spend control IDs to control spending for the account

Spend Control ID(s). Multiple IDs can be provided as a comma-separated list. Return only resources that use the specified Spend Controls.

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
is_revokedboolean

Filter accounts by whether the account's credit privileges have been revoked.

page_tokenstring

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

Example:a8937a0d
person_idstring[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

customer_type'BUSINESS' | 'PERSONAL'

Customer type

Customer type of the account, BUSINESS or PERSONAL

limitinteger

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

Example:100
interest_product_idstring

Interest product ID that accounts associate with. Multiple IDs can be provided as a comma-separated list.

to_creation_timestring date-time
Example:2026-06-12T10:30:00Z

Only return accounts created at or before the given date and time.

linked_account_idstring[]

Return only resources that are linked to the specified backing account in balance_floor or balance_ceiling. Multiple IDs can be provided as a comma-separated list.

idstring[]

Account ID(s). Multiple IDs can be provided as a comma-separated list.

sort_bystring[]

Specifies the sort order for the returned accounts.

entity_namestring

Only return resources where the entity_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:Apex Corporation
access_statusAccountAccessStatus[]

Response

List of accounts

next_page_tokenstring

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