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.
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.
El link.id para el que deseas recuperar información.
Las categorías de los ingresos para las que deseas obtener información.
El nivel de confianza mínimo de los ingresos para los que deseas obtener información.
Puedes enviar uno de los siguientes valores:
HIGHMEDIUMLOW
La fecha desde la cual deseas comenzar a obtener datos, en formato YYYY-MM-DD.
⚠️ El valor de date_from no puede ser mayor que date_to.
La fecha en la que deseas dejar de recibir datos, en formato YYYY-MM-DD.
⚠️ El valor de date_to no puede ser mayor que la fecha de hoy (en otras palabras, no se permiten fechas futuras).
El token MFA generado por la institución que se requiere para continuar una sesión.
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/incomes/
- Sandbox
https://sandbox.belvo.com/api/incomes/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/incomes/?omit=string&fields=string' \
-H 'Content-Type: application/json' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"allowed_income_types": [
"SALARY"
],
"minimum_confidence_level": "HIGH",
"date_from": "2020-08-05",
"date_to": "2020-10-05",
"token": "1234ab",
"save_data": true
}'Ok (cuando save_data=false)
Identificador único de Belvo para el elemento actual.
El link.id al que pertenecen los datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
Una matriz de objetos de flujo de ingresos enriquecidos.
ID único para la cuenta bancaria que se verificará para flujos de ingresos.
El tipo de ingreso utilizado en los cálculos.
Devolvemos uno de los siguientes valores de enum:
SALARYGOVERNMENTINTERESTRENTRETIREMENTFREELANCEALTERNATIVE_INCOMETRANSFERDEPOSITUNKNOWN
Con qué frecuencia se recibe el ingreso.
Devolvemos uno de los siguientes valores de enum:
MONTHLY- Para transacciones que ocurren una vez al mes.FORTNIGHTLY- Para transacciones que ocurren una vez cada dos semanas.WEEKLY- Para transacciones que ocurren una vez por semana.IRREGULAR- Para transacciones que no ocurren con un patrón de frecuencia definido.SINGLE- Para transacciones que ocurren solo una vez y no se repiten.
La cantidad promedio de ingresos recibidos de la fuente durante periods_with_income.
La cantidad mediana de ingresos recibidos de la fuente durante un mes natural.
El monto promedio de transacción de ingresos de la fuente.
El monto del ingreso más reciente recibido de la fuente.
El código de moneda de tres letras del ingreso. Por ejemplo:
• 🇧🇷 BRL (Real Brasileño) • 🇨🇴 COP (Peso Colombiano) • 🇲🇽 MXN (Peso Mexicano)
La descripción del ingreso más reciente del stream.
La fecha en que se recibió el ingreso más reciente del flujo, en formato YYYY-MM-DD.
La estabilidad del ingreso basada en su cantidad, con un rango de 0 a 1, donde 1 representa estabilidad perfecta.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
La regularidad del ingreso se basa en su frecuencia, con un rango de 0 a 1, donde 1 representa una regularidad perfecta.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
La tendencia de ingresos durante un período de tiempo se calcula entre el último ingreso y el primer ingreso recibido, donde:
- un número flotante negativo significa que la tendencia de ingresos está disminuyendo durante el período de tiempo.
- un número flotante positivo significa que la tendencia de ingresos está aumentando durante el período de tiempo.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
Número de unidades de período (basadas en meses móviles) utilizadas para generar conocimientos y cálculos.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de unidades de período (basado en meses móviles) con datos para realizar cálculos.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de unidades de período (basadas en meses móviles) con al menos un ingreso disponible.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de transacciones de ingresos durante los lookback_periods.
El tipo de fuente de la que generamos información sobre ingresos. Devolvemos uno de los siguientes valores de 'enum':
BANK
La fecha en que ocurrió la primera transacción, en formato YYYY-MM-DD.
La fecha en la que ocurrió la última transacción, en formato YYYY-MM-DD.
El mejor día laborable del mes para cobrar al usuario.
Días laborales adicionales que se han identificado como buenos días para cobrar al usuario.
Número de flujos de ingresos totales analizados.
Cantidad promedio de ingresos recibidos por mes en todas las cuentas para el usuario específico.
Cantidad promedio de ingresos regulares (con una frecuencia de MONTHLY, FORTNIGHTLY o WEEKLY) recibidos por mes para el usuario específico.
Monto promedio de ingresos irregulares (con una frecuencia de SINGLE o IRREGULAR) recibidos por mes para el usuario específico.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza LOW.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza MEDIUM.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza HIGH.
Monto total de todos los ingresos recibidos para el usuario específico.
Cantidad total de ingresos regulares (con una frecuencia de MONTHLY, FORTNIGHTLY, WEEKLY) para el usuario específico.
Monto total de ingresos irregulares (con una frecuencia de SINGLE o IRREGULAR) para el usuario específico.
Cantidad total de ingresos para el usuario específico con confianza LOW.
Cantidad total de ingresos para el usuario específico con confianza MEDIUM.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "income_streams": [ { … } ], "income_source_type": "BANK", "first_transaction_date": "2022-06-09", "last_transaction_date": "2023-02-09", "best_working_day_to_charge": 22, "good_working_days_to_charge": [ 17, 7, 2 ], "number_of_income_streams": 1, "monthly_average": 2500, "monthly_average_regular": 2500, "monthly_average_irregular": 0, "monthly_average_low_confidence": 0, "monthly_average_medium_confidence": 0, "monthly_average_high_confidence": 2500, "total_income_amount": 22500, "total_regular_income_amount": 22500, "total_irregular_income_amount": 0, "total_low_confidence": 0, "total_medium_confidence": 0, "total_high_confidence": 22500 }
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.
La sesión que deseas reanudar. Necesitas usar el valor de session que se proporciona en la respuesta 428 Token Required que recibes después de realizar tu solicitud POST.
El token MFA generado por la institución que se requiere para continuar una sesión.
El link.id que deseas reanudar. Debe ser el mismo link.id que recibes en la respuesta 428 Token Required que contiene el ID de session.
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/incomes/
- Sandbox
https://sandbox.belvo.com/api/incomes/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/incomes/?omit=string&fields=string' \
-H 'Content-Type: application/json' \
-d '{
"session": "6e7b283c6efa449c9c028a16b5c249fa",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'Ok (cuando save_data=false)
Identificador único de Belvo para el elemento actual.
El link.id al que pertenecen los datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
Una matriz de objetos de flujo de ingresos enriquecidos.
ID único para la cuenta bancaria que se verificará para flujos de ingresos.
El tipo de ingreso utilizado en los cálculos.
Devolvemos uno de los siguientes valores de enum:
SALARYGOVERNMENTINTERESTRENTRETIREMENTFREELANCEALTERNATIVE_INCOMETRANSFERDEPOSITUNKNOWN
Con qué frecuencia se recibe el ingreso.
Devolvemos uno de los siguientes valores de enum:
MONTHLY- Para transacciones que ocurren una vez al mes.FORTNIGHTLY- Para transacciones que ocurren una vez cada dos semanas.WEEKLY- Para transacciones que ocurren una vez por semana.IRREGULAR- Para transacciones que no ocurren con un patrón de frecuencia definido.SINGLE- Para transacciones que ocurren solo una vez y no se repiten.
La cantidad promedio de ingresos recibidos de la fuente durante periods_with_income.
La cantidad mediana de ingresos recibidos de la fuente durante un mes natural.
El monto promedio de transacción de ingresos de la fuente.
El monto del ingreso más reciente recibido de la fuente.
El código de moneda de tres letras del ingreso. Por ejemplo:
• 🇧🇷 BRL (Real Brasileño) • 🇨🇴 COP (Peso Colombiano) • 🇲🇽 MXN (Peso Mexicano)
La descripción del ingreso más reciente del stream.
La fecha en que se recibió el ingreso más reciente del flujo, en formato YYYY-MM-DD.
La estabilidad del ingreso basada en su cantidad, con un rango de 0 a 1, donde 1 representa estabilidad perfecta.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
La regularidad del ingreso se basa en su frecuencia, con un rango de 0 a 1, donde 1 representa una regularidad perfecta.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
La tendencia de ingresos durante un período de tiempo se calcula entre el último ingreso y el primer ingreso recibido, donde:
- un número flotante negativo significa que la tendencia de ingresos está disminuyendo durante el período de tiempo.
- un número flotante positivo significa que la tendencia de ingresos está aumentando durante el período de tiempo.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
Número de unidades de período (basadas en meses móviles) utilizadas para generar conocimientos y cálculos.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de unidades de período (basado en meses móviles) con datos para realizar cálculos.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de unidades de período (basadas en meses móviles) con al menos un ingreso disponible.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de transacciones de ingresos durante los lookback_periods.
El tipo de fuente de la que generamos información sobre ingresos. Devolvemos uno de los siguientes valores de 'enum':
BANK
La fecha en que ocurrió la primera transacción, en formato YYYY-MM-DD.
La fecha en la que ocurrió la última transacción, en formato YYYY-MM-DD.
El mejor día laborable del mes para cobrar al usuario.
Días laborales adicionales que se han identificado como buenos días para cobrar al usuario.
Número de flujos de ingresos totales analizados.
Cantidad promedio de ingresos recibidos por mes en todas las cuentas para el usuario específico.
Cantidad promedio de ingresos regulares (con una frecuencia de MONTHLY, FORTNIGHTLY o WEEKLY) recibidos por mes para el usuario específico.
Monto promedio de ingresos irregulares (con una frecuencia de SINGLE o IRREGULAR) recibidos por mes para el usuario específico.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza LOW.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza MEDIUM.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza HIGH.
Monto total de todos los ingresos recibidos para el usuario específico.
Cantidad total de ingresos regulares (con una frecuencia de MONTHLY, FORTNIGHTLY, WEEKLY) para el usuario específico.
Monto total de ingresos irregulares (con una frecuencia de SINGLE o IRREGULAR) para el usuario específico.
Cantidad total de ingresos para el usuario específico con confianza LOW.
Cantidad total de ingresos para el usuario específico con confianza MEDIUM.
Cantidad total de ingresos para el usuario específico con confianza HIGH.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "income_streams": [ … ], "income_source_type": "BANK", "first_transaction_date": "2022-06-09", "last_transaction_date": "2023-02-09", "best_working_day_to_charge": 22, "good_working_days_to_charge": [ … ], "number_of_income_streams": 1, "monthly_average": 2500, "monthly_average_regular": 2500, "monthly_average_irregular": 0, "monthly_average_low_confidence": 0, "monthly_average_medium_confidence": 0, "monthly_average_high_confidence": 2500, "total_income_amount": 22500, "total_regular_income_amount": 22500, "total_irregular_income_amount": 0, "total_low_confidence": 0, "total_medium_confidence": 0, "total_high_confidence": 22500 } ]
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/incomes/{id}/
- Sandbox
https://sandbox.belvo.com/api/incomes/{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/incomes/{id}/?omit=string&fields=string'De acuerdo
Identificador único de Belvo para el elemento actual.
El link.id al que pertenecen los datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
Una matriz de objetos de flujo de ingresos enriquecidos.
ID único para la cuenta bancaria que se verificará para flujos de ingresos.
El tipo de ingreso utilizado en los cálculos.
Devolvemos uno de los siguientes valores de enum:
SALARYGOVERNMENTINTERESTRENTRETIREMENTFREELANCEALTERNATIVE_INCOMETRANSFERDEPOSITUNKNOWN
Con qué frecuencia se recibe el ingreso.
Devolvemos uno de los siguientes valores de enum:
MONTHLY- Para transacciones que ocurren una vez al mes.FORTNIGHTLY- Para transacciones que ocurren una vez cada dos semanas.WEEKLY- Para transacciones que ocurren una vez por semana.IRREGULAR- Para transacciones que no ocurren con un patrón de frecuencia definido.SINGLE- Para transacciones que ocurren solo una vez y no se repiten.
La cantidad promedio de ingresos recibidos de la fuente durante periods_with_income.
La cantidad mediana de ingresos recibidos de la fuente durante un mes natural.
El monto promedio de transacción de ingresos de la fuente.
El monto del ingreso más reciente recibido de la fuente.
El código de moneda de tres letras del ingreso. Por ejemplo:
• 🇧🇷 BRL (Real Brasileño) • 🇨🇴 COP (Peso Colombiano) • 🇲🇽 MXN (Peso Mexicano)
La descripción del ingreso más reciente del stream.
La fecha en que se recibió el ingreso más reciente del flujo, en formato YYYY-MM-DD.
La estabilidad del ingreso basada en su cantidad, con un rango de 0 a 1, donde 1 representa estabilidad perfecta.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
La regularidad del ingreso se basa en su frecuencia, con un rango de 0 a 1, donde 1 representa una regularidad perfecta.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
La tendencia de ingresos durante un período de tiempo se calcula entre el último ingreso y el primer ingreso recibido, donde:
- un número flotante negativo significa que la tendencia de ingresos está disminuyendo durante el período de tiempo.
- un número flotante positivo significa que la tendencia de ingresos está aumentando durante el período de tiempo.
Nota: Para transacciones con frequency=SINGLE, este valor devuelve null.
Número de unidades de período (basadas en meses móviles) utilizadas para generar conocimientos y cálculos.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de unidades de período (basado en meses móviles) con datos para realizar cálculos.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de unidades de período (basadas en meses móviles) con al menos un ingreso disponible.
Nota: Un mes móvil es un período de 30 días. Por ejemplo, del 2023-01-15 al 2023-02-15.
Número de transacciones de ingresos durante los lookback_periods.
El tipo de fuente de la que generamos información sobre ingresos. Devolvemos uno de los siguientes valores de 'enum':
BANK
La fecha en que ocurrió la primera transacción, en formato YYYY-MM-DD.
La fecha en la que ocurrió la última transacción, en formato YYYY-MM-DD.
El mejor día laborable del mes para cobrar al usuario.
Días laborales adicionales que se han identificado como buenos días para cobrar al usuario.
Número de flujos de ingresos totales analizados.
Cantidad promedio de ingresos recibidos por mes en todas las cuentas para el usuario específico.
Cantidad promedio de ingresos regulares (con una frecuencia de MONTHLY, FORTNIGHTLY o WEEKLY) recibidos por mes para el usuario específico.
Monto promedio de ingresos irregulares (con una frecuencia de SINGLE o IRREGULAR) recibidos por mes para el usuario específico.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza LOW.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza MEDIUM.
Cantidad promedio de ingresos recibidos por mes para el usuario específico con confianza HIGH.
Monto total de todos los ingresos recibidos para el usuario específico.
Cantidad total de ingresos regulares (con una frecuencia de MONTHLY, FORTNIGHTLY, WEEKLY) para el usuario específico.
Monto total de ingresos irregulares (con una frecuencia de SINGLE o IRREGULAR) para el usuario específico.
Cantidad total de ingresos para el usuario específico con confianza LOW.
Cantidad total de ingresos para el usuario específico con confianza MEDIUM.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "income_streams": [ { … } ], "income_source_type": "BANK", "first_transaction_date": "2022-06-09", "last_transaction_date": "2023-02-09", "best_working_day_to_charge": 22, "good_working_days_to_charge": [ 17, 7, 2 ], "number_of_income_streams": 1, "monthly_average": 2500, "monthly_average_regular": 2500, "monthly_average_irregular": 0, "monthly_average_low_confidence": 0, "monthly_average_medium_confidence": 0, "monthly_average_high_confidence": 2500, "total_income_amount": 22500, "total_regular_income_amount": 22500, "total_irregular_income_amount": 0, "total_low_confidence": 0, "total_medium_confidence": 0, "total_high_confidence": 22500 }
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.
Customers (Brazil)
Un cliente es el pagador que va a transferir fondos a tu cuenta bancaria. Necesitas crear un cliente para recibir pagos entrantes en la cuenta bancaria de tu organización.
Este endpoint admite versionado a nivel de recurso. Al incluir el encabezado X-Belvo-API-Resource-Version: Payments-BR.V2, puedes acceder a los formatos de solicitud y respuesta más recientes (V2). Si no se proporciona el encabezado, se utilizará el formato predeterminado (V1). Consulta la documentación de la API para obtener detalles sobre las diferencias entre versiones.
Bank Accounts (Brazil)
Para recibir pagos entrantes en la cuenta bancaria de su organización, debe registrar las cuentas bancarias (individuales y comerciales) utilizando la API de Pagos de Belvo.
- Las cuentas bancarias individuales deben ser creadas para cada pagador (su cliente).
- Las cuentas bancarias comerciales deben ser creadas para el beneficiario del pago (su organización).
Este endpoint admite el versionado a nivel de recurso. Al incluir el encabezado X-Belvo-API-Resource-Version: Payments-BR.V2, puede acceder a los formatos de solicitud y respuesta más recientes (V2). Si no se proporciona el encabezado, se utilizará el formato predeterminado (V1). Consulte la documentación de la API para obtener detalles sobre las diferencias entre versiones.
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.