Skip to main content
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": {
        "destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payment_method": "ACH",
        "reason": "BANK_REQUEST_REGULATORY_REASONS",
        "reason_details": "<string>",
        "cases": [
          {
            "case_id": "<string>",
            "case_reason": "<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": 2,
      "iban": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "in_closing_date": "2023-12-25",
      "interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_account_pool": true,
      "is_ach_enabled": true,
      "is_card_enabled": true,
      "is_eft_ca_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": [
        {
          "originator_name": "<string>",
          "stop_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dispute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "expires_on": "2023-11-07T05:31:56Z",
          "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "swift_code": "<string>",
      "tenant": "abcdef_ghijkl",
      "vendor_info": {
        "vendor_data": {
          "loanpro": {
            "cash_advance_bucket_id": 67890,
            "loc_id": 12345,
            "loc_product_id": 67890,
            "purchases_bucket_id": 12345,
            "tenant_id": "1"
          }
        },
        "vendor_type": "LOANPRO"
      }
    }
  ],
  "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

​
customer_id
string<uuid>[]

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

​
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

The type of general ledger account. This is required when creating a 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,
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
​
status
enum<string>[]

The status of the account.

StatusDescriptionTransactable
ACCOUNT_NEVER_ACTIVEAccount was never activated by the customerN
ACCOUNT_NOT_DESIREDA credit account was created for a customer, but the customer did not accept the accountN
ACTIVATED_NOT_DISBURSEDA credit account was created for the customer, but the funds have not been paid out or usedN
ACTIVE_OR_DISBURSEDThe account is active and transactableY
APPLICATION_SUBMITTEDDeprecated statusN
AWAITING_FIXINGAccount is awaiting fixingN
CHARGED_OFFThe account has been charged off and is closedN
CLOSEDAccounts must be zeroed out before being closed. Closed accounts cannot transactN
DELINQUENTSynctera will update a credit account to delinquent if the customer has not paid within their expected billing cycleN
FAILED_KYCWe were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checksN
IN_CLOSINGThe account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited.N
RESTRICTEDSynctera will update accounts to restricted of the account holder has not successfully passed KYCN
SUSPENDEDAccount has been suspected of fraudulent activity and is blocked from further transactionsN
Available options:
ACCOUNT_NEVER_ACTIVE,
ACCOUNT_NOT_DESIRED,
ACTIVATED_NOT_DISBURSED,
ACTIVE_OR_DISBURSED,
APPLICATION_SUBMITTED,
AWAITING_FIXING,
CHARGED_OFF,
CLOSED,
DELINQUENT,
FAILED_KYC,
IN_CLOSING,
RESTRICTED,
SUSPENDED
​
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>[]

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

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
  • 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.
Available options:
CHARGE_SECURED,
CHARGE_UNSECURED,
CHECKING,
GENERAL_LEDGER,
LINE_OF_CREDIT,
PREPAID,
REVOLVING_CREDIT_SECURED,
REVOLVING_CREDIT_UNSECURED,
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>[]

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.

List of spend control IDs to control spending for the account

Maximum array 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

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

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

Available options:
account_number:asc,
account_number:desc,
account_type:asc,
account_type:desc,
first_name:asc,
first_name:desc,
last_name:asc,
last_name:desc
​
access_status
enum<string>[]

Represents whether a customer has frozen their account. FROZEN is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card.

Available options:
ACTIVE,
FROZEN

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"