Skip to main content
GET
/
internal_accounts
List internal accounts
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/internal_accounts \
  --header 'Authorization: Bearer <token>'
{
  "internal_accounts": [
    {
      "currency": "USD",
      "status": "ACTIVE",
      "tenant": "abcdef_ghijkl",
      "account_number": "<string>",
      "account_type": "ACH_SETTLEMENT",
      "balances": [
        {
          "balance": 2399,
          "type": "ACCOUNT_BALANCE"
        }
      ],
      "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bank_routing": "<string>",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "description": "<string>",
      "gl_type": "ASSET",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_system_acc": false,
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "purpose": "CORE"
    }
  ],
  "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

​
page_token
string

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

Example:

"a8937a0d"

​
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

​
sort_by
string

Optional sort by query parameter. The direction is delimited by ':' and multiple sort fields are delimited by ','

Example:

"account_id:desc,name:asc"

​
id
string<uuid>[]

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

Example:

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

Response

List of internal accounts

​
internal_accounts
object[]
required

Array of internal 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"