GET
/
accounts
List accounts
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/accounts \
  --header 'Authorization: Bearer <token>'
{
  "accounts": [
    {
      "access_status": "ACTIVE",
      "access_status_last_updated_time": "2023-11-07T05:31:56Z",
      "account_closure": {
        "cases": [
          {
            "case_id": "<string>",
            "case_reason": "<string>"
          }
        ],
        "destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payment_method": "ACH",
        "reason": "BANK_REQUEST_REGULATORY_REASONS",
        "reason_details": "<string>",
        "validation_responses": [
          {
            "details": {},
            "message": "Cards decoupled from account",
            "name": "cards",
            "validated": true
          }
        ]
      },
      "account_number": "<string>",
      "account_number_masked": "123*****6789",
      "account_purpose": "This account for the account holder's salary deposit.",
      "account_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_type": "CHARGE_SECURED",
      "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "auto_payment_period": 20,
      "balance_ceiling": {
        "balance": 1,
        "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "balance_floor": {
        "balance": 123,
        "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "balances": [
        {
          "balance": 2399,
          "type": "ACCOUNT_BALANCE"
        }
      ],
      "bank_account_id": "<string>",
      "bank_routing": "<string>",
      "billing_period": {
        "frequency": "ANNUALLY",
        "start_date": "2022-01-01T00:00:00Z"
      },
      "business_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "close_date": "2023-12-25",
      "creation_time": "2023-11-07T05:31:56Z",
      "credit_limit": 2500,
      "currency": "USD",
      "customer_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "customer_type": "BUSINESS",
      "days_past_due": 123,
      "exchange_rate_type": "M, INTERBANK, CUST",
      "fee_product_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "funds_ownership": "BANK",
      "general_ledger_category": "CORE",
      "general_ledger_type": "ACH_SETTLEMENT",
      "grace_period": 21,
      "iban": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_account_pool": true,
      "is_ach_enabled": true,
      "is_card_enabled": true,
      "is_external_card_enabled": true,
      "is_p2p_enabled": true,
      "is_sar_enabled": true,
      "is_security": true,
      "is_synctera_pay_enabled": true,
      "is_system_auto_pay_enabled": true,
      "is_wire_enabled": true,
      "last_updated_time": "2023-11-07T05:31:56Z",
      "metadata": {},
      "minimum_payment": {
        "min_amount": 123,
        "rate": 123,
        "type": "FULL"
      },
      "nickname": "<string>",
      "open_date": "2023-12-25",
      "overdraft_limit": 1,
      "restrictions": {
        "is_account_out_of_area": true,
        "is_delinquent": true,
        "is_past_due": true,
        "is_revoked": true
      },
      "security": {
        "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "spend_control_ids": [
        "7d943c51-e4ff-4e57-9558-08cab6b963c7"
      ],
      "spending_limits": {
        "day": {
          "amount": 1,
          "transactions": 1
        },
        "description": "<string>",
        "lifetime": {
          "amount": 1,
          "transactions": 1
        },
        "month": {
          "amount": 1,
          "transactions": 1
        },
        "transaction": {
          "amount": 1
        },
        "week": {
          "amount": 1,
          "transactions": 1
        }
      },
      "status": "ACCOUNT_NEVER_ACTIVE",
      "stop_payments": [
        {
          "dispute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "expires_on": "2023-11-07T05:31:56Z",
          "originator_name": "<string>",
          "stop_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "swift_code": "<string>",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
nickname
string

Nickname of the account

​
account_number
string[]

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.

Example:

"2345678108180014864"

​
last_name
string

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
enum<string>

The type of the general ledger account

Available options:
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,
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
​
status
enum<string>[]
​
first_name
string

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_id
string<uuid>[]
deprecated

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.

Example:

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

​
account_type
enum<string>

The type of the account

Available options:
CHARGE_SECURED,
CHARGE_UNSECURED,
CHECKING,
GENERAL_LEDGER,
LINE_OF_CREDIT,
SAVING
​
business_id
string<uuid>[]

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

Example:

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

​
overdraft_account_id
string<uuid>[]
deprecated

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.

Example:

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

​
spend_control_ids
string<uuid>[]

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

Maximum length: 20
​
page_token
string

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

Example:

"a8937a0d"

​
person_id
string<uuid>[]

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

Example:

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

​
customer_type
enum<string>

Customer type of the account, BUSINESS or PERSONAL

Available options:
BUSINESS,
PERSONAL
​
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

​
customer_id
string<uuid>
deprecated

The customer's unique identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
interest_product_id
string

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

​
linked_account_id
string<uuid>[]

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.

Example:

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

​
id
string<uuid>[]

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

Example:

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

​
sort_by
enum<string>[]

Specifies the sort order for the returned accounts.

​
access_status
enum<string>[]

Response

List of accounts

​
accounts
object[]
required

Array of Accounts

​
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"