Account Number Object

Account numbers enable you to receive and track realtime Inbound Transfers using the Transfer API.

{
  "id": "acno_Kasf91034gj1AD",
  "object": "account_number",
  "description": "My payins",
  "number": "738969123456789120",
  "created_at": "2024-03-01T20:09:42.949787176Z",
  "updated_at": "2024-03-01T20:09:42.949787176Z",
  "mode": "test",
  "status": "enabled",
  "is_root": "false",
  "account_id": "acc_Lq7dP901xZgA2B",
  "metadata": {
    "order_id": "12343212"
  }
}

Account Number Object

Field

Type

Description

id

string

Unique identifier for the account number.

object

string

The type of the object, which is always account_number.

description

string

A description you can use to easily identify this Account Number (40 chars max.).

number

string

The account number (for Mexico: CLABE) of the sender.

created_at

string

Timestamp when the account number was created (in ISO 8601 format).

updated_at

string

Timestamp when the account number was last updated (in ISO 8601 format).

mode

string

Mode of the API (test or live).

status

string

Status of this Account Number, it can be enabled or disabled.
Inbound Transfers directed to disabled Account Numbers will be automatically returned.

is_root

bool

Indicates if the Account Number is the main Account Number of the Account. Root Account Numbers will appear as the sender Account Number for Outbound Transfers.

account_id

string

Account the Account Number points to.

metadata

object

Optional key-value pairs associated with this account number.