Documentación de la API de Belvo (1.222.0)

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í:

[
    {
      "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 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.

Descargar el archivo de descripción OpenAPI

BelvoOpenApiSpec.json

BelvoOpenApiSpec.yaml

Resumen

URL

https://developers.belvo.com

Need help?

support@belvo.com

Servidores

Mock server

https://developers.belvo.com/_mock/es/apis/belvoopenapispec/

Sandbox

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.

Operaciones

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.

Operaciones

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.

Operaciones

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

Operaciones

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.

Operaciones

Balances

Un saldo es la cantidad de dinero disponible en una cuenta bancaria determinada (corriente o de ahorros) en un momento dado.

Operaciones

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.

Operaciones

Bills

Una bill se refiere a la factura de la tarjeta de crédito que un usuario recibe para una cuenta determinada.

Operaciones

Listar facturas

Solicitud

▶️ Uso

Con el método List Bills, puedes:

[Requerido] Listar facturas relacionadas con un link.id específico (usando el parámetro de consulta link).
Filtrar las facturas devueltas usando parámetros de consulta (ver la sección de Filtrado de respuestas a continuación).
Obtener los detalles de una factura específica usando el parámetro de consulta id.

📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page 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.

Seguridad

basicAuth

Consulta

linkstring(uuid)requerido

El link.id por el que deseas filtrar.

Ejemplo: link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4

page_sizeinteger(int32)[ 1 .. 1000 ]

Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).

Predeterminado 100

Ejemplo: page_size=100

pageinteger(int32)>= 1

Un número de página dentro del conjunto de resultados paginados.

Ejemplo: page=1

omitstring

Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

fieldsstring

Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

idstring(uuid)

Devuelve información solo para este recurso id.

Ejemplo: id=24ccab1d-3a86-4136-a6eb-e04bf52b356f

id__inArray of strings(uuid)

Devuelve información para estos ids de recursos.

Ejemplo: id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6

accountstring(uuid)

El account.id por el que deseas filtrar.

ℹ️ Recomendamos encarecidamente agregar filtros de link.id o account.id para mejorar tu rendimiento.

Ejemplo: account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4

account__inArray of strings(uuid)

Devuelve resultados solo para estos account.ids.

Ejemplo: account__in=85b77707-90ef-46fd-9059-5a757f24247a

due_datestring(date)

Devolver elementos que tienen una due_date en esta fecha (YYYY-MM-DD).

Ejemplo: due_date=2022-05-01

due_date__gtstring(date)

Devolver elementos que tengan una due_date posterior a esta fecha (YYYY-MM-DD).

Ejemplo: due_date__gt=2022-05-05

due_date__gtestring(date)

Devolver elementos que tengan una due_date en o después de esta fecha (YYYY-MM-DD).

Ejemplo: due_date__gte=2022-05-05

due_date__ltstring(date)

Devolver elementos que tengan una due_date anterior a esta fecha (YYYY-MM-DD).

Ejemplo: due_date__lt=2022-05-05

due_date__ltestring(date)

Devolver elementos que tengan una due_date anterior o en esta fecha (YYYY-MM-DD).

Ejemplo: due_date__lte=2022-05-05

due_date__rangeArray of strings(date)<= 2 items

Devolver elementos que tienen una due_date entre dos fechas (YYYY-MM-DD).

Ejemplo: due_date__range=2022-05-04

collected_at__gtstring(date)

Devuelve los elementos que fueron recuperados de la institución después de esta fecha (YYYY-MM-DD o marca de tiempo completa en formato ISO-8601).

Ejemplo: collected_at__gt=2022-05-05

collected_at__gtestring(date)

Devolver los elementos que fueron recuperados de la institución en o después de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).

Ejemplo: collected_at__gte=2022-05-04

collected_at__ltstring(date)

Devolver los elementos que fueron recuperados de la institución antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).

Ejemplo: collected_at__lt=2022-04-01

collected_at__ltestring(date)

Devuelve los elementos que fueron recuperados de la institución en o antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).

Ejemplo: collected_at__lte=2022-03-30

collected_at__rangeArray of strings(date)<= 2 items

Devolver los elementos que fueron recuperados de la institución entre dos fechas (YYYY-MM-DD o una marca de tiempo completa en formato ISO-8601).

Ejemplo: collected_at__range=2022-05-04

created_atstring(date)

Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD).

Ejemplo: created_at=2022-05-05

created_at__gtstring(date)

Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD).

Ejemplo: created_at__gt=2022-05-05

created_at__gtestring(date)

Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD).

Ejemplo: created_at__gte=2022-05-04

created_at__ltstring(date)

Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD).

Ejemplo: created_at__lt=2022-04-01

created_at__ltestring(date)

Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD).

Ejemplo: created_at__lte=2022-03-30

created_at__rangeArray of strings(date)<= 2 items

Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD).

