Saltar al contenido principal

Cuenta bancaria actualizada

Este webhook se dispara cuando una cuenta bancaria registrada a través de Register Bank Account pasa a active y puede recibir pagos CoDi.

Solo se envía en la transición a active. Los estados pending, processing y error no disparan un webhook; consúltalos con Get Bank Account.

Payload​

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

Campos​

CampoTipoDescripción
typestringEl tipo de evento (bank.account.updated)
bankAccountIdstringIdentificador de Pey (ULID) de la cuenta bancaria. Úsalo como bankAccountId al crear un QR o una notificación push CoDi
namestringNombre legal completo del titular de la cuenta
ownerTypestringTipo de propietario de la cuenta bancaria. API_KEY para cuentas registradas a través de la API
ownerIdstringIdentificador del propietario. El ID de la API key cuando ownerType es API_KEY
taxIdstringRFC del titular de la cuenta. Solo está presente si se proporcionó al registrarla
codiStatusstringEstado del registro CoDi. Siempre active en este webhook. Ver Cuenta bancaria
clabestringCLABE de 18 dígitos
entitystringTipo de entidad titular de la cuenta: business o person

El payload no incluye alias, errorMessage ni dateCreated. Esos solo están disponibles a través de Get Bank Account.

Ejemplo​

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