Bank Account
Fields
| Field | Type | Description |
|---|---|---|
id | string | Pey identifier (ULID) of the bank account. Use it as bankAccountId when creating a CoDi QR or push notification |
alias | string | Friendly alias for the bank account |
name | string | Full legal name of the account holder |
clabe | string | 18-digit CLABE |
entity | string | Type of entity that owns the account: business or person |
taxId | string | RFC of the account holder. Only present when it was provided on registration |
codiStatus | string | CoDi registration status. See CoDi status |
errorMessage | string | Reason the CoDi registration failed. Only present when codiStatus is error |
dateCreated | number | Unix timestamp (seconds) of when the bank account was registered |
CoDi status
| Value | Description |
|---|---|
pending | Received, not yet sent to Banxico |
processing | Registration with Banxico in progress |
active | Registered. The account can receive CoDi payments |
error | Registration failed. See errorMessage |
Only active accounts can receive payments. Registration with Banxico takes up to 5 business days. When the account becomes active, the Bank Account Updated webhook is sent.
info
This is the object returned by Get Bank Account. Register Bank Account returns only id and codiStatus.