Ejemplo: created_at__range=2022-03-03

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/bills/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&account__in=85b77707-90ef-46fd-9059-5a757f24247a&due_date=2022-05-01&due_date__gt=2022-05-05&due_date__gte=2022-05-05&due_date__lt=2022-05-05&due_date__lte=2022-05-05&due_date__range=2022-05-04&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03'

Respuestas

De acuerdo

Cuerpoapplication/json

countinteger(int32)

El número total de resultados en tu cuenta de Belvo.

Ejemplo: 130

nextstring or null(uri)

La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).

Ejemplo: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

previousstring or null(uri)

La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

Ejemplo: null

resultsArray of objects

Un array de objetos Bill.

Respuesta

application/json

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "previous": null,
  "results": [
    { … }
  ]
}

Recuperar facturas para un enlace

Solicitud

Recuperar facturas de una o más cuentas para un enlace específico dentro de un rango de fechas especificado.

Seguridad

basicAuth

Consulta

omitstring

Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

fieldsstring

Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

Cuerpoapplication/jsonrequerido

linkstring(uuid)requerido

El link.id para el que deseas recuperar información.

Ejemplo: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

save_databoolean

Indica si se debe o no persistir los datos en Belvo. Por defecto, esto está configurado en true y devolvemos una respuesta 201 Created.

Cuando se establece en false, los datos no se persistirán y devolvemos una respuesta 200 OK.

Predeterminado true

Ejemplo: true

curl -i -X POST \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/bills/?omit=string&fields=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
    "save_data": true
  }'

Respuestas

Ok (cuando save_data=false)

Cuerpoapplication/jsonArray [

idstring(uuid)

Identificador único de Belvo para el elemento actual.

Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

created_atstring(date-time)

La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.

Ejemplo: "2022-02-09T08:45:50.406032Z"

collected_atstring(date-time)

La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.

Ejemplo: "2022-02-09T08:45:50.406032Z"

accountobject or null

Detalles sobre la cuenta.

internal_identificationstring or null[ 1 .. 100 ] characters^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$

El identificador interno de la institución para la factura.

Ejemplo: "92792126019929279212650822221989319252576"

bill_namestring or null

El título de la factura mensual de la tarjeta de crédito a la que pertenece la transacción. El formato del valor devuelto es específico de la institución; sin embargo, algunos ejemplos comunes son:

diciembre-2021
dec-2021
dec-21

Nota: Este campo solo se devuelve para facturas 'cerradas' (lo que significa que el período de facturación ha terminado y la factura ha sido emitida). Si el período de facturación aún está en curso, devolvemos null.

Ejemplo: "apr-2020"

due_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...

La fecha en que se debe pagar la factura, en formato YYYY-MM-DD.

Ejemplo: "2021-09-06"

currencystring or null<= 3 characters^[A-Z]{3}$

El código de moneda de tres letras (ISO-4217).

Ejemplo: "BRL"

total_amountnumber or null(float)[ 1 .. 20 ] characters^\d{1,15}\.\d{2,4}$

El monto total de la factura.

Ejemplo: 45391.89

minimum_amountnumber or null(float)[ 1 .. 20 ] characters^\d{1,15}\.\d{2,4}$

La cantidad mínima a pagar.

Ejemplo: 391.89

is_installmentboolean or null

Boolean para indicar si esta factura se puede pagar en cuotas.

Ejemplo: false

finance_chargesArray of objectsnon-empty

paymentsArray of objects>= 0 items

]

Respuesta

application/json

[
  {
    "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
    "created_at": "2022-02-09T08:45:50.406032Z",
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "account": { … },
    "internal_identification": "92792126019929279212650822221989319252576",
    "bill_name": "apr-2020",
    "due_date": "2021-09-06",
    "currency": "BRL",
    "total_amount": 45391.89,
    "minimum_amount": 391.89,
    "is_installment": false,
    "finance_charges": [ … ],
    "payments": [ … ]
  }
]

Obtener los detalles de una factura

Solicitud

Obtener los detalles de una factura específica.

Seguridad

basicAuth

Ruta

idstring(uuid)requerido

El bill.id sobre el cual deseas obtener información detallada.

Consulta

omitstring

Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

fieldsstring

Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/bills/{id}/?omit=string&fields=string'

Respuestas

De acuerdo

Cuerpoapplication/json

idstring(uuid)

Identificador único de Belvo para el elemento actual.

Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

created_atstring(date-time)

La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.

Ejemplo: "2022-02-09T08:45:50.406032Z"

collected_atstring(date-time)

La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.

Ejemplo: "2022-02-09T08:45:50.406032Z"

accountobject or null

Detalles sobre la cuenta.

internal_identificationstring or null[ 1 .. 100 ] characters^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$

El identificador interno de la institución para la factura.

Ejemplo: "92792126019929279212650822221989319252576"

bill_namestring or null

diciembre-2021
dec-2021
dec-21

Nota: Este campo solo se devuelve para facturas 'cerradas' (lo que significa que el período de facturación ha terminado y la factura ha sido emitida). Si el período de facturación aún está en curso, devolvemos null.

Ejemplo: "apr-2020"

due_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...

La fecha en que se debe pagar la factura, en formato YYYY-MM-DD.

Ejemplo: "2021-09-06"

currencystring or null<= 3 characters^[A-Z]{3}$

El código de moneda de tres letras (ISO-4217).

Ejemplo: "BRL"

total_amountnumber or null(float)[ 1 .. 20 ] characters^\d{1,15}\.\d{2,4}$

El monto total de la factura.

Ejemplo: 45391.89

minimum_amountnumber or null(float)[ 1 .. 20 ] characters^\d{1,15}\.\d{2,4}$

La cantidad mínima a pagar.

Ejemplo: 391.89

is_installmentboolean or null

Boolean para indicar si esta factura se puede pagar en cuotas.

Ejemplo: false

finance_chargesArray of objectsnon-empty

paymentsArray of objects>= 0 items

Respuesta

application/json

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "account": {
    "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
    "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
    "institution": { … },
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "created_at": "2022-02-09T08:45:50.406032Z",
    "last_accessed_at": "2021-03-09T10:28:40.000Z",
    "category": "CHECKING_ACCOUNT",
    "balance_type": "ASSET",
    "overdraft": { … },
    "type": "STANDARD_NACIONAL",
    "subtype": "FINANCIAMENTO_HABITACIONAL_SFH",
    "name": "Cuenta Perfiles- M.N. - MXN-666",
    "number": "4057068115181",
    "agency": "6272",
    "check_digit": "7",
    "balance": { … },
    "currency": "BRL",
    "public_identification_name": "AGENCY/ACCOUNT",
    "public_identification_value": "0444/45722-0",
    "internal_identification": "92792126019929279212650822221989319252576",
    "credit_data": { … },
    "loan_data": { … },
    "funds_data": null
  },
  "internal_identification": "92792126019929279212650822221989319252576",
  "bill_name": "apr-2020",
  "due_date": "2021-09-06",
  "currency": "BRL",
  "total_amount": 45391.89,
  "minimum_amount": 391.89,
  "is_installment": false,
  "finance_charges": [
    { … }
  ],
  "payments": [
    { … }
  ]
}

Investments Brazil

Operaciones

Investment Transactions Brazil

Operaciones

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)

Operaciones

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)

Operaciones

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.

Operaciones

Invoices

Operaciones

Tax compliance status

Operaciones

Tax returns

Operaciones

Tax retentions

Operaciones

Tax status

Operaciones

Financial Statements

Operaciones

Invoices Chile

Operaciones

Tax Status Chile

Operaciones

Debt Reports Chile

Operaciones

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.

Operaciones

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.

Operaciones

Risk Insights

Operaciones

Employment Metrics

Operaciones

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.

Operaciones

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.

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.

Operaciones

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).

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.

Operaciones

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.

Operaciones

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.

¿Qué es un cargo?

Un cargo representa el pago individual (débito) que tu cliente realizará.

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.

Operaciones

Enrollments (Brazil)

Operaciones

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.

Operaciones

Documentación de la API de Belvo (1.222.0)

Introducción

Información Disponible y Métodos de Pago

Diccionarios de Datos

Entornos

Sandbox

Producción

Códigos de Respuesta

Manejo de Errores

Identificador de Solicitud

Códigos de Error y Solución de Problemas

Política de Reintentos

Errores 50x

Errores 40x

Campos Obsoletos

OpenAPI: campos requeridos y anulables

Institutions

Links

Widget Access Token

Consents

Owners

Accounts

Balances

Transactions

Bills

Listar facturas

Solicitud

▶️ Uso

📖 Paginación

🔦 Filtrado de Respuestas

Respuestas

¿Qué tan útil fue esta página?

Recuperar facturas para un enlace

Solicitud

Respuestas

¿Qué tan útil fue esta página?

Obtener los detalles de una factura

Solicitud

Respuestas

¿Qué tan útil fue esta página?

Investments Brazil

Investment Transactions Brazil

Employments Brazil

Employment Records Mexico

Current Employments Mexico

Invoices

Tax compliance status

Tax returns

Tax retentions

Tax status

Financial Statements

Invoices Chile

Tax Status Chile

Debt Reports Chile

Incomes

Recurring Expenses

Risk Insights

Employment Metrics

Payment Institutions (Brazil)

Customers (Brazil)

Bank Accounts (Brazil)

Payment Intents (Brazil)

Payment Authorizations (Brazil)

Biometric Pix Widget Access Token (Brazil)

Enrollments (Brazil)

Payment Transactions (Brazil)