Skip to main content
PATCH
Update an account
You can update only the description attribute of an Account.

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Unique identifier of the account to update.

Body

application/json
description
string

New free-text description for the account. Up to 40 characters.

Example:

"Updated description"

Response

The updated account.

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:

"646180111800000004"

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"