Bank Account Updated

This webhook is triggered when a bank account registered through Register Bank Account becomes active and can receive CoDi payments.

It is only sent for the transition to active. The pending, processing and error states do not trigger a webhook; check them with Get Bank Account.

Payload

{
  "type": "bank.account.updated",
  "bankAccountId": "string",
  "name": "string",
  "ownerType": "string",
  "ownerId": "string",
  "taxId": "string",
  "codiStatus": "string",
  "clabe": "string",
  "entity": "string"
}

Fields

Field	Type	Description
type	string	The event type (bank.account.updated)
bankAccountId	string	Pey identifier (ULID) of the bank account. Use it as bankAccountId when creating a CoDi QR or push notification
name	string	Full legal name of the account holder
ownerType	string	Type of owner of the bank account. API_KEY for accounts registered through the API
ownerId	string	Identifier of the owner. The API key ID when ownerType is API_KEY
taxId	string	RFC of the account holder. Only present when it was provided on registration
codiStatus	string	CoDi registration status. Always active in this webhook. See Bank Account
clabe	string	18-digit CLABE
entity	string	Type of entity that owns the account: business or person

The payload does not include alias, errorMessage or dateCreated. Those are only available through Get Bank Account.

Example

{
  "type": "bank.account.updated",
  "bankAccountId": "01JBAVWE4NS5TGXHWGMX3KH23Q",
  "name": "Empresa SA de CV",
  "ownerType": "API_KEY",
  "ownerId": "01M3QMMR6X9CBVDY1SF3G8QWNW",
  "taxId": "XAXX010101000",
  "codiStatus": "active",
  "clabe": "012180001234567899",
  "entity": "business"
}