Skip to main content
GET
List accounts
v2 · Base URL https://api.fintoc.com/v2

Authorizations

Authorization
string
header
required

Query Parameters

entity_id
string

Identifier of the entity whose accounts are returned. If omitted, returns only the accounts of your root entity.

status
enum<string>

Status of the accounts to return. One of active, blocked, closed.

Available options:
active,
blocked,
closed
starting_after
string

Cursor for pagination. Use the ID of the last account on the current page to fetch the next page.

Example:

"acc_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"

ending_before
string

Cursor for pagination. Use the ID of the first account on the current page to fetch the previous page.

Example:

"acc_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"

limit
integer

Maximum number of accounts to return per page. Ranges from 1 to 300. Defaults to 30.

Example:

50

Response

List of accounts for the current mode.

id
string
required

Unique identifier of the account.

Example:

"acc_2daFu0zqqDtZGJaSi2TGI2Mm1nN"

object
any
required

Type of the object. Always account.

available_balance
integer
required

Available balance of the account, in the smallest currency unit. For MXN the smallest unit is the centavo; for CLP it is the peso, which has no minor unit.

Example:

1050000

currency
enum<string>
required

ISO 4217 currency code of the account. One of CLP, MXN.

Available options:
CLP,
MXN
Example:

"MXN"

description
string | null
required

Free-text description of the account, or null when none is set.

Example:

"Main collection account"

entity
object
required

Owner entity of the account.

is_root
boolean
required

Whether this account is the organization's root account.

Example:

true

mode
enum<string>
required

Whether the account holds live or test data.

Available options:
live,
test
Example:

"test"

root_account_number
string
required

Default account number of the account. In Mexico, the 18-digit standardized bank account number (CLABE); in Chile, the bank account number.

Example:

"646180111800000000"

root_account_number_id
string
required

Identifier of the default account number.

Example:

"acno_2fJkRm7tBvQxNzYpLc5WsHaDfT3"

status
enum<string>
required

Status of the account. One of active, blocked, closed.

Available options:
active,
blocked,
closed
Example:

"active"