Documentación de la API de Belvo (1.222.0)
Alcanza nuevas audiencias y convierte más usuarios conectándote fácil y seguramente a sus datos financieros, entendiendo su comportamiento y habilitando pagos instantáneos con finanzas abiertas. A través de nuestra API, puedes acceder a:
Belvo es una API de banca abierta para América Latina que permite a las empresas acceder a información bancaria y fiscal de manera segura y ágil.
A través de nuestra API, puedes acceder a:
- Información Bancaria en Brasil
- Información Laboral en Brasil
- Información Laboral en México
- Información Fiscal en México
- Información Fiscal en Chile
También puedes usar nuestra API para realizar pagos en:
- Brasil
- México
Si deseas la documentación de respuesta en formato Excel o CSV, por favor descárgalos desde nuestro Repositorio Público de GitHub: Diccionarios de Datos de Belvo Open Finance.
Nuestros archivos EXCEL y CSV están adicionalmente localizados en español y portugués (Brasil).
Disponible para:
- 🟢 Agregación y Enriquecimiento
- ⚪️ Iniciación de Pagos
Usa nuestro entorno Sandbox para construir tu integración. Ofrecemos datos ficticios que imitan casos de uso del mundo real, lo que significa que puedes probar todos los endpoints, usar el widget e implementar webhooks, tal como lo harías con datos reales.
Todo lo que necesitas para comenzar con el entorno Sandbox es obtener tus claves API. Realmente recomendamos que comiences creando tu integración en este entorno.
Disponible para:
- 🟢 Agregación y Enriquecimiento
- 🟢 Iniciación de Pagos
Después de haber probado tu integración en el entorno Sandbox y estar listo para ir en vivo, necesitarás solicitar acceso a nuestro entorno de Producción. Después de solicitar acceso, nuestro equipo de ventas se pondrá en contacto contigo para programar una reunión solo para asegurarse de que se cumplan tus necesidades, y luego solo necesitarás pasar por un proceso de certificación con uno de nuestros ingenieros para asegurarte de que tu integración esté funcionando de manera óptima. Para prepararte para la reunión de certificación, solo sigue nuestra lista de verificación de integración.
Una vez que tu integración esté certificada, todo lo que necesitarás hacer es:
- Solicitar claves API de Producción (y cambiar tus claves API de Sandbox en el código por estas nuevas).
- Cambiar la URL base a la que haces solicitudes de
sandbox.belvo.comaapi.belvo.com. - Si estás usando webhooks, asegúrate de establecer una URL de Producción para tus webhooks.
Usamos el siguiente código de estado HTTP en la respuesta dependiendo del éxito o fracaso:
| Código de Estado | Descripción |
|---|---|
200 | ✅ Éxito - El contenido está disponible en el cuerpo de la respuesta. |
201 | ✅ Éxito - El contenido fue creado exitosamente en Belvo. |
204 | ✅ Éxito - No hay contenido para devolver. |
400 | ❌ Error de Solicitud Incorrecta - La solicitud devolvió un error, detalle en el contenido. |
401 | ❌ No Autorizado - Las credenciales de Belvo proporcionadas no son válidas. |
404 | ❌ No Encontrado - El recurso al que intentas acceder no se puede encontrar. |
405 | ❌ Método No Permitido - El método HTTP que estás usando no es aceptado para este recurso. |
408 | ❌ Tiempo de Solicitud Agotado - La solicitud se agotó y fue terminada por el servidor. |
428 | ❌ Se Requiere Token MFA - La institución requirió un token MFA para conectar. |
500 | ❌ Error Interno del Servidor - El detalle del error está disponible en el cuerpo de la respuesta. |
Los errores de la API de Belvo se devuelven en formato JSON. Por ejemplo, un error podría verse así:
[
{
"request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
"message": "Este campo es obligatorio.",
"code": "required",
"field": "link"
}
]Típicamente, una respuesta de error tendrá los siguientes parámetros:
request_id: un ID único para la solicitud, debes compartirlo con el equipo de soporte de Belvo para investigaciones.message: descripción del error en lenguaje humano.code: un código único para el error. Consulta la tabla a continuación para ver cómo manejar cada código de error.field(opcional): El campo específico en el cuerpo de la solicitud que tiene un problema.
Cuando necesites ayuda con un error específico, incluye el identificador de solicitud (request_id) en tu mensaje al equipo de soporte de Belvo. Esto acelerará las investigaciones y te permitirá volver a funcionar en poco tiempo.
Para una lista completa de errores y cómo solucionarlos, por favor consulta nuestro artículo dedicado Manejo de Errores.
Implementa un retroceso exponencial automatizado de hasta cinco reintentos. Recomendamos usar un intervalo base de tres segundos con un factor de dos. Por ejemplo, el primer reintento debe ser después de tres segundos, el segundo reintento después de seis segundos (2 * 3), el tercer reintento después de 12 segundos (2 * 6), el cuarto reintento después de 24 segundos (2 * 12), y el quinto reintento después de 48 segundos (2 * 24).
No debes reintentar hacer solicitudes si recibes una respuesta 40x, ya que esto es un error del cliente.
La única excepción es el error de "Demasiadas Sesiones", ya que significa que tu usuario final está accediendo a la cuenta desde otro navegador al mismo tiempo. En este caso, por favor implementa la misma política de reintentos que con los errores 50x.
En nuestro esquema, puedes ver que un campo ha sido marcado como deprecated. Esto significa que este campo ya no es mantenido por el equipo de Belvo. Aún puedes recibir datos para este campo dependiendo de la institución, sin embargo, no debes confiar en este campo.
En nuestra especificación de API, verás que algunos parámetros de respuesta tendrán una anotación de required. Según la especificación de OpenAPI, cuando un parámetro de respuesta está marcado como required, esto significa que la clave de respuesta debe ser devuelta. Sin embargo, el valor de ese parámetro de respuesta puede ser null.
📘 Info
En resumen, cualquier parámetro de respuesta marcado como requerido será devuelto por nuestra API, pero el valor puede ser establecido en null.
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/
https://sandbox.belvo.com/
Institutions
Una institución es una entidad de la que Belvo puede acceder a información. Puede ser una:
- institución bancaria, como Nubank Brasil.
- institución fiscal, como el Servicio de Administración Tributaria (SAT) en México.
- institución de empleo, como el Instituto Mexicano del Seguro Social (IMSS) en México o el Instituto Nacional do Seguro Social (INSS) en Brasil.
Links
Un Link es un conjunto de credenciales asociadas al acceso de un usuario final a una institución. Necesitarás registrar un Link antes de acceder a la información de ese usuario final específico, como los detalles de cuenta o transacciones.
Recomendamos usar el Belvo Hosted Widget para gestionar el proceso de conexión.
Owners
Un owner representa a la persona que tiene acceso a un Link y es el propietario de todas las cuentas dentro del Link.
Puedes usar este endpoint para obtener información útil sobre tu cliente, como:
- su nombre completo
- información de contacto clave
- información sobre el documento de identificación que usaron al abrir la cuenta
Accounts
Una cuenta es la representación de una cuenta bancaria dentro de una institución financiera. Un usuario puede tener una o más cuentas en una institución.
Por ejemplo, un usuario (o enlace) puede tener una cuenta corriente, varias tarjetas de crédito y una cuenta de préstamo.
Consultar la información de la cuenta de un usuario es útil ya que puedes obtener información sobre:
- qué tipos de cuentas tiene el usuario.
- el saldo de cada cuenta (ahorros, cuenta corriente, tarjeta de crédito, préstamo, etc.).
- información detallada sobre sus gastos con tarjeta de crédito.
- la situación actual de cualquier préstamo que puedan tener.
Employments Brazil
Nuestro recurso de empleos para Brasil te permite obtener una vista completa del historial laboral actual de tu usuario y la información salarial.
Para cada usuario, proporcionamos:
- historial laboral (incluyendo ocupaciones y datos del empleador)
- información salarial histórica y actual (por empleador)
En este momento, el recurso de empleos está disponible para:
- 🇧🇷 Brasil (INSS)
Employment Records Mexico
Nuestro recurso de registros de empleo para México te permite obtener una visión completa de las contribuciones actuales al seguro social y el historial laboral de tu usuario.
Con el recurso de registros de empleo de Belvo para México, puedes acceder a información sobre las contribuciones actuales al seguro social y el historial laboral de tu usuario. Para cada usuario, proporcionamos:
- datos personales
- historial laboral
- salario base diario histórico y actual
- ¡y más!
En este momento, el recurso de registros de empleo está disponible para:
- 🇲🇽 México (IMSS)
- 🇲🇽 México (ISSSTE)
Current Employments Mexico
El recurso de Empleos Actuales proporciona acceso en tiempo real al estado de empleo actual de individuos en México. Este recurso ofrece información detallada sobre si una persona está actualmente empleada o desempleada, junto con sus registros de empleo activos.
Incomes
Utiliza el endpoint de Incomes para obtener información sobre las fuentes de ingresos de una cuenta en los últimos 365 días. Este endpoint es particularmente útil cuando deseas verificar los ingresos de una persona.
📘 Información
El recurso de incomes está solo disponible para cuentas de Checking y Savings asociadas con enlaces bancarios.
Recurring Expenses
La API de Gastos Recurrentes de Belvo te permite identificar los pagos regulares de un usuario para servicios de suscripción, como Netflix o membresías de gimnasio, así como pagos de servicios públicos, como facturas de electricidad o teléfono. Devolvemos información de hasta 365 días.
📘 Info
El recurso de gastos recurrentes está solo disponible para cuentas de Cheques, Ahorros y Tarjetas de Crédito asociadas con enlaces bancarios.
Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/recurring-expenses/{id}/
- Sandbox
https://sandbox.belvo.com/api/recurring-expenses/{id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/recurring-expenses/{id}/?omit=string&fields=string'De acuerdo
Identificador único de Belvo para el elemento actual.
Detalles sobre la cuenta.
Nota: Para nuestro recurso de gastos recurrentes, esta cuenta se refiere a la cuenta que fue analizada para generar el informe de gastos recurrentes.
Identificador único de Belvo para el elemento actual.
El link.id al que pertenecen los datos.
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
El tipo de cuenta.
Devolvemos uno de los siguientes valores del enum:
CHECKING_ACCOUNTCREDIT_CARDINVESTMENT_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZEDnull
Indica si esta cuenta es un ASSET o un LIABILITY. Puedes considerar el saldo de un ASSET como positivo, mientras que el saldo de un LIABILITY como negativo.
El tipo de cuenta, según lo designado por la institución.
El nombre de la cuenta, tal como lo proporciona la institución.
El número de cuenta, según lo designado por la institución.
Detalles sobre los saldos actual y disponible de la cuenta.
El saldo actual se calcula de manera diferente según el tipo de cuenta.
- 💰 Cuentas corrientes y de ahorro:
El saldo de la cuenta del usuario en el momento del timestamp collected_at.
- 💳 Tarjetas de crédito:
La cantidad que el usuario ha gastado en el período de facturación actual de la tarjeta (consulte credit_data.cutting_date para obtener información sobre cuándo finaliza el período de facturación actual).
- 🏡 Cuentas de préstamo:
La cantidad restante por pagar en el préstamo del usuario.
El saldo que el propietario de la cuenta puede utilizar.
- 💰 Cuentas corrientes y de ahorro:
El saldo disponible puede ser diferente al saldo current debido a transacciones pendientes.
- 💳 Tarjetas de crédito:
El monto de crédito que el usuario aún tiene disponible para el período actual. El saldo available puede ser diferente al saldo current debido a transacciones pendientes o cuotas futuras.
- 🏡 Cuentas de préstamo:
El valor presente requerido para liquidar el préstamo, según lo proporcionado por la institución.
Nota: Si la institución no proporciona este valor, devolvemos null.
La moneda de la cuenta. Por ejemplo:
- 🇧🇷 BRL (Real Brasileño)
- 🇨🇴 COP (Peso Colombiano)
- 🇲🇽 MXN (Peso Mexicano)
Tenga en cuenta que pueden devolverse otras monedas además de las enumeradas anteriormente.
El nombre público para el tipo de identificación. Por ejemplo: "CLABE".
ℹ️ Para cuentas de ahorro y cheques en 🇧🇷 Brasil, este campo será AGENCY/ACCOUNT.
El valor para el public_identification_name.
ℹ️ Para cuentas de ahorro y corrientes en 🇧🇷 Brasil, este campo será el número de agencia y cuenta bancaria, separados por una barra. Por ejemplo: 0444/45722-0.
La marca de tiempo ISO-8601 del acceso más reciente y exitoso de Belvo a la institución para el enlace dado.
Las opciones de crédito asociadas con esta cuenta.
La cantidad máxima de crédito que el propietario puede recibir.
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
La fecha de cierre del período de crédito, en formato YYYY-MM-DD.
La fecha de vencimiento para el próximo pago, en formato YYYY-MM-DD.
El monto mínimo a pagar en la next_payment_date.
La cantidad mínima requerida para pagar y evitar generar intereses.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.
El pago mensual recurrente, si corresponde.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.
La fecha en que se realizó el último pago de crédito, en formato YYYY-MM-DD.
Las opciones de préstamo asociadas con esta cuenta.
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
El monto total inicial del préstamo, calculado por la institución, cuando se firmó el contrato. Este monto incluye el principal + intereses + impuestos + tarifas.
Monto total del préstamo (la cantidad que el usuario recibe).
El día del mes en el que el propietario necesita pagar el préstamo (DD).
Monto pendiente del préstamo, es decir, cuánto queda por pagar del principal (sin incluir intereses).
El monto restante a pagar en total, incluidos los intereses.
El pago mensual recurrente, si corresponde.
Desglose del interés aplicado al préstamo.
El nombre del tipo de tasa de interés aplicada al préstamo.
El período en el que se aplica el interés al préstamo. Devolvemos uno de los siguientes valores:
MONTHLYYEARLY
El número total de cuotas necesarias para pagar el préstamo.
El número de cuotas restantes por pagar.
La fecha en que se firmó el contrato de préstamo, en formato YYYY-MM-DD.
La fecha en la que se espera que el préstamo se complete, en formato YYYY-MM-DD.
El número de contrato del préstamo, tal como lo proporciona la institución.
Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.
Por favor, consulte principal en su lugar.
Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.
Por favor, consulte outstanding_balance en su lugar.
Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.
Por favor, consulte el objeto interest_rates en su lugar.
Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de campos obsoletos.
Por favor, consulte payment_day en su lugar.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulte nuestra explicación de campos desaprobados.
El día de cierre del mes para el préstamo.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.
La fecha de cierre del período del préstamo, en formato YYYY-MM-DD.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.
La fecha en que se realizó el último pago del préstamo, en formato YYYY-MM-DD.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulte nuestra explicación de Campos desaprobados.
Por favor, use payment_day en su lugar, en formato YYYY-MM-DD.
Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.
El ID de producto de la institución para el tipo de cuenta.
El nombre para el gasto recurrente.
ℹ️ Nota: Esta información se toma de la sección de descripción de una transacción y luego se normaliza para proporcionarte un nombre fácil de leer. Por lo tanto, a veces el nombre reflejará el comerciante al que se realiza el pago (por ejemplo, Netflix.com), mientras que para otros gastos recurrentes, podría ser algo como "Pago mensual a John".
Un array de objetos de transacción minificados se utiliza para evaluar el gasto recurrente. Si no se encuentran transacciones, devolvemos un array vacío.
La descripción de la transacción proporcionada por la institución. Por lo general, este es el texto que el usuario final vería en el estado de cuenta bancario. La descripción puede ser una cadena vacía.
Nota: Para EYOD Risk Insights, la descripción es la que proporcionaste en la solicitud inicial.
La frecuencia con la que ocurre este gasto recurrente.
ℹ️ Nota: Belvo solo identifica frecuencias MONTHLY.
El monto promedio de la transacción del gasto recurrente.
El monto medio de la transacción del gasto recurrente.
Número de días desde que ocurrió el último gasto recurrente.
Según la frecuencia, puedes inferir cuántos días faltan para que ocurra el próximo cargo.
La categoría de transacción para el gasto recurrente. Para obtener más información sobre las categorías disponibles, consulte nuestra documentación de categorización de transacciones.
Online Platforms & Leisure(Netflix, Spotify, Membresías de gimnasio)Bills & Utilities(electricidad, teléfono, internet)Credits & Loans(adelantos en efectivo de tarjetas de crédito, préstamo estudiantil, arrendamiento de embarcaciones)Insurance(seguro de hogar, automóvil, y salud & vida)Transport & Travel(viaje en Uber, airbnb, estacionamiento)Taxes(tarifa de servicio, donación, impuestos judiciales)
El tipo de gasto recurrente. Devolvemos uno de los siguientes valores:
SUBSCRIPTIONREGULAR
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "account": { … }, "name": "Netflix", "transactions": [ … ], "frequency": "MONTHLY", "average_transaction_amount": 32.9, "median_transaction_amount": 32.9, "days_since_last_transaction": 5, "category": "Online Platforms & Leisure", "payment_type": "SUBSCRIPTION" } ]
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/recurring-expenses/{id}/
- Sandbox
https://sandbox.belvo.com/api/recurring-expenses/{id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/recurring-expenses/{id}/'Bank Accounts (Brazil)
Para recibir pagos entrantes en la cuenta bancaria de su organización, debe registrar las cuentas bancarias (individuales y empresariales) utilizando la Payments API de Belvo.
- Las cuentas bancarias individuales deben ser creadas para cada pagador (su cliente).
- Las cuentas bancarias empresariales deben ser creadas para el beneficiario del pago (su organización).
Payment Intents (Brazil)
Un payment intent es un punto único de acceso para crear pagos utilizando cualquier método de pago ofrecido por Belvo.
Un payment intent captura toda la información del pago (como el monto a cobrar, la descripción del pago, el proveedor, etc.) y guía a tus clientes a través del flujo de pago.
Nota: Para las instituciones que requieren el
username_typeen el arrayform_fields, debes enviar este valor en tu solicitud PATCH.