The type of the object, which is always account_number.
account_id
string
Account the Account Number points to.
created_at
string
Timestamp when the account number was created (in ISO 8601 format).
deleted_at
string
Timestamp when the account number was deleted. null if the account number has not been deleted.
description
string
A description you can use to easily identify this Account Number (40 chars max.).
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.
last_transfer_at
string
Timestamp of the last inbound transfer received by this account number. null if no inbound transfer has ever been received.
metadata
object
Optional key-value pairs associated with this account number.
mode
string
Mode of the API (test or live).
number
string
The account number (for Mexico: CLABE) of the sender.
options
object
Additional configurations for Account Numbers.
status
string
Status of this Account Number, it can be enabled, disabled, blocked or deleted .
Inbound Transfers directed to disabled, blocked or deleted Account Numbers will be automatically returned.
updated_at
string
Timestamp when the account number was last updated (in ISO 8601 format).
Options Object (within Account Number Object)
Field
Type
Description
max_amount
integer
Maximum amount accepted for inbound transfers. Transfers exceeding this threshold will be automatically rejected. Amount is specified in the base currency unit for the account's country: centavos for Mexico, pesos for Chile. Must be a positive integer or null.
min_amount
integer
Minimum amount accepted for inbound transfers. Transfers below this threshold will be automatically rejected. Amount is specified in the base currency unit for the account's country: centavos for Mexico, pesos for Chile. Must be a positive integer or null.