Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Accounts

List accounts

Lists the accounts of your organization for the live or test mode of the API key used. Filter by entity_id and status. The list is paginated. Use the starting_after, ending_before, and limit query parameters to move through the list. The Link response header carries the URLs to navigate the paginated list.

get/accounts

Query parameters

entity_idstring

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

status'active' | 'blocked' | 'closed'

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

starting_afterstring
Example:acc_2rNxBkOrlHoOYsZTyQYhA0o8Ek0

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

ending_beforestring
Example:acc_2rNxBkOrlHoOYsZTyQYhA0o8Ek0

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

limitinteger
Example:50

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

Response

List of accounts for the current mode.

idstring required

Unique identifier of the account.

object'account' required

Type of the object. Always account.

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

currency'CLP' | 'MXN' required

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

descriptionstring nullable required

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

is_rootboolean required

Whether this account is the organization's root account.

mode'live' | 'test' required

Whether the account holds live or test data.

root_account_numberstring required

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

root_account_number_idstring required

Identifier of the default account number.

status'active' | 'blocked' | 'closed' required

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

Example response

[
  {
    "id": "acc_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
    "available_balance": 1050000,
    "currency": "MXN",
    "description": "Main collection account",
    "entity": {
      "id": "ent_2eGhTp1rLqWnXkZbYc4JsKmAvD9",
      "holder_id": "000000000",
      "holder_name": "Test Customer 1",
      "is_root": true
    },
    "is_root": true,
    "mode": "test",
    "root_account_number": "646180111800000000",
    "root_account_number_id": "acno_2fJkRm7tBvQxNzYpLc5WsHaDfT3",
    "status": "active"
  }
]