v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Accounts

Create an account

Creates an account for an entity of your organization, in the live or test mode of the API key used.

post/accounts

Request body

entity_idstring required

Identifier of the entity that owns the account.

descriptionstring

Free-text description of the account. Up to 40 characters.

Example request

{
  "entity_id": "ent_2eGhTp1rLqWnXkZbYc4JsKmAvD9",
  "description": "Main collection account"
}

Response

The created account.

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