Un webhook es una devolución de llamada web que Belvo utiliza para enviar notificaciones sobre un enlace específico.
Este artículo trata sobre webhooks para nuestra solución de Iniciación de Pagos. Para obtener información sobre nuestros webhooks de Agregación y Enriquecimiento, consulta este artículo
Para configurar un nuevo webhook:
En tu panel de control de Belvo, ve a la sección de webhooks de pagos.
En la pestaña de Payments Webhooks, haz clic en +New webhook.

Completa el formulario de New webhook con la información requerida.
- URL: la URL para recibir las notificaciones del webhook.
- Authorization: un token bearer opcional para usar si tu URL está protegida.
Haz clic en Create webhook.

Belvo ofrece dos versiones de esquemas de webhook para los webhooks de Payments Brazil:
- Versión de Esquema 1: El formato original de webhook utilizado para los webhooks de CHARGES, ENROLLMENTS, PAYMENT_INTENTS y TRANSACTIONS. Este esquema sigue funcionando para integraciones existentes.
- Versión de Esquema 2 (Nuevo): Un formato de webhook más reciente introducido para una funcionalidad mejorada. Este esquema se utiliza para los webhooks de BANK_ACCOUNTS (V2), CUSTOMERS (V2) y PAYMENT_AUTHORIZATIONS.
Los webhooks de la Versión de Esquema 2 solo se envían cuando los recursos se crean utilizando el encabezado X-Belvo-API-Resource-Version: Payments-BR.V2. Si no incluyes este encabezado, recibirás webhooks en el formato V1 (donde sea aplicable).
Puedes recibir eventos de webhook desde las siguientes direcciones IP:
3.130.254.4618.220.61.18618.223.45.212
Recomendamos encarecidamente que pongas en la lista blanca estas direcciones IP para que puedas recibir eventos de webhook.
Recomendamos encarecidamente que una vez que recibas un webhook, respondas a Belvo con un código de estado 2XX dentro de cinco segundos para confirmar que has recibido el webhook. De lo contrario, nuestra API volverá a intentar la solicitud.
Si nuestro sistema no recibe un código de estado 2XX, intenta automáticamente enviar la solicitud nuevamente. Este proceso de reintento ocurrirá hasta tres veces, con cada intento espaciado 60 segundos. Por ejemplo, si el primer intento falla, nuestro sistema espera 60 segundos antes de intentar nuevamente y continuará este patrón hasta que reciba una respuesta exitosa o alcance el máximo de tres reintentos.
Los payloads de webhook proporcionan detalles de error utilizando diferentes nombres de campo dependiendo de la versión del esquema del webhook y el recurso:
- Webhooks V1 (CHARGES, CUSTOMERS, ENROLLMENTS, PAYMENT_INTENTS, TRANSACTIONS): Usan
failure_code(enUPPERCASE) yfailure_messageen el objetodata. - Webhooks V2 (BANK_ACCOUNT, CHARGE, CUSTOMER, PAYMENT_AUTHORIZATION): Formato de payload mínimo - obtén detalles completos incluyendo
status_reason_codeystatus_reason_messagea través de una solicitud GET.
Para una tabla completa de todos los posibles códigos de razón de estado, consulta Códigos y Mensajes de Payments Brazil.
Los webhooks de Bank Account, Charge y Customer están disponibles en ambas versiones de esquema. Al usar el encabezado X-Belvo-API-Resource-Version: Payments-BR.V2, recibirás el nuevo formato de Esquema Versión 2 que se muestra a continuación. Sin este encabezado, recibirás el formato V1 documentado en la sección Eventos de Webhook (V1).
Cada vez que haya un evento relacionado con una Bank Account, Charge, Customer o Payment Authorization recibirás el siguiente webhook:
{
"schema_version": "2",
"resource": "BANK_ACCOUNT",
"resource_id": "7d01c4cf-57ed-4ed9-b109-a5bfb2d8c42b",
"resource_version": "v2",
"timestamp": "2025-01-16T10:30:45.123456Z"
}Donde:
| Parámetro | Requerido | Tipo | Descripción | Ejemplo |
|---|---|---|---|---|
schema_version | si | string | La versión del esquema del webhook. Actualmente, esto siempre será 2. | 2 |
resource | si | string | El tipo de recurso al que se refiere este webhook. Esto puede ser uno de los siguientes: BANK_ACCOUNT, CHARGE, CUSTOMER, PAYMENT_AUTHORIZATION. | BANK_ACCOUNT |
resource_id | si | string | El identificador único del recurso. Puedes usar este ID para recuperar los detalles del recurso. | 7d01c4cf-57ed-4ed9-b109-a5bfb2d8c42b |
resource_version | si | string | La versión de la API utilizada al crear el recurso. | v2 |
timestamp | si | date-time | La marca de tiempo ISO-8601 de cuándo se actualizó por última vez el recurso. | 2025-01-16T10:30:45.123456Z |
Una vez que recibas la notificación, tendrás que obtener los detalles del recurso haciendo la siguiente solicitud:
curl --request GET 'https://api.belvo.com/payments/br/{resource}/{id}/' \
-u SECRET_ID:SECRET_PASSWORD \
-H 'X-Belvo-API-Resource-Version: Payments-BR.V2'Donde:
resourcees el tipo de recurso que deseas recuperar (bank-accounts,charges,customers, opayment-authorizations).ides elresource_idde la cuenta bancaria (que recibes en el evento del webhook).
{
"webhook_id": "3b9a69f7-0f0a-455b-832d-49ad6fd4905c",
"webhook_type": "PAYMENT_INTENTS",
"webhook_code": "STATUS_UPDATE",
"object_id": "d2e40773-19f6-48d1-93c3-3590ec0c74df",
"external_id": "c3c51aaf-aaa3-400c-926d-87ab62e195fd",
"data": {
"status": "FAILED",
"metadata": {"internal_reference_id": "GGq12345w2"},
"failure_code": "consent_expired",
"failure_message": "The payment consent was not accepted in time.",
"end_to_end_id": "E432158152024081610416f2b595b056"
}
}| Parámetro | Requerido | Tipo | Descripción | Ejemplo |
|---|---|---|---|---|
webhook_id | true | string | El ID del webhook de Belvo. | aadf41a1fc8e4f79a49f7f04027ac999 |
webhook_type | true | string | El recurso al que se refiere este webhook. | CHARGES |
webhook_code | true | string | El evento que activó el webhook. | STATUS_UPDATE |
object_id | true | string | El ID del objeto al que se refiere este webhook. | d2e40773-19f6-48d1-93c3-3590ec0c74df |
external_id | true | string | El identificador único que proporcionaste al crear el objeto. Para cargos y transacciones, este campo siempre devolverá null. | c3c51aaf-aaa3-400c-926d-87ab62e195fd |
data | true | object | Un objeto que contiene datos específicos sobre el evento. Los campos devueltos en este objeto dependen del webhook_type y webhook_code. | Ver filas siguientes. |
data.status | false | string | El estado del cargo o intención de pago. | FAILED |
data.status_reason_code | false | string | Un código de error estandarizado (en formato UPPERCASE) que indica por qué cambió el estado de un recurso. Solo aplicable a webhooks de ENROLLMENTS en eventos V1. | REJECTED_MANUALLY |
data.status_reason_message | false | string | Una descripción legible que explica el cambio de estado. Proporciona contexto para el status_reason_code. Solo aplicable a webhooks de ENROLLMENTS en eventos V1. | Manual cancellation, explicitly at the user's request. |
data.failure_code | false | string | En caso de que el cargo o la intención de pago falle, un código único para el error. | consent_expired |
data.failure_message | false | string | En caso de que el cargo o la intención de pago falle, una descripción legible del error. | The payment consent was not accepted in time. |
data.end_to_end_id | false | string | El ID del pago en el sistema de pagos de Brasil. | E432158152024081610416f2b595b056 |
data.metadata | false | object | Si proporcionaste alguna información en el objeto metadata al crear tu pago, se incluye en el cuerpo del webhook. | { "internal_reference_id": "GGq12345w2" } |
Para obtener información sobre los datos específicos de un webhook dado, haz clic en el tipo de webhook en la tabla a continuación.
| Tipo | Evento | Se envía siempre que... |
|---|---|---|
| CHARGES | STATUS_UPDATE | Hay una actualización en el estado de un Cargo:
|
| CUSTOMERS | OBJECT_CREATED | Se crea un nuevo cliente (esquema V1). Es decir, cuando el cliente se crea de forma asíncrona y no como resultado de una llamada POST directa. |
| ENROLLMENTS | STATUS_UPDATE | Hay una actualización en el estado de una Inscripción:
|
| PAYMENT_INTENTS | STATUS_UPDATE | Hay una actualización en el estado de una Intención de Pago:
|
| TRANSACTIONS | OBJECT_CREATED | Se crea una nueva transacción. |
Una vez que recibas la notificación, tendrás que obtener detalles del recurso haciendo la siguiente solicitud:
curl --request GET 'https://api.belvo.com/payments/br/{resource}/{id}/' \
-u SECRET_ID:SECRET_PASSWORD \Donde:
resourcees el tipo de recurso que deseas recuperar (bank-accounts,charges,customers,payment-intents, otransactions).ides elobject_iddel recurso (que recibes en el evento del webhook).
Para la tabla completa de todos los valores de status_reason_code y sus mensajes correspondientes, consulte Códigos y Mensajes de Pagos Brasil. La tabla a continuación muestra un subconjunto de códigos comunes que pueden aparecer en notificaciones de webhook.
A continuación se muestra una lista de códigos de razón de estado comunes y mensajes que puedes recibir en notificaciones de webhook V1:
| Código de Razón de Estado | Mensaje de Razón de Estado | Cuándo puede ocurrir |
|---|---|---|
AMOUNT_OVER_LIMIT | El monto del pago o el número de pagos excede los límites establecidos por la institución. | Actualización de Estado |
AUTHORIZATION_EXPIRED | El tiempo de autorización ha expirado. | Actualización de Estado |
CONSENT_PENDING_AUTHORIZATION | Consentimiento pendiente de autorización de múltiples niveles (estado 'PARTIALLY_ACCEPTED')." | Actualización de Estado |
HOLDER_INFRASTRUCTURE_FAILURE | Hubo una falla en la infraestructura del titular de la cuenta. | Actualización de Estado |
ICP_INFRASTRUCTURE_FAILURE | Hubo una falla en la infraestructura de ICP (Infraestructura de Claves Públicas).") | Actualización de Estado |
INSUFFICIENT_FUNDS | La cuenta no tiene fondos suficientes para realizar el pago. | Actualización de Estado |
INVALID_CHARGE | El cargo es inválido o incorrecto. | Actualización de Estado |
INVALID_PAYMENT_DETAIL | Los detalles del pago proporcionados son inválidos. | Actualización de Estado |
NOT_INFORMED | No se proporcionó una razón de error por parte de la institución. | En Creación |
PAYMENT_CONSENT_MISMATCH | Los detalles del pago no coinciden con el consentimiento proporcionado. | En Creación |
PAYMENT_REFUSED_BY_HOLDER | El pago fue rechazado por el titular de la cuenta. | En Creación, Actualización de Estado |
PAYMENT_REFUSED_BY_SPI | El pago fue rechazado por el SPI (Sistema de Pagos Instantáneos). | Actualización de Estado |
PAYMENT_SCHEDULING_FAILURE | Hubo una falla al programar el pago. | Actualización de Estado |
RECEIVING_PSP_INFRASTRUCTURE_FAILURE | Hubo una falla en la infraestructura del PSP receptor (Proveedor de Servicios de Pago). | Actualización de Estado |
SAME_ORIGIN_DESTINATION_ACCOUNTS | Las cuentas de origen y destino son las mismas. | Actualización de Estado |
SPI_INFRASTRUCTURE_FAILURE | Hubo una falla en la infraestructura del SPI. | Actualización de Estado |
SPI_REJECTED_PAYMENT | Pago rechazado en el Sistema de Pagos Instantáneos (SPI). | Actualización de Estado |
USER_REJECTED | El usuario rechazó la autorización del consentimiento. | Actualización de Estado |