Skip to content

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 EstadoDescripció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.
400Error de Solicitud Incorrecta - La solicitud devolvió un error, detalle en el contenido.
401No Autorizado - Las credenciales de Belvo proporcionadas no son válidas.
404No Encontrado - El recurso al que intentas acceder no se puede encontrar.
405Método No Permitido - El método HTTP que estás usando no es aceptado para este recurso.
408Tiempo de Solicitud Agotado - La solicitud se agotó y fue terminada por el servidor.
428Se Requiere Token MFA - La institución requirió un token MFA para conectar.
500Error 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
Idiomas
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

Widget Access Token

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

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

Obtener los detalles de un gasto recurrente

Solicitud

Obtén los detalles de un gasto recurrente específico.

Seguridad
basicAuth
Ruta
idstringrequerido

El recurring-expenses.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/recurring-expenses/{id}/?omit=string&fields=string'

Respuestas

De acuerdo

Cuerpoapplication/jsonArray [
idstring(uuid)

Identificador único de Belvo para el elemento actual.

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

Detalles sobre la cuenta.

Nota: Para nuestro recurso de gastos recurrentes, esta cuenta se refiere a la cuenta que fue analizada para generar el informe de gastos recurrentes.

idstring(uuid)

Identificador único de Belvo para el elemento actual.

Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)

El link.id al que pertenecen los datos.

Ejemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
institutionobject

Detalles sobre la institución.

collected_atstring(date-time)requerido

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

Ejemplo: "2022-02-09T08:45:50.406032Z"
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"
categorystring or nullrequerido

El tipo de cuenta.
Devolvemos uno de los siguientes valores del enum:

  • CHECKING_ACCOUNT
  • CREDIT_CARD
  • INVESTMENT_ACCOUNT
  • LOAN_ACCOUNT
  • PENSION_FUND_ACCOUNT
  • SAVINGS_ACCOUNT
  • UNCATEGORIZED
  • null
Enum"CHECKING_ACCOUNT""CREDIT_CARD""INVESTMENT_ACCOUNT""LOAN_ACCOUNT""PENSION_FUND_ACCOUNT""SAVINGS_ACCOUNT""UNCATEGORIZED"null
Ejemplo: "CHECKING_ACCOUNT"
balance_typestring or nullrequerido

Indica si esta cuenta es un ASSET o un LIABILITY. Puedes considerar el saldo de un ASSET como positivo, mientras que el saldo de un LIABILITY como negativo.

Ejemplo: "ASSET"
typestring or nullrequerido

El tipo de cuenta, según lo designado por la institución.

Ejemplo: "Cuentas de efectivo"
namestring or nullrequerido

El nombre de la cuenta, tal como lo proporciona la institución.

Ejemplo: "Cuenta Perfiles- M.N. - MXN-666"
numberstring or nullrequerido

El número de cuenta, según lo designado por la institución.

Ejemplo: "4057068115181"
balanceobjectrequerido

Detalles sobre los saldos actual y disponible de la cuenta.

currentnumber or null(float)requerido

El saldo actual se calcula de manera diferente según el tipo de cuenta.

  • 💰 Cuentas corrientes y de ahorro:

El saldo de la cuenta del usuario en el momento del timestamp collected_at.

  • 💳 Tarjetas de crédito:

La cantidad que el usuario ha gastado en el período de facturación actual de la tarjeta (consulte credit_data.cutting_date para obtener información sobre cuándo finaliza el período de facturación actual).

  • 🏡 Cuentas de préstamo:

La cantidad restante por pagar en el préstamo del usuario.

Ejemplo: 5874.13
availablenumber or null(float)

El saldo que el propietario de la cuenta puede utilizar.

  • 💰 Cuentas corrientes y de ahorro:

El saldo disponible puede ser diferente al saldo current debido a transacciones pendientes.

  • 💳 Tarjetas de crédito:

El monto de crédito que el usuario aún tiene disponible para el período actual. El saldo available puede ser diferente al saldo current debido a transacciones pendientes o cuotas futuras.

  • 🏡 Cuentas de préstamo:

El valor presente requerido para liquidar el préstamo, según lo proporcionado por la institución.

Nota: Si la institución no proporciona este valor, devolvemos null.

Ejemplo: 5621.12
currencystring or nullrequerido

La moneda de la cuenta. Por ejemplo:

  • 🇧🇷 BRL (Real Brasileño)
  • 🇨🇴 COP (Peso Colombiano)
  • 🇲🇽 MXN (Peso Mexicano)

Tenga en cuenta que pueden devolverse otras monedas además de las enumeradas anteriormente.

Ejemplo: "MXN"
public_identification_namestring or nullrequerido

El nombre público para el tipo de identificación. Por ejemplo: "CLABE".

ℹ️ Para cuentas de ahorro y cheques en 🇧🇷 Brasil, este campo será AGENCY/ACCOUNT.

Ejemplo: "CLABE"
public_identification_valuestring or nullrequerido

El valor para el public_identification_name.

ℹ️ Para cuentas de ahorro y corrientes en 🇧🇷 Brasil, este campo será el número de agencia y cuenta bancaria, separados por una barra. Por ejemplo: 0444/45722-0.

Ejemplo: "150194683119900273"
last_accessed_atstring or null(date-time)requerido

La marca de tiempo ISO-8601 del acceso más reciente y exitoso de Belvo a la institución para el enlace dado.

Ejemplo: "2021-03-09T10:28:40.000Z"
credit_dataobject or nullrequerido

Las opciones de crédito asociadas con esta cuenta.

credit_limitnumber or null(float)requerido

La cantidad máxima de crédito que el propietario puede recibir.

Ejemplo: 192000
collected_atstring(date-time)requerido

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

Ejemplo: "2022-02-09T08:45:50.406032Z"
cutting_datestring or nullrequerido

La fecha de cierre del período de crédito, en formato YYYY-MM-DD.

Ejemplo: "2019-12-11"
next_payment_datestringrequerido

La fecha de vencimiento para el próximo pago, en formato YYYY-MM-DD.

Ejemplo: "2019-12-13"
minimum_paymentnumber or null(float)requerido

El monto mínimo a pagar en la next_payment_date.

Ejemplo: 2400.3
no_interest_paymentnumber or null(float)requerido

La cantidad mínima requerida para pagar y evitar generar intereses.

Ejemplo: 2690.83
interest_ratenumber or null(float)requerido

La tasa de interés anualizada del crédito.

Ejemplo: 4
monthly_paymentnumber or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.

El pago mensual recurrente, si corresponde.

Ejemplo: null
last_payment_datestring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.

La fecha en que se realizó el último pago de crédito, en formato YYYY-MM-DD.

Ejemplo: null
last_period_balancestring or nullObsoleto

Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.

El saldo restante después de la last_payment_date.

Ejemplo: null
loan_dataobject or nullrequerido

Las opciones de préstamo asociadas con esta cuenta.

collected_atstring(date-time)requerido

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

Ejemplo: "2022-02-09T08:45:50.406032Z"
contract_amountnumber or null(float)

El monto total inicial del préstamo, calculado por la institución, cuando se firmó el contrato. Este monto incluye el principal + intereses + impuestos + tarifas.

Ejemplo: 202000
principalnumber or null(float)requerido

Monto total del préstamo (la cantidad que el usuario recibe).

Ejemplo: 192000
loan_typestring or null

El tipo de préstamo, según la institución.

Ejemplo: "Consignado"
payment_daystring or null

El día del mes en el que el propietario necesita pagar el préstamo (DD).

Ejemplo: "27"
outstanding_principalnumber or null(float)

Monto pendiente del préstamo, es decir, cuánto queda por pagar del principal (sin incluir intereses).

Ejemplo: 142023
outstanding_balancenumber or null(float)requerido

El monto restante a pagar en total, incluidos los intereses.

Ejemplo: 182000
monthly_paymentnumber or null(float)requerido

El pago mensual recurrente, si corresponde.

Ejemplo: 1000
interest_ratesArray of objects or nullrequerido

Desglose del interés aplicado al préstamo.

namestring or nullrequerido

El nombre del tipo de tasa de interés aplicada al préstamo.

Ejemplo: "jurosEfetivo"
typestring or nullrequerido

El período en el que se aplica el interés al préstamo. Devolvemos uno de los siguientes valores:

  • MONTHLY
  • YEARLY
Enum"MONTHLY""YEARLY"
Ejemplo: "MONTHLY"
valuenumber or null(float)requerido

La tasa de interés (en porcentaje o valor monetario).

Ejemplo: 7.85
feesArray of objects or null or null

Desglose de las tarifas aplicadas al préstamo.

number_of_installments_totalinteger or null(int32)

El número total de cuotas necesarias para pagar el préstamo.

Ejemplo: 60
number_of_installments_outstandinginteger or null(int32)

El número de cuotas restantes por pagar.

Ejemplo: 48
contract_start_datestring or null

La fecha en que se firmó el contrato de préstamo, en formato YYYY-MM-DD.

Ejemplo: "2020-03-01"
contract_end_datestring(date)

La fecha en la que se espera que el préstamo se complete, en formato YYYY-MM-DD.

Ejemplo: "2027-10-01"
contract_numberstring or null

El número de contrato del préstamo, tal como lo proporciona la institución.

Ejemplo: "890ASLDJF87SD00"
credit_limitnumber or nullObsoleto

Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.

Por favor, consulte principal en su lugar.

Ejemplo: null
last_period_balancenumber or nullObsoleto

Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.

Por favor, consulte outstanding_balance en su lugar.

Ejemplo: null
interest_ratenumber or nullObsoleto

Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de Campos obsoletos.

Por favor, consulte el objeto interest_rates en su lugar.

Ejemplo: null
limit_daystring or nullObsoleto

Este campo ha quedado obsoleto. Para obtener más información sobre Belvo y la obsolescencia, consulte nuestra explicación de campos obsoletos.

Por favor, consulte payment_day en su lugar.

Ejemplo: null
cutting_daystring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulte nuestra explicación de campos desaprobados.

El día de cierre del mes para el préstamo.

Ejemplo: null
cutting_datestring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.

La fecha de cierre del período del préstamo, en formato YYYY-MM-DD.

Ejemplo: null
last_payment_datestring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.

La fecha en que se realizó el último pago del préstamo, en formato YYYY-MM-DD.

next_payment_datestring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulte nuestra explicación de Campos desaprobados.

Por favor, use payment_day en su lugar, en formato YYYY-MM-DD.

Ejemplo: null
no_interest_paymentnumber or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulte nuestra explicación de campos desaprobados.

La cantidad mínima requerida para pagar y evitar generar intereses.

Ejemplo: null
funds_dataArray of objects or null

Uno o más fondos que contribuyen a la cuenta de pensión.

bank_product_idstring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.

El ID de producto de la institución para el tipo de cuenta.

Ejemplo: null
internal_identificationstring or nullObsoleto

Este campo ha sido desaprobado. Para obtener más información sobre Belvo y la desaprobación, consulta nuestra explicación de campos desaprobados.

La identificación interna de la institución para la cuenta.

Ejemplo: null
namestring or nullrequerido

El nombre para el gasto recurrente.

ℹ️ Nota: Esta información se toma de la sección de descripción de una transacción y luego se normaliza para proporcionarte un nombre fácil de leer. Por lo tanto, a veces el nombre reflejará el comerciante al que se realiza el pago (por ejemplo, Netflix.com), mientras que para otros gastos recurrentes, podría ser algo como "Pago mensual a John".

Predeterminado null
Ejemplo: "Netflix"
transactionsArray of objects or nullrequerido

Un array de objetos de transacción minificados se utiliza para evaluar el gasto recurrente. Si no se encuentran transacciones, devolvemos un array vacío.

amountnumber(float)requerido

El monto de la transacción.

Ejemplo: 2145.45
descriptionstring or nullrequerido

La descripción de la transacción proporcionada por la institución. Por lo general, este es el texto que el usuario final vería en el estado de cuenta bancario. La descripción puede ser una cadena vacía.

Nota: Para EYOD Risk Insights, la descripción es la que proporcionaste en la solicitud inicial.

Ejemplo: "Netflix.com/march"
value_datestring(date)requerido

La fecha en que ocurrió la transacción, en formato YYYY-MM-DD.

Ejemplo: "2019-10-23"
frequencystringrequerido

La frecuencia con la que ocurre este gasto recurrente.

ℹ️ Nota: Belvo solo identifica frecuencias MONTHLY.

Predeterminado "MONTHLY"
Valor"MONTHLY"
Ejemplo: "MONTHLY"
average_transaction_amountnumber(float)requerido

El monto promedio de la transacción del gasto recurrente.

Ejemplo: 32.9
median_transaction_amountnumber(float)requerido

El monto medio de la transacción del gasto recurrente.

Ejemplo: 32.9
days_since_last_transactioninteger(int32)requerido

Número de días desde que ocurrió el último gasto recurrente.

Según la frecuencia, puedes inferir cuántos días faltan para que ocurra el próximo cargo.

Ejemplo: 5
categorystringrequerido

La categoría de transacción para el gasto recurrente. Para obtener más información sobre las categorías disponibles, consulte nuestra documentación de categorización de transacciones.

  • Online Platforms & Leisure (Netflix, Spotify, Membresías de gimnasio)
  • Bills & Utilities (electricidad, teléfono, internet)
  • Credits & Loans (adelantos en efectivo de tarjetas de crédito, préstamo estudiantil, arrendamiento de embarcaciones)
  • Insurance (seguro de hogar, automóvil, y salud & vida)
  • Transport & Travel (viaje en Uber, airbnb, estacionamiento)
  • Taxes (tarifa de servicio, donación, impuestos judiciales)
Enum"Bills & Utilities""Credits & Loans""Insurance""Online Platforms & Leisure""Transport & Travel""Taxes"
Ejemplo: "Online Platforms & Leisure"
payment_typestring or nullrequerido

El tipo de gasto recurrente. Devolvemos uno de los siguientes valores:

  • SUBSCRIPTION
  • REGULAR
Enum"SUBSCRIPTION""REGULAR"
Ejemplo: "SUBSCRIPTION"
]
Respuesta
application/json
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "account": {}, "name": "Netflix", "transactions": [], "frequency": "MONTHLY", "average_transaction_amount": 32.9, "median_transaction_amount": 32.9, "days_since_last_transaction": 5, "category": "Online Platforms & Leisure", "payment_type": "SUBSCRIPTION" } ]

Eliminar un gasto recurrente

Solicitud

Eliminar un gasto recurrente específico de tu cuenta de Belvo.

Seguridad
basicAuth
Ruta
idstringrequerido

El recurring-expenses.id que deseas eliminar

curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/recurring-expenses/{id}/'

Respuestas

No hay contenido

Respuesta
Sin contenido

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 customer es el pagador que va a transferir fondos a tu cuenta bancaria. Necesitas crear un customer para recibir pagos entrantes en la cuenta bancaria de tu organización.

Operaciones

Bank Accounts (Brazil)

Para recibir pagos entrantes en la cuenta bancaria de su organización, debe registrar las cuentas bancarias (individuales y empresariales) utilizando la Payments API de Belvo.

  • Las cuentas bancarias individuales deben ser creadas para cada pagador (su cliente).
  • Las cuentas bancarias empresariales deben ser creadas para el beneficiario del pago (su organización).
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

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.

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