v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Account numbers

Update an account number

Updates the editable fields of an account number of your organization: description, status, metadata, and inbound options.

patch/account_numbers/{id}

Path parameters

idstring required

Unique identifier of the account number to update.

Request body

descriptionstring

Free-text description of the account number.

status'enabled' | 'disabled'

Status to apply to the account number. One of enabled (can receive inbound transfers) or disabled (cannot receive inbound transfers). You cannot set the blocked or deleted states through this endpoint.

metadataobject

Set of key-value pairs you can attach to the account number for storing additional structured information.

Example request

{
  "description": "Updated description",
  "status": "disabled",
  "metadata": {
    "invoice_id": "12345"
  },
  "options": {
    "min_amount": 1000,
    "max_amount": 1000000
  }
}

Response

The updated account number.

idstring required

Unique identifier of the account number.

object'account_number' required

Type of the object. Always account_number.

account_idstring required

Identifier of the account this number belongs to.

created_atstring date-time required

Time the account number was created, as an ISO 8601 datetime in UTC.

deleted_atstring nullable required

Time the account number was deleted, as an ISO 8601 datetime in UTC, or null when not deleted.

descriptionstring nullable required

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

is_rootboolean required

Whether this account number is the account's default.

last_transfer_atstring nullable required

Time of the last transfer received, as an ISO 8601 datetime in UTC, or null when no transfer has been received.

metadataobject required

Set of key-value pairs attached to the account number.

mode'live' | 'test' required

Whether the account number holds live or test data.

numberstring required

Account number that receives inbound transfers. In Mexico, the 18-digit standardized Mexican bank account number (CLABE); in Chile, the bank account number.

status'enabled' | 'disabled' | 'blocked' | 'deleted' required

Current state of the account number. One of enabled (can receive inbound transfers), disabled (you turned off inbound transfers), blocked (Fintoc blocked inbound transfers), or deleted (removed; see deleted_at).

updated_atstring date-time required

Time the account number was last updated, as an ISO 8601 datetime in UTC.

Example response

{
  "id": "acno_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
  "account_id": "acc_2hQ9vBmKpR7xLtZ3sWn1fJ4dGcA",
  "created_at": "2026-03-01T12:00:00.000Z",
  "description": "Payouts CLABE",
  "metadata": {
    "invoice_id": "12345"
  },
  "mode": "test",
  "number": "646180111800000000",
  "options": {
    "min_amount": 1000,
    "max_amount": 1000000
  },
  "status": "enabled",
  "updated_at": "2026-03-01T12:00:00.000Z"
}