# Documentación de la API de Belvo # Introducción 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: ## Información Disponible y Métodos de Pago 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 ## Diccionarios de Datos 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). ## Entornos Actualmente ofrecemos dos entornos: sandbox y producción. ### Sandbox 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. ### Producción 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.com` a `api.belvo.com`. - [ ] Si estás usando webhooks, asegúrate de establecer una URL de Producción para tus webhooks. ## Códigos de Respuesta 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.| ## Manejo de Errores Los errores de la API de Belvo se devuelven en formato JSON. Por ejemplo, un error podría verse así: ```json [ { "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. ### Identificador de Solicitud 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. ### Códigos de Error y Solución de Problemas Para una lista completa de errores y cómo solucionarlos, por favor consulta nuestro artículo dedicado al Manejo de Errores. ### Política de Reintentos #### Errores 50x 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). #### Errores 40x 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. ## Campos Obsoletos 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. ## OpenAPI: campos requeridos y anulables 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. Version: 1.223.0 ## Servers Sandbox ``` https://sandbox.belvo.com ``` ## Security ### basicAuth Belvo emplea **autenticación básica** utilizando tus claves secretas (puedes encontrar tus claves secretas de API en tu Panel de Control de Belvo, en la sección de **Desarrolladores**). Para autenticarte, necesitas usar tu `secretId` de API como `username` y tu `secretPassword` de API como `password`. Estas credenciales deben ser codificadas en **Base64** e incluidas en el encabezado `Authorization` de tus solicitudes HTTP. Por ejemplo: ```shell curl -X GET https://sandbox.belvo.com/api/ \ -H "Authorization: Basic $(echo -n 'YOUR_SECRET_ID:YOUR_SECRET_PASSWORD' | base64)" ``` Reemplaza `YOUR_SECRET_ID` y `YOUR_SECRET_PASSWORD` con tus credenciales reales. **Nunca expongas tus credenciales en código del lado del cliente o en repositorios públicos**. Type: http Scheme: basic ## Download OpenAPI description [Documentación de la API de Belvo](https://developers.belvo.com/_spec/@l10n/es/apis/BelvoOpenApiSpec.yaml) ## 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. ### Enumerar instituciones - [GET /api/institutions/](https://developers.belvo.com/es/apis/belvoopenapispec/institutions/listinstitutions.md): ## ▶️ Uso Con el método List Institutions, puedes: 1. Listar todas las instituciones disponibles en Belvo. ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de consultas a continuación para ver una lista de campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Obtener los detalles de una institución - [GET /api/institutions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/institutions/detailinstitution.md): Obtén los detalles de una institución específica. ## 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. ### Enumerar enlaces - [GET /api/links/](https://developers.belvo.com/es/apis/belvoopenapispec/links/listlinks.md): ## ▶️ Uso Con el método List Links, puedes: 1. Listar todos los enlaces relacionados con tu cuenta de Belvo (sin usar parámetros de consulta). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Registrar un nuevo enlace - [POST /api/links/](https://developers.belvo.com/es/apis/belvoopenapispec/links/registerlink.md): ## ▶️ Uso Registra un nuevo enlace (una conexión entre tu usuario y su institución) utilizando la API de Belvo. > 👍 Recomendamos encarecidamente usar nuestro Connect Widget para manejar la creación de enlaces y las actualizaciones de estado de los enlaces. Para facilitar las cosas, hemos incluido ejemplos personalizados para los enlaces que puedes crear para cada uno de nuestros productos. Simplemente haz clic en el tipo de enlace que deseas crear en la sección a continuación. ### Completar una solicitud de enlaces - [PATCH /api/links/](https://developers.belvo.com/es/apis/belvoopenapispec/links/patchlinks.md): Se utiliza para reanudar una sesión de registro de Link que se pausó porque la institución requería un token MFA. ### Obtener los detalles de un enlace - [GET /api/links/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/links/detaillink.md): Obtén los detalles de un enlace específico. ### Modificar la recuperación de datos de un enlace - [PATCH /api/links/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/links/modifylinkdataretrieval.md): Modifique la configuración de recuperación de datos para un enlace específico. Actualmente puede: - Cambiar el modo de acceso de un enlace de a o de a . - Modificar el período para el enlace. - Modificar los recursos históricos que desea recuperar para el enlace (). ## Cambiando el de un enlace Cuando cambia un enlace de a , al día siguiente se activa una actualización histórica de los recursos principales para el enlace (lo que resulta en que reciba webhooks de para el enlace). Se le cobrará por estas actualizaciones históricas. ## Modificando Si solo modifica el período para un enlace, esto no activará una actualización histórica. Para activar una actualización histórica para el enlace, debe cambiar el . ## Modificando Si solo modifica los para un enlace, esto no activará una actualización histórica. Para activar una actualización histórica para el enlace, debe cambiar el . ### Actualizar las credenciales de un enlace - [PUT /api/links/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/links/updatelink.md): Actualiza las credenciales de un enlace específico. Si el enlace actualizado con éxito es recurrente, automáticamente activamos una actualización del enlace. Si encontramos datos nuevos, recibirás webhooks de actualización histórica. > 👍 Usa nuestro Connect Widget > > Recomendamos usar nuestro Connect Widget para manejar la actualización de enlaces invalid o token_required. ### Eliminar un enlace - [DELETE /api/links/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/links/destroylink.md): Elimina un enlace específico y todos los datos asociados (por ejemplo: transacciones, cuentas, facturas, declaraciones de impuestos, empleos, etc.) de ese enlace de tu cuenta de Belvo. Esta acción es irreversible y no podrás recuperar los datos eliminados. {% admonition type="success" name="Usa el encabezado X-Belvo-Request-Mode: async" %} Recomendamos encarecidamente establecer el encabezado a para habilitar la eliminación asincrónica. De esta manera, evitarás el límite de tasa de 5 eliminaciones por minuto. Cuando se establece, el endpoint responderá con un estado y proporcionará un ID de solicitud para rastrear el proceso de eliminación. Una vez que el proceso esté completo, recibirás una notificación webhook . Si no configuras este encabezado, el endpoint responderá con un estado , pero estarás sujeto al límite de tasa de 5 eliminaciones por minuto. Si excedes este límite, recibirás un error . {% /admonition %} ### Activar una actualización histórica para un enlace - [POST /api/links/{id}/refresh/](https://developers.belvo.com/es/apis/belvoopenapispec/links/refreshhistoricaldataforlink.md): {% admonition type="warning" name="Límite de Solicitudes Concurrentes" %} Para prevenir solicitudes duplicadas, este endpoint tiene un período de enfriamiento de 10 minutos por enlace. Si intentas actualizar el mismo enlace dentro de los 10 minutos de una solicitud previa, recibirás un error con el mensaje . {% /admonition %} Usa este método para desencadenar una actualización histórica para un enlace específico (único o recurrente). Utiliza el parámetro para especificar qué recursos deseas actualizar. Si no especificas este parámetro, la actualización histórica se realizará para todos los recursos soportados por la institución con la que está asociado el enlace. En una solicitud exitosa, nuestra API responderá con un código de estado y un que podrás usar posteriormente para asociar un webhook de a esta solicitud. {% admonition type="info" name="No actualiza la definición del enlace" %} Este endpoint no actualiza la definición del enlace en sí, solo los datos históricos para los recursos especificados. Si deseas cambiar permanentemente el del enlace, deberías usar el método en su lugar. {% /admonition %} ## Widget Access Token ### Generar un token de acceso para el widget - [POST /api/token/](https://developers.belvo.com/es/apis/belvoopenapispec/widget-access-token/generatewidgetaccesstoken.md): Generar un token de acceso para el widget de OFDA o el widget de Banking Aggregation. ## Consents Un consentimiento es un permiso otorgado por el usuario final para acceder a sus datos financieros en la Red de Finanzas Abiertas en Brasil. ### Listar consentimientos - [GET /api/consents/](https://developers.belvo.com/es/apis/belvoopenapispec/consents/listconsents.md): ## ▶️ Uso Con el método Consents, puedes: 1. Listar todos los consentimientos relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas. ### Obtener los detalles de un consentimiento - [GET /api/consents/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/consents/detailconsent.md): Obtén los detalles de un consentimiento específico. ## 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 ### Lista de propietarios - [GET /api/owners/](https://developers.belvo.com/es/apis/belvoopenapispec/owners/listowners.md): ## ▶️ Uso Con el método List Owners, puedes: 1. Listar propietarios relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los propietarios relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver una lista de campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas. ## 🚨 Campos Obsoletos Este recurso puede devolver campos obsoletos. En la documentación de la respuesta, puedes ver que un campo ha sido marcado como . 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 deberías depender de este campo. ### Recuperar propietarios de un enlace - [POST /api/owners/](https://developers.belvo.com/es/apis/belvoopenapispec/owners/retrieveowners.md): Recuperar información del propietario desde un enlace específico. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información. {% /admonition %} ### Completar una solicitud del propietario - [PATCH /api/owners/](https://developers.belvo.com/es/apis/belvoopenapispec/owners/patchowners.md): Se utiliza para reanudar una sesión de recuperación de Owner que se pausó porque la institución requería un token MFA. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información. {% /admonition %} ### Obtener los detalles de un propietario - [GET /api/owners/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/owners/detailowner.md): Obtener los detalles de un propietario específico. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información. {% /admonition %} ### Eliminar un propietario - [DELETE /api/owners/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/owners/destroyowner.md): Eliminar un propietario específico de tu cuenta de Belvo. ## 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. ### Listar cuentas - [GET /api/accounts/](https://developers.belvo.com/es/apis/belvoopenapispec/accounts/listaccounts.md): ## ▶️ Uso Con el método List Accounts, puedes: 1. Listar cuentas relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las cuentas relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver por cuáles puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🚨 Campos Obsoletos Este recurso puede devolver campos obsoletos. En la documentación de la respuesta, puedes ver que un campo ha sido marcado como . 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 deberías depender de este campo. ### Recuperar cuentas para un enlace - [POST /api/accounts/](https://developers.belvo.com/es/apis/belvoopenapispec/accounts/retrieveaccounts.md): Recuperar cuentas de un enlace existente. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información. {% /admonition %} ### Completar una solicitud de cuentas - [PATCH /api/accounts/](https://developers.belvo.com/es/apis/belvoopenapispec/accounts/patchaccounts.md): Se utiliza para reanudar una sesión de recuperación de Cuenta que se pausó porque la institución requirió un token MFA. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información. {% /admonition %} ### Obtener los detalles de una cuenta - [GET /api/accounts/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/accounts/detailaccount.md): Obtener los detalles de una cuenta específica. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información. {% /admonition %} ### Eliminar una cuenta - [DELETE /api/accounts/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/accounts/destroyaccount.md): Eliminar una cuenta específica de tu cuenta de Belvo. {% admonition type="danger" name="Rate Limited" %} Este endpoint tiene un límite de tasa. Solo puedes eliminar 5 elementos por minuto. Si excedes este límite, recibirás un código de estado . {% /admonition %} {% admonition type="info" %} Cuando eliminas una cuenta, todas las transacciones asociadas y la información del propietario para esa cuenta también se eliminan. {% /admonition %} ## Balances Un saldo es la cantidad de dinero disponible en una cuenta bancaria determinada (corriente o de ahorros) en un momento dado. ### Listar saldos - [GET /api/br/balances/](https://developers.belvo.com/es/apis/belvoopenapispec/balances/listbalances.md): ## ▶️ Uso Con el método List Balances, puedes: 1. Listar saldos relacionados con un específico (usando el parámetro de consulta ). 2. Listar saldos relacionados con un y un específicos (usando los parámetros de consulta y ). 3. Obtener los detalles de un específico (usando el parámetro de consulta ). ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🚨 Campos Obsoletos Este recurso puede devolver campos obsoletos. En la documentación de la respuesta, puedes ver que un campo ha sido marcado como . 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 deberías depender de este campo. ### Recuperar el saldo actual de un enlace - [POST /api/br/balances/](https://developers.belvo.com/es/apis/belvoopenapispec/balances/retrievebalances.md): Recupere el saldo actual de todas las cuentas corrientes y de ahorros para un enlace existente. Recomendamos también enviar el para que reciba los saldos de una cuenta específica. ### Obtener los detalles de un balance - [GET /api/br/balances/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/balances/detailbalance.md): Obtén los detalles de un saldo específico. ## Transactions Una **transacción** contiene la información detallada de cada movimiento dentro de una cuenta. Por ejemplo, una compra en una tienda o un restaurante. ### Listar transacciones - [GET /api/transactions/](https://developers.belvo.com/es/apis/belvoopenapispec/transactions/listtransactions.md): ## ▶️ Uso Con el método List Transactions, puedes: 1. Listar transacciones relacionadas con un específico (usando el parámetro de consulta ). 2. Filtrar las transacciones devueltas usando parámetros de consulta (ver la sección de Filtrado de respuestas a continuación). 3. Obtener los detalles de un específico (usando el parámetro de consulta junto con el parámetro de consulta ). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver por cuáles puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar transacciones para un enlace - [POST /api/transactions/](https://developers.belvo.com/es/apis/belvoopenapispec/transactions/retrievetransactions.md): Recuperar transacciones para una o más cuentas desde un enlace específico. > 📘 Períodos de Transacciones y Recuperación > > Al recuperar transacciones, es importante entender que los rangos de datos de transacciones disponibles dependen de cada institución. Si intentas acceder a información más antigua de la que podemos acceder, devolveremos todos los datos que podamos leer dentro de ese rango de fechas. Por ejemplo, si solicitas transacciones del último año y solo podemos acceder a los últimos seis meses, devolveremos la información correspondiente a estos seis meses de datos. ### Completar una solicitud de transacciones - [PATCH /api/transactions/](https://developers.belvo.com/es/apis/belvoopenapispec/transactions/patchtransactions.md): Se utiliza para reanudar una sesión de recuperación de Transacción que se pausó porque la institución requería un token MFA. ### Obtener los detalles de una transacción - [GET /api/transactions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/transactions/detailtransaction.md): Obtén los detalles de una transacción específica. ### Eliminar una transacción - [DELETE /api/transactions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/transactions/destroytransaction.md): Eliminar una transacción específica de tu cuenta de Belvo. > ❗️ Límite de tasa > > Este endpoint tiene un límite de tasa. Solo puedes eliminar 5 elementos por minuto. Si excedes este límite, recibirás un código de estado . ## Bills Una **bill** se refiere a la factura de la tarjeta de crédito que un usuario recibe para una cuenta determinada. ### Listar facturas - [GET /api/bills/](https://developers.belvo.com/es/apis/belvoopenapispec/bills/listbills.md): ## ▶️ Uso Con el método List Bills, puedes: 1. Listar facturas relacionadas con un link.id específico (usando el parámetro de consulta ). 2. Filtrar las facturas devueltas usando parámetros de consulta (ver la sección de Filtrado de respuestas a continuación). 3. Obtener los detalles de una factura específica usando el parámetro de consulta . ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar facturas para un enlace - [POST /api/bills/](https://developers.belvo.com/es/apis/belvoopenapispec/bills/retrievebills.md): Recuperar facturas de una o más cuentas para un enlace específico dentro de un rango de fechas especificado. ### Obtener los detalles de una factura - [GET /api/bills/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/bills/detailbills.md): Obtener los detalles de una factura específica. ### Eliminar una factura - [DELETE /api/bills/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/bills/destroybills.md): Eliminar una factura específica de tu cuenta de Belvo. ## Investments Brazil ### Lista de inversiones - [GET /api/br/investments/](https://developers.belvo.com/es/apis/belvoopenapispec/investments-brazil/listinvestmentsbrazil.md): ## ▶️ Uso Con el método List Investments, puedes: 1. Listar inversiones relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas. ### Recuperar inversiones para un enlace - [POST /api/br/investments/](https://developers.belvo.com/es/apis/belvoopenapispec/investments-brazil/retrieveinvestmentsbrazil.md): Recuperar inversiones para un enlace existente. ### Obtener los detalles de una inversión - [GET /api/br/investments/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/investments-brazil/detailinvestmentbrazil.md): Obtén los detalles de una inversión específica. ### Eliminar una inversión - [DELETE /api/br/investments/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/investments-brazil/destroyinvestmentbrazil.md): Elimina una inversión específica de tu cuenta de Belvo. ## Investment Transactions Brazil ### Listar transacciones de inversión - [GET /api/br/investment-transactions/](https://developers.belvo.com/es/apis/belvoopenapispec/investment-transactions-brazil/listinvestmenttransactionsbrazil.md): ## ▶️ Uso Con el método List Investment Transactions, puedes: 1. Listar transacciones de inversión relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar inversiones para un enlace - [POST /api/br/investment-transactions/](https://developers.belvo.com/es/apis/belvoopenapispec/investment-transactions-brazil/retrieveinvestmenttransactionsbrazil.md): Recuperar inversiones para un enlace existente. ### Obtener los detalles de una transacción de inversión - [GET /api/br/investment-transactions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/investment-transactions-brazil/detailinvestmenttransactionbrazil.md): Obtén los detalles de una transacción de inversión específica. ### Eliminar una transacción de inversión - [DELETE /api/br/investment-transactions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/investment-transactions-brazil/destroyinvestmenttransactionbrazil.md): Eliminar una transacción de inversión específica de tu cuenta de Belvo. ## 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) ### Lista de empleos - [GET /api/br/employments/](https://developers.belvo.com/es/apis/belvoopenapispec/employments-brazil/listemploymentsbrazil.md): ## ▶️ Uso Con el método List Employments, puedes: 1. Listar empleos relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar empleos para un enlace - [POST /api/br/employments/](https://developers.belvo.com/es/apis/belvoopenapispec/employments-brazil/retrieveemploymentsbrazil.md): Recuperar empleos de un enlace existente. ### Obtener los detalles de un empleo - [GET /api/br/employments/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/employments-brazil/detailemploymentbrazil.md): Obtén los detalles de un empleo específico. ### Eliminar un empleo - [DELETE /api/br/employments/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/employments-brazil/destroyemploymentbrazil.md): Eliminar un empleo específico de tu cuenta de Belvo. ## 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) ### Listar registros de empleo - [GET /api/employment-records/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-records-mexico/listemploymentrecords.md): ## ▶️ Uso Con el método List Employment Records, puedes: 1. Listar registros de empleo relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los registros de empleo relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar detalles del registro de empleo - [POST /api/employment-records/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-records-mexico/retrieveemploymentrecorddetails.md): Recuperar los detalles del registro de empleo de un individuo. ### Obtener los detalles de un registro de empleo - [GET /api/employment-records/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-records-mexico/detailemploymentrecord.md): Obtén los detalles de un registro de empleo específico. ### Eliminar un registro de empleo - [DELETE /api/employment-records/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-records-mexico/destroyemploymentrecord.md): Eliminar un registro de empleo específico de tu cuenta de Belvo. > ❗️ Límite de tasa > > Este endpoint tiene un límite de tasa. Solo puedes eliminar 5 elementos por minuto. Si excedes este límite, recibirás un código de estado . ## 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. ## Características Clave - **Estado de Empleo en Tiempo Real**: Obtén información actualizada sobre la situación laboral actual de una persona - **Actual vs Histórico**: A diferencia de los Registros de Empleo, este recurso se centra específicamente en el estado de empleo actual en lugar de los datos históricos de empleo - **Detalles Completos de Empleo**: Cuando está empleado, recibe información detallada que incluye detalles del empleador, información salarial y duración del empleo - **Estado de Desempleo**: Indicación clara cuando una persona está actualmente desempleada Cuando una persona está **empleada**, recibirás: - Datos de identificación personal (nombre, fecha de nacimiento, NSS, CURP) - Estado de empleo actual - Información del empleador (nombre, RFC, ID) - Ubicación del empleo (estado) - Duración del empleo (días empleados) - Información salarial (salario base y mensual) ### Enumere los empleos actuales. - [GET /api/mx/current-employments/](https://developers.belvo.com/es/apis/belvoopenapispec/current-employments-mexico/listcurrentemployments.md): {% admonition type="success" name="¡Próximamente!" %} Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar. {% /admonition %} ## ▶️ Uso Con el método List Current Employments, puedes: 1. Listar los empleos actuales relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los empleos actuales relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver una lista de campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas. ### Recuperar empleos actuales - [POST /api/mx/current-employments/](https://developers.belvo.com/es/apis/belvoopenapispec/current-employments-mexico/retrievecurrentemployments.md): {% admonition type="success" name="¡Próximamente!" %} Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar. {% /admonition %} Recuperar la información de empleo actual para un específico. ### Obtener detalles actuales de empleo - [GET /api/mx/current-employments/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/current-employments-mexico/getcurrentemploymentdetails.md): {% admonition type="success" name="¡Próximamente!" %} Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar. {% /admonition %} Obtén los detalles de un registro de empleo actual específico. ### Eliminar empleo actual - [DELETE /api/mx/current-employments/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/current-employments-mexico/deletecurrentemployment.md): {% admonition type="success" name="¡Próximamente!" %} Este recurso está actualmente en desarrollo y, como tal, ciertos nombres de campos o valores pueden cambiar. {% /admonition %} Elimina un registro de empleo actual específico de tu cuenta de Belvo. ## Invoices ### Listar facturas - [GET /api/invoices/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices/listinvoices.md): ## ▶️ Uso Con el método Listar Facturas, puedes: 1. Listar facturas relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las facturas relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver una lista de campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ## 🚨 Campos Obsoletos Este recurso puede devolver campos obsoletos. En la documentación de la respuesta, puedes ver que un campo ha sido marcado como . 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 deberías depender de este campo. ### Recuperar facturas para un enlace - [POST /api/invoices/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices/retrieveinvoices.md): Recuperar información de la factura desde un enlace fiscal específico. > 📘 Información > > Puedes solicitar hasta año (365 días) de facturas por solicitud. Si necesitas facturas por más de un año, simplemente realiza otra solicitud. > 🚧 Advertencia > > Este recurso puede devolver campos obsoletos. Por favor, consulta la documentación de la respuesta para más información. ### Completar una solicitud de facturas - [PATCH /api/invoices/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices/patchinvoices.md): Se utiliza para reanudar una sesión de recuperación de Factura que se pausó porque la institución requería un token MFA. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información. {% /admonition %} ### Obtener los detalles de una factura - [GET /api/invoices/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices/detailinvoice.md): Obtener los detalles de una factura específica. {% admonition type="info" %} Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información. {% /admonition %} ### Eliminar una factura - [DELETE /api/invoices/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices/destroyinvoice.md): Eliminar una factura específica de tu cuenta de Belvo. ## Tax compliance status ### Enumere los estados de cumplimiento fiscal - [GET /api/tax-compliance-status/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-compliance-status/listtaxcompliancestatus.md): ## ▶️ Uso Con el método Listar Estados de Cumplimiento Fiscal, puedes: 1. Listar los estados de cumplimiento fiscal relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los estados de cumplimiento fiscal relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar los estados de cumplimiento fiscal para un enlace - [POST /api/tax-compliance-status/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-compliance-status/retrievetaxcompliancestatus.md): Recuperar la información del estado de cumplimiento fiscal para un enlace fiscal específico. ### Obtener los detalles del estado de cumplimiento fiscal - [GET /api/tax-compliance-status/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-compliance-status/detailtaxcompliancestatus.md): Obtén los detalles de un estado específico de cumplimiento fiscal. ### Eliminar un estado de cumplimiento fiscal - [DELETE /api/tax-compliance-status/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-compliance-status/destroytaxcompliancestatus.md): Eliminar un estado de cumplimiento fiscal específico de tu cuenta de Belvo. ## Tax returns ### Listar declaraciones de impuestos - [GET /api/tax-returns/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-returns/listtaxreturns.md): ## ▶️ Uso Con el método List Tax Returns, puedes: 1. Listar las declaraciones de impuestos relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las declaraciones de impuestos relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ## 🔔 Múltiples Esquemas Como un enlace puede tener tanto declaraciones de impuestos anuales como mensuales, la respuesta incluirá una mezcla de estos dos tipos de declaraciones de impuestos (y por lo tanto diferentes esquemas). ### Recuperar declaraciones de impuestos para un enlace - [POST /api/tax-returns/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-returns/retrievetaxreturns.md): Recuperar información de la declaración de impuestos para un enlace fiscal específico. ### Obtener los detalles de una declaración de impuestos - [GET /api/tax-returns/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-returns/detailtaxreturn.md): Obtén los detalles de una declaración de impuestos específica. ### Eliminar una declaración de impuestos - [DELETE /api/tax-returns/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-returns/destroytaxreturn.md): Eliminar una declaración de impuestos específica de tu cuenta de Belvo. ## Tax retentions ### Enumera las retenciones fiscales. - [GET /api/tax-retentions/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-retentions/listtaxretentions.md): ## ▶️ Uso Con el método List Tax Retentions, puedes: 1. Listar las retenciones fiscales relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las retenciones fiscales relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar retenciones de impuestos para un enlace - [POST /api/tax-retentions/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-retentions/retrievetaxretentions.md): Recuperar información de retención de impuestos desde un enlace específico. El número máximo de retenciones de impuestos que se pueden devolver para un período es 500. ### Obtener los detalles de una retención de impuestos - [GET /api/tax-retentions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-retentions/detailtaxretentions.md): Obtén los detalles de una retención de impuestos específica. ### Eliminar una retención de impuestos - [DELETE /api/tax-retentions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-retentions/destroytaxretention.md): Elimina una retención de impuestos específica de tu cuenta de Belvo. ## Tax status ### Enumera los estados fiscales - [GET /api/tax-status/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status/listtaxstatus.md): ## ▶️ Uso Con el método Listar Estados Fiscales, puedes: 1. Listar estados fiscales relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los estados fiscales relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar estados fiscales para un enlace - [POST /api/tax-status/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status/retrievetaxstatus.md): Recuperar información sobre el estado fiscal para un enlace fiscal específico. ### Obtener los detalles de un estado fiscal - [GET /api/tax-status/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status/detailtaxstatus.md): Obtén los detalles de un estado fiscal específico. ### Eliminar un estado fiscal - [DELETE /api/tax-status/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status/destroytaxstatus.md): Eliminar un estado fiscal específico de tu cuenta de Belvo. ## Financial Statements ### Lista de Estados Financieros - [GET /api/financial-statements/](https://developers.belvo.com/es/apis/belvoopenapispec/financial-statements/listfinancialstatements.md): ## ▶️ Uso Con el método Listar Estados Financieros, puedes: 1. Listar estados financieros relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los estados financieros relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar estados financieros para un enlace - [POST /api/financial-statements/](https://developers.belvo.com/es/apis/belvoopenapispec/financial-statements/retrievefinancialstatements.md): Recuperar la información de los Estados Financieros para un enlace fiscal específico. ### Obtener los detalles de un Estado Financiero - [GET /api/financial-statements/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/financial-statements/detailfinancialstatement.md): Obtén los detalles de un Estado Financiero específico. ### Eliminar un estado financiero - [DELETE /api/financial-statements/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/financial-statements/destroyfinancialstatement.md): Eliminar un Estado Financiero específico de tu cuenta de Belvo. ## Invoices Chile ### Listar facturas - [GET /api/cl/invoices/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices-chile/listinvoiceschile.md): ## ▶️ Uso Con el método List Invoices, puedes: 1. Listar facturas relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las facturas relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar facturas para un enlace - [POST /api/cl/invoices/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices-chile/retrieveinvoiceschile.md): Recuperar información de facturas desde un enlace fiscal específico de Chile. Puedes solicitar hasta un año (365 días) de facturas por solicitud. Si necesitas facturas por más de un año, simplemente realiza otra solicitud. > 📘 Altamente Recomendado > > Recomendamos encarecidamente que utilices el parámetro de encabezado de Belvo e implementes un flujo de trabajo asincrónico. Esto garantizará que no recibas errores de tiempo de espera al recuperar datos de facturas. ### Obtener los detalles de una factura - [GET /api/cl/invoices/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices-chile/detailinvoicechile.md): Obtén los detalles de una factura específica. ### Eliminar una factura - [DELETE /api/cl/invoices/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/invoices-chile/destroyinvoicechile.md): Eliminar una factura específica de tu cuenta de Belvo. ## Tax Status Chile ### Enumera los estados fiscales - [GET /api/cl/tax-status/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status-chile/listtaxstatuschile.md): ## ▶️ Uso Con el método de Estado Fiscal, puedes: 1. Listar los estados fiscales relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los estados fiscales relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar estados fiscales para un enlace - [POST /api/cl/tax-status/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status-chile/retrievetaxstatuschile.md): Recuperar información sobre el estado fiscal para un enlace fiscal específico. ### Obtener los detalles de un estado fiscal - [GET /api/cl/tax-status/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status-chile/detailtaxstatuschile.md): Obtén los detalles de un estado fiscal específico. ### Eliminar un estado fiscal - [DELETE /api/cl/tax-status/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/tax-status-chile/destroytaxstatuschile.md): Eliminar un estado fiscal específico de tu cuenta de Belvo. ## Debt Reports Chile ### Listar informes de deudas - [GET /api/cl/debt-reports/](https://developers.belvo.com/es/apis/belvoopenapispec/debt-reports-chile/listdebtreportchile.md): ## ▶️ Uso Con el método List Debt Reports, puedes: 1. Listar informes de deuda relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los informes de deuda relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar detalles de deuda para un enlace - [POST /api/cl/debt-reports/](https://developers.belvo.com/es/apis/belvoopenapispec/debt-reports-chile/retrievedebtreportchile.md): Recuperar información de los informes de deuda para un enlace fiscal específico. ### Obtener los detalles de una deuda - [GET /api/cl/debt-reports/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/debt-reports-chile/detaildebtreportchile.md): Obtén los detalles de una deuda específica. ### Eliminar un informe de deuda - [DELETE /api/cl/debt-reports/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/debt-reports-chile/destroydebtreportchile.md): Eliminar un informe de deuda específico de tu cuenta de Belvo. ## 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. ### Enumerar ingresos - [GET /api/incomes/](https://developers.belvo.com/es/apis/belvoopenapispec/incomes/listincomes.md): ## ▶️ Uso Con el método List Incomes, puedes: 1. Listar ingresos relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los ingresos relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar ingresos para un enlace - [POST /api/incomes/](https://developers.belvo.com/es/apis/belvoopenapispec/incomes/retrieveincome.md): Recupera información sobre ingresos para cuentas corrientes y de ahorros desde un enlace específico. Puedes recibir información para un período de hasta 365 días, dependiendo del historial de transacciones disponible para cada institución. ### Completar una solicitud de ingresos - [PATCH /api/incomes/](https://developers.belvo.com/es/apis/belvoopenapispec/incomes/patchincomes.md): Se utiliza para reanudar una sesión de recuperación de ingresos que se pausó porque la institución requería un token MFA. ### Obtener los detalles de un ingreso - [GET /api/incomes/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/incomes/detailincome.md): Obtén los detalles de un ingreso específico. ### Eliminar un ingreso - [DELETE /api/incomes/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/incomes/destroyincomes.md): Elimina un ingreso específico de tu cuenta de Belvo. ## 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. ### Enumera los gastos recurrentes. - [GET /api/recurring-expenses/](https://developers.belvo.com/es/apis/belvoopenapispec/recurring-expenses/listrecurringexpenses.md): ## ▶️ Uso Con el método List Recurring Expenses, puedes: 1. Listar los gastos recurrentes relacionados con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todos los gastos recurrentes relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Por favor, consulta la lista de consultas a continuación para ver una lista de campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar gastos recurrentes para un enlace - [POST /api/recurring-expenses/](https://developers.belvo.com/es/apis/belvoopenapispec/recurring-expenses/retrieverecurringexpenses.md): Recupera información sobre gastos recurrentes para cuentas corrientes y de ahorros desde un enlace específico. Puedes recibir información para un período de hasta 365 días, dependiendo del historial de transacciones disponible para cada institución. ### Completar una solicitud de gastos recurrentes - [PATCH /api/recurring-expenses/](https://developers.belvo.com/es/apis/belvoopenapispec/recurring-expenses/patchrecurringexpenses.md): Se utiliza para reanudar una sesión de recuperación de Gastos Recurrentes que se pausó porque la institución requería un token MFA. ### Obtener los detalles de un gasto recurrente - [GET /api/recurring-expenses/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/recurring-expenses/detailrecurringexpense.md): Obtén los detalles de un gasto recurrente específico. ### Eliminar un gasto recurrente - [DELETE /api/recurring-expenses/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/recurring-expenses/destroyrecurringexpense.md): Eliminar un gasto recurrente específico de tu cuenta de Belvo. ## Risk Insights ### Enumere las perspectivas de riesgo. - [GET /api/risk-insights/](https://developers.belvo.com/es/apis/belvoopenapispec/risk-insights/listriskinsights.md): ## ▶️ Uso Con el método List Risk Insights, puedes: 1. Listar las perspectivas de riesgo relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las perspectivas de riesgo relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar información sobre riesgos para un enlace - [POST /api/risk-insights/](https://developers.belvo.com/es/apis/belvoopenapispec/risk-insights/retrieveriskinsights.md): Solicitar las perspectivas de riesgo para un ID de enlace dado. Si necesitas saber la moneda de la cuenta, simplemente realiza un GET Details en el endpoint de cuentas (usando el ID que recibes de la respuesta de cuentas). ### Completar una solicitud de información sobre riesgos - [PATCH /api/risk-insights/](https://developers.belvo.com/es/apis/belvoopenapispec/risk-insights/patchriskinsights.md): Se utiliza para reanudar una sesión de recuperación de información de riesgos que se pausó porque la institución requería un token MFA. ### Obtener los detalles de una perspectiva de riesgo - [GET /api/risk-insights/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/risk-insights/detailriskinsights.md): Obtén los detalles de una perspectiva de riesgo específica. ### Eliminar una perspectiva de riesgo - [DELETE /api/risk-insights/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/risk-insights/destroyriskinsights.md): Eliminar una percepción de riesgo específica de tu cuenta de Belvo. ## Employment Metrics ### Enumere las métricas de empleo. - [GET /api/employment-metrics/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-metrics/listemploymentmetrics.md): ## ▶️ Uso Con el método List Employment Metrics, puedes: 1. Listar métricas de empleo relacionadas con un específico (usando el parámetro de consulta ). 2. Obtener los detalles de un específico (usando el parámetro de consulta ). 3. Listar todas las métricas de empleo relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ### Recuperar métricas de empleo - [POST /api/employment-metrics/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-metrics/retrieveemploymentmetricdetails.md): Recuperar métricas de empleo para un individuo. > Antes de solicitar métricas de empleo, asegúrate de realizar primero una solicitud POST Retrieve employment record details. ### Obtener los detalles de una métrica de empleo - [GET /api/employment-metrics/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-metrics/detailemploymentmetric.md): Obtén los detalles de una métrica de empleo específica. ### Eliminar una métrica de empleo - [DELETE /api/employment-metrics/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/employment-metrics/destroyemploymentmetric.md): Elimina una métrica de empleo específica de tu cuenta de Belvo. ## Payment Institutions (Brazil) Una **institución de pago** es una entidad de la que Belvo puede acceder a información. Puedes ver una lista completa de instituciones disponibles para pagos haciendo una solicitud de Lista a este endpoint. ### Enumere todas las instituciones de pago. - [GET /payments/br/institutions/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-institutions-(brazil)/listpaymentinstitutionsbrazil.md): Enumere todas las instituciones de pago disponibles. ## 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. {% admonition type="info" name="Versionado de Recursos" %} 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. {% /admonition %} ### Crear un nuevo cliente - [POST /payments/br/customers/](https://developers.belvo.com/es/apis/belvoopenapispec/customers-(brazil)/createcustomerbrazil.md): Cree un nuevo cliente para enviar o solicitar fondos. ### Listar todos los clientes - [GET /payments/br/customers/](https://developers.belvo.com/es/apis/belvoopenapispec/customers-(brazil)/listcustomersbrazil.md): Enumere todos los clientes asociados con su cuenta de Belvo. ### Obtener detalles sobre un cliente - [GET /payments/br/customers/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/customers-(brazil)/detailcustomerbrazil.md): Obtener los detalles sobre un cliente específico ## 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). {% admonition type="info" name="Versionado de Recursos" %} 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. {% /admonition %} ### Registrar una nueva cuenta bancaria - [POST /payments/br/bank-accounts/](https://developers.belvo.com/es/apis/belvoopenapispec/bank-accounts-(brazil)/registerbankaccountbrazil.md): Registrar una nueva cuenta bancaria desde la cual enviar o solicitar fondos. ### Enumere todas las cuentas bancarias. - [GET /payments/br/bank-accounts/](https://developers.belvo.com/es/apis/belvoopenapispec/bank-accounts-(brazil)/listbankaccountbrazil.md): Enumere todas las cuentas bancarias asociadas con su cuenta de Belvo. ### Obtener detalles sobre una cuenta bancaria - [GET /payments/br/bank-accounts/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/bank-accounts-(brazil)/detailbankaccountbrazil.md): Obtener los detalles sobre una cuenta bancaria específica. ## Payment Authorizations (Brazil) Una Autorización de Pago es el consentimiento que tu usuario te da para cargar (debitando dinero de) sus cuentas. Necesitas realizar una Autorización de Pago por cada ‘contrato’ (por ejemplo, si tu empresa maneja tanto electricidad como agua pero se facturan por separado, entonces deberás crear dos Autorizaciones de Pago separadas). Una vez que el usuario confirma la autorización, necesitarás escuchar un webhook `PAYMENT_AUTHORIZATION` con el estado configurado en `AUTHORIZED`. Una vez que recibas este webhook, el proceso de autorización estará completo y podrás cargar a tu usuario. {% admonition type="info" name="¿Qué es un cargo?" %} Un **cargo** representa el pago individual (débito) que tu cliente realizará. {% /admonition %} {% admonition type="danger" name="Encabezado de Versión" %} El recurso de Autorización de Pago requiere que envíes el encabezado `X-Belvo-API-Resource-Version` configurado en `Payments-BR.V2`. {% /admonition %} ### Crear una nueva Autorización de Pago - [POST /payments/br/payment-authorizations/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/createpaymentauthorizationbrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Crear una Autorización de Pago. ### Enumere todas las Autorizaciones de Pago - [GET /payments/br/payment-authorizations/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/listpaymentauthorizationsbrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Lista todas las Autorizaciones de Pago asociadas con tu cuenta de Belvo. ### Obtener detalles sobre una Autorización de Pago - [GET /payments/br/payment-authorizations/{payment_authorization_id}/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/detailpaymentauthorizationbrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Obtén los detalles sobre una Autorización de Pago específica. ### Cancelar una Autorización de Pago - [POST /payments/br/payment-authorizations/{payment_authorization_id}/cancel/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/cancelpaymentauthorizationbrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Cancelar una Autorización de Pago Respondemos con un y te informaremos a través de un webhook que la Autorización de Pago fue cancelada exitosamente. {% admonition type="warning" name="Restricciones de Tiempo para Cancelación" %} El último momento en que puedes cancelar una Autorización de Pago es hasta las 22:00:00 (GMT-3) del día anterior a la fecha del próximo Cargo. Si no cumples con el tiempo límite, la Autorización de Pago será cancelada, . {% /admonition %} ### Crear un nuevo Charge - [POST /payments/br/payment-authorizations/{payment_authorization_id}/charges/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/createpaymentauthorizationchargebrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Crea un nuevo Charge para una Payment Authorization. ### Enumere todos los Cargos para una Autorización de Pago. - [GET /payments/br/payment-authorizations/{payment_authorization_id}/charges/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/listpaymentauthorizationchargesbrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Lista todos los Charges asociados con una Payment Authorization. ### Obtener detalles sobre un Cargo para una Autorización de Pago - [GET /payments/br/payment-authorizations/{payment_authorization_id}/charges/{charge_id}/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/detailpaymentauthorizationchargebrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Obtén los detalles sobre un Cargo específico asociado con una Autorización de Pago. ### Reintentar un Cargo fallido para una Autorización de Pago - [POST /payments/br/payment-authorizations/{payment_authorization_id}/charges/{charge_id}/retry/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/retrypaymentauthorizationchargebrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Reintentar un Cargo fallido para una Autorización de Pago dada. {% admonition type="warning" name="Documentación adicional" %} Por favor, asegúrate de leer la documentación dedicada a Reintentar Cargos y Cargos Vinculados antes de intentar reintentar un cargo. {% /admonition %} ### Cancelar un Cargo programado - [POST /payments/br/payment-authorizations/{payment_authorization_id}/charges/{charge_id}/cancel/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-authorizations-(brazil)/cancelpaymentauthorizationchargebrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA. Como tal, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Cancela un Cargo programado. Respondemos con un y te informaremos a través de un webhook que el cargo fue cancelado exitosamente. {% admonition type="warning" name="Restricción de Tiempo para Cancelación" %} La última hora para cancelar un Cargo programado es a las 22:00:00 (GMT-3) del día anterior a la fecha del Cargo. Si no cumples con el tiempo límite, recibirás un error de API de Belvo y el pago se procesará. {% /admonition %} ## Charges (Brazil) ### Obtener detalles sobre un Charge - [GET /payments/br/charges/{charge_id}/](https://developers.belvo.com/es/apis/belvoopenapispec/charges-(brazil)/detailchargebrazil.md): {% admonition type="warning" name="En BETA" %} Este endpoint está en BETA y es aplicable para . Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} Obtén los detalles sobre un Cargo específico. ## 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_type` en el array `form_fields`, debes enviar este valor en tu solicitud PATCH. ### Crear una nueva intención de pago - [POST /payments/br/payment-intents/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/createpaymentintentbrazil.md): Crear una intención de pago. : Puedes usar este método para crear adicionalmente un cliente y una intención de pago en una sola solicitud (consulta la opción de Cliente e Intención de Pago). ### Enumere todas las intenciones de pago. - [GET /payments/br/payment-intents/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/listpaymentintentsbrazil.md): Enumere todas las intenciones de pago asociadas con su cuenta de Belvo. ### Completar una intención de pago - [PATCH /payments/br/payment-intents/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/patchpaymentintentbrazil.md): Completar una nueva intención de pago. ### Obtener detalles sobre una intención de pago - [GET /payments/br/payment-intents/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/detailpaymentintentbrazil.md): Obtén los detalles sobre una intención de pago específica. ### Cancelar una intención de pago programada - [POST /payments/br/payment-intents/{id}/cancel/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/cancelpaymentintentbrazil.md): Cancelar una intención de pago programada (única). Respondemos con un y te informaremos a través de un webhook que la intención de pago fue cancelada exitosamente. > : El último momento en que puedes cancelar una intención de pago programada es a las del día a la fecha de pago programada. ### Enumere todos los cargos para una intención de pago. - [GET /payments/br/payment-intents/{payment_intent_id}/charges/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/listchargesbrazil.md): Enumere todos los cargos asociados con una intención de pago. ### Obtener detalles sobre un cargo para una intención de pago - [GET /payments/br/payment-intents/{payment_intent_id}/charges/{charge_id}/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/detailchargesbrazil.md): Obtén los detalles sobre un cargo específico asociado con una intención de pago. ### Cancelar un cargo programado - [POST /payments/br/payment-intents/{payment_intent_id}/charges/{charge_id}/cancel/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-intents-(brazil)/cancelchargebrazil.md): Cancelar un cargo programado. Respondemos con un y te informaremos a través de un webhook que el cargo fue cancelado exitosamente. > : La última hora para cancelar un cargo programado es a las del día a la fecha de pago programada. ## Biometric Pix Widget Access Token (Brazil) Utilice las solicitudes de Token del Biometric Pix Widget para crear un token de acceso para Pagos Biométricos. ### Generar un token de acceso para el widget de pago - [POST /payments/br/token/](https://developers.belvo.com/es/apis/belvoopenapispec/biometric-pix-widget-access-token-(brazil)/generatepaymentwidgetaccesstoken.md): Genere un token de acceso para el widget de pago para el proceso de inscripción o pago con Biometric Pix. ## Enrollments (Brazil) ### Registrar un nuevo dispositivo de usuario - [POST /payments/br/enrollments/](https://developers.belvo.com/es/apis/belvoopenapispec/enrollments-(brazil)/createenrollmentbrazil.md): ## ▶️ Uso Con el método , puedes comenzar el proceso de registro de un nuevo dispositivo para permitir pagos con Biometric Pix. > 🚧 Crear un cliente primero > > Antes de poder registrar un dispositivo de usuario, primero debes crear un cliente. ### Listar inscripciones - [GET /payments/br/enrollments/](https://developers.belvo.com/es/apis/belvoopenapispec/enrollments-(brazil)/listenrollmentsbrazil.md): ## ▶️ Uso Con el método List Enrollments, puedes: 1. (Recomendado) Listar inscripciones relacionadas con un CPF específico (usando el parámetro de consulta ). 2. Listar inscripciones relacionadas con un y específicos (usando los parámetros de consulta e ). 3. Listar inscripciones según un estado específico (usando el parámetro de consulta ). 4. Listar todas las inscripciones relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta). ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas. ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. ### Obtener detalles sobre una inscripción - [GET /payments/br/enrollments/{enrollment_id}/](https://developers.belvo.com/es/apis/belvoopenapispec/enrollments-(brazil)/detailenrollmentbrazil.md): Obtener detalles sobre una inscripción de dispositivo específica. ### Completar la inscripción después de la redirección - [POST /payments/br/enrollments/complete-redirection/](https://developers.belvo.com/es/apis/belvoopenapispec/enrollments-(brazil)/completeenrollmentredirectionbrazil.md): ## ▶️ Uso Utilice este endpoint para completar el proceso de inscripción después de que el usuario sea redirigido de vuelta desde la institución. El cuerpo de la solicitud debe coincidir con los parámetros recibidos en la URL de callback, ya sea para un callback exitoso o de error. ## Payment Transactions (Brazil) Cada vez que recibes un pago entrante de tu cliente, se crea una **transacción** en la base de datos de Belvo. Puedes utilizar el recurso de Payment Transactions para obtener información útil sobre una transacción, así como el cargo específico asociado con ella. ### Enumere todas las transacciones de pago. - [GET /payments/br/transactions/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-transactions-(brazil)/listpaymenttransactionsbrazil.md): Enumere todas las transacciones de pago asociadas con su cuenta de Belvo. ### Obtener detalles sobre una transacción de pago - [GET /payments/br/transactions/{id}/](https://developers.belvo.com/es/apis/belvoopenapispec/payment-transactions-(brazil)/detailpaymenttransactionsbrazil.md): Obtén los detalles sobre una transacción de pago específica.