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

Obtener los detalles de una transacción

Solicitud

Obtén los detalles de una transacción específica.

Seguridad
basicAuth
Ruta
idstring(uuid)requerido

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

Respuestas

De acuerdo

Cuerpoapplication/json
idstring(uuid)requerido

Identificador único de Belvo para el elemento actual.

Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
internal_identificationstring[ 1 .. 100 ] characters^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$requerido

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

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl"
accountobject or nullrequerido

Detalles sobre la cuenta.

idstring(uuid)requerido

Identificador único de Belvo para el elemento actual.

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

El link.id al que pertenecen los datos.

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

Detalles sobre la institución.

namestring

El nombre de la institución, según lo designado por Belvo.

Ejemplo: "erebor_mx_retail"
typestring

El tipo de institución. Devolvemos uno de los siguientes valores:

  • bank
  • fiscal
  • employment
Enum"bank""fiscal""employment"
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)requerido

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"
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"
categorystring or nullrequerido

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

  • ADVANCE_DEPOSIT_ACCOUNT
  • CHECKING_ACCOUNT
  • CREDIT_CARD
  • FINANCING_ACCOUNT
  • INVESTMENT_ACCOUNT
  • INVOICE_FINANCING_ACCOUNT
  • LOAN_ACCOUNT
  • PENSION_FUND_ACCOUNT
  • SAVINGS_ACCOUNT
  • UNCATEGORIZED
Enum"ADVANCE_DEPOSIT_ACCOUNT""CHECKING_ACCOUNT""CREDIT_CARD""FINANCING_ACCOUNT""INVESTMENT_ACCOUNT""INVOICE_FINANCING_ACCOUNT""LOAN_ACCOUNT""PENSION_FUND_ACCOUNT""SAVINGS_ACCOUNT""UNCATEGORIZED"
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"
overdraftobject or null
typestringrequerido

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

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "STANDARD_NACIONAL"
subtypestringrequerido

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

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "FINANCIAMENTO_HABITACIONAL_SFH"
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, tal como lo designa la institución.

Ejemplo: "4057068115181"
agencystring or null<= 4 characters^\d{1,4}$requerido

El código de sucursal donde se abrió el producto.

Ejemplo: "6272"
check_digitstring or null<= 2 characters[\w\W\s]*requerido

El dígito de control del número del producto, si corresponde.

Ejemplo: "7"
balanceobjectrequerido

Detalles sobre los saldos actual y disponible de la cuenta.

currentnumber or null(float)^\d{1,15}\.\d{2,4}$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)^\d{1,15}\.\d{2,4}$

El saldo que el titular 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 monto se calcula como credit_data.credit_limit menos balance.current.

  • 🏡 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
blockednumber(float)^\d{1,15}\.\d{2,4}$

La cantidad que está actualmente bloqueada debido a transacciones pendientes.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo balances está disponible.

Ejemplo: 60.32
automatically_investednumber(float)^\d{1,15}\.\d{2,4}$

La cantidad que se invierte automáticamente (según lo acordado con la institución).

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo balances está disponible.

Ejemplo: 131.5
currencystring<= 3 characters^[A-Z]{3}$requerido

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

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo balances está disponible.

Ejemplo: "BRL"
public_identification_namestring or nullrequerido

El nombre público para el tipo de identificación. Para cuentas de ahorro y corrientes en 🇧🇷 Brasil, este campo será AGENCY/ACCOUNT.

Ejemplo: "AGENCY/ACCOUNT"
public_identification_valuestring or nullrequerido

El valor para el public_identification_name.

Para cuentas de ahorro y corriente OFDA brasileñas 🇧🇷, este campo será el número de agencia y cuenta bancaria, separados por una barra. Por ejemplo: 0444/45722-0.

Para cuentas de tarjeta de crédito OFDA brasileñas 🇧🇷, devolveremos una cadena de números de tarjeta de crédito concatenados asociados con la cuenta. Por ejemplo: "8763,9076,5522"

Ejemplo: "0444/45722-0"
internal_identificationstring<= 100 characters^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$requerido

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

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo balances está disponible.

Ejemplo: "92792126019929279212650822221989319252576"
credit_dataobject or nullrequerido

Detalles sobre las tarjetas de crédito 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"
credit_limitnumber or null(float)<= 20 characters^\d{1,15}\.\d{2,4}$requerido

El límite de crédito superior de la tarjeta.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: 192000.9
limitsArray of objects
cutting_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...

La fecha de vencimiento de la factura de la tarjeta de crédito.

Ejemplo: "2019-12-11"
minimum_paymentnumber or null(float)<= 20 characters^\d{1,15}\.\d{2,4}$

La cantidad mínima que el titular de la cuenta necesita pagar en el período de crédito actual.

Ejemplo: 2400.3
networkstring

La red de crédito con la que está asociada la tarjeta. Devolvemos uno de los siguientes valores:

  • VISA
  • MASTERCARD
  • AMERICAN_EXPRESS
  • DINERS_CLUB
  • HIPERCARD
  • BANDEIRA_PROPRIA
  • CHEQUE_ELETRONICO
  • ELO
  • OTHER

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Enum"VISA""MASTERCARD""AMERICAN_EXPRESS""DINERS_CLUB""HIPERCARD""BANDEIRA_PROPRIA""CHEQUE_ELETRONICO""ELO""OTHER"
Ejemplo: "MASTERCARD"
network_additional_infostring or null<= 100 characters[\w\W\s]*

Información adicional sobre la red de tarjetas de crédito.

Ejemplo: "It's an orange card."
cardsArray of objectsnon-empty

Detalles sobre las tarjetas asociadas con la cuenta.

next_payment_datestring or null

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
no_interest_paymentnumber or null(float)

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
interest_ratenumber or null(float)

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
monthly_paymentnumber or nullObsoleto

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
last_payment_datestring or nullObsoleto

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

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"
loan_codestring[ 22 .. 67 ] characters^\d{22,67}$requerido

El número de contrato estandarizado específico del país.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "92792126019929279212650822221989319252576"
contract_amountnumber or null(float)^\d{1,15}\.\d{2,4}$requerido

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

Ejemplo: 202000
total_effective_costnumber or null(float)^\d{1,15}\.\d{2,4}$

El costo total efectivo inicial del préstamo.

Ejemplo: 209000
loan_typestringrequerido

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

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "HOME_EQUITY"
outstanding_balancenumber or null(float)[ 4 .. 20 ] characters^\d{1,15}\.\d{2,4}$requerido

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

Ejemplo: 182000
interest_ratesArray of objectsrequerido

Desglose del interés aplicado al préstamo. Con OF Brasil, recomendamos encarecidamente utilizar la información en interest_rate_data para obtener información detallada.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

namestring or nullrequerido

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

Nota: Para OFDA Brasil, recomendamos usar el parámetro interest_date_data.tax_type.

Ejemplo: "NOMINAL"
typestringrequerido

El período durante el cual se aplica el interés al préstamo.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

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

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

Nota: Para OFDA Brasil, recomendamos usar el parámetro interest_date_data.pre_fixed_rate y interest_date_data.post_fixed_rate.

Ejemplo: 7.85
interest_rate_dataobject or nullrequerido

Información detallada sobre la tasa de interés.

tax_typestringrequerido

El tipo de impuesto sobre la tasa de interés. Devolvemos uno de los siguientes valores:

  • NOMINAL
  • EFFECTIVE

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Enum"NOMINAL""EFFECTIVE"
Ejemplo: "NOMINAL"
rate_typestringrequerido

El tipo de tasa de interés. Devolvemos uno de los siguientes valores:

  • SIMPLE
  • COMPOUND

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Enum"SIMPLE""COMPOUND"
Ejemplo: "SIMPLE"
typestring

El período durante el cual se aplica el interés al préstamo.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Enum"MONTHLY""YEARLY"
Ejemplo: "MONTHLY"
calculation_basestring^[0-9]{2}\/[0-9]{3}$requerido

El cálculo base para la tasa de interés.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "30/360"
reference_index_typestringrequerido

La tasa de índice de referencia. Devolvemos uno de los siguientes valores:

  • WITHOUT_INDEX_TYPE
  • PRE_FIXED
  • POST_FIXED
  • FLOATING
  • INDEXED_PRICE
  • RURAL_CREDIT
  • OTHER_INDEX

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Enum"WITHOUT_INDEX_TYPE""PRE_FIXED""POST_FIXED""FLOATING""INDEXED_PRICE""RURAL_CREDIT""OTHER_INDEX"
Ejemplo: "FLOATING"
reference_index_subtypestring or nullrequerido

El subtipo de la tasa de índice de referencia.

Ejemplo: "TR_TBF"
reference_index_infostring or null<= 140 characters^[\w\W\s]{0,140}$requerido

Información adicional sobre la tasa del índice de referencia.

Ejemplo: "Additional information"
pre_fixed_ratenumber(float)^[01]\.\d{6}$requerido

La tasa de interés con porcentaje prefijado.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: 0.062
post_fixed_ratenumber(float)^[01]\.\d{6}$requerido

La tasa de porcentaje post-fijada de la tasa de interés.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: 0.062
additional_infostring or null<= 1200 characters[\w\W\s]*requerido

Información adicional sobre la tasa de interés.

Ejemplo: "Additional information"
feesArray of objects or null or nullrequerido

Desglose de las tarifas aplicadas al préstamo.

typestring or nullrequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Enum"OPERATION_FEE""INSURANCE_FEE""OTHERS"null
Ejemplo: null
valuenumber or null(float)^\d{1,15}\.\d{2,4}$requerido

El valor total de la tarifa. Misma moneda que el préstamo.

Ejemplo: 5.6
namestring<= 140 characters^[\w\W\s]{0,140}$requerido

El nombre de la tarifa.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo fees está disponible.

Ejemplo: "Renovação de cadastro"
codestring<= 140 characters^[\w\W\s]{0,140}$requerido

El código de tarifa.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo fees está disponible.

Ejemplo: "CADASTRO"
fee_charge_typestringrequerido

Indica el tipo de cargo. Devolvemos uno de los siguientes valores:

  • SINGLE
  • PER_INSTALLMENT

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo fees está disponible.

Enum"SINGLE""PER_INSTALLMENT"
Ejemplo: "SINGLE"
fee_chargestringrequerido

Método de facturación, según lo acordado con la institución. Devolvemos uno de los siguientes valores:

  • MINIMUM
  • MAXIMUM
  • FIXED
  • PERCENTAGE

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo fees está disponible.

Enum"MINIMUM""MAXIMUM""FIXED""PERCENTAGE"
Ejemplo: "FIXED"
ratenumber or null(float)^[01]\.\d{6}$requerido

La tasa porcentual de la tarifa. Requerido cuando fee_charge está configurado en PERCENTAGE.

Ejemplo: 0.062
contracted_chargesArray of objects or null or null

Lo siento, no hay texto proporcionado para traducir. Por favor, proporciona el texto que necesitas que traduzca.

collateralsArray of objects or null or nullrequerido

Detalles sobre cualquier garantía de préstamo que el individuo o negocio haya proporcionado.

typestringrequerido

El tipo de garantía, según lo definido por la institución.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo collaterals está disponible.

Ejemplo: "OPERACOES_GARANTIDAS_PELO_GOVERNO"
subtypestringrequerido

El subtipo de la garantía, según lo definido por la institución.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo collaterals está disponible.

Ejemplo: "CCR_CONVENIO_CREDITOS_RECIPROCOS"
currencystring<= 3 characters^[A-Z]{3}$requerido

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

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo collaterals está disponible.

Ejemplo: "BRL"
amountnumber(float)^\d{1,15}\.\d{2,4}$requerido

El monto total de la factura.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo collaterals está disponible.

Ejemplo: 45391.89
balloon_paymentsArray of objects or null or nullrequerido

Información detallada sobre cualquier pago global del préstamo, si corresponde.

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

La fecha en que se debe pagar el balloon payment, en formato YYYY-MM-DD.

Ejemplo: "2021-09-06"
currencystring or null<= 3 characters^[A-Z]{3}$requerido

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

Ejemplo: "BRL"
amountnumber or null(float)^\d{1,15}\.\d{2,4}$requerido

El monto total del pago global.

Ejemplo: 45391.89
installments_contract_term_frequencystring or nullrequerido

La frecuencia de los pagos a plazos contratados, tal como se definió cuando se firmó el contrato por primera vez. Devolvemos uno de los siguientes:

  • DAY
  • WEEK
  • MONTH
  • YEAR
  • NO_DEADLINE_REMAINING
  • null
Enum"DAY""WEEK""MONTH""YEAR""NO_DEADLINE_REMAINING"null
Ejemplo: "MONTH"
installment_frequencystringrequerido

La frecuencia con la que se pagan las cuotas. Devolvemos uno de los siguientes valores:

  • IRREGULAR
  • WEEKLY
  • FORTNIGHTLY
  • MONTHLY
  • BIMONTHLY
  • QUARTERLY
  • BIANNUALLY
  • ANNUALLY
  • OTHER

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Enum"IRREGULAR""WEEKLY""FORTNIGHTLY""MONTHLY""BIMONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY""OTHER"
Ejemplo: "MONTHLY"
installment_frequency_infostring or null<= 100 characters^[\w\W\s]{0,99}$$requerido

Información adicional sobre el installment_frequency.

Ejemplo: "Both the term and requency are the same."
first_installment_due_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La fecha en la que debe pagarse la primera cuota del préstamo, en formato YYYY-MM-DD.

Ejemplo: "2020-03-01"
number_of_installments_totalinteger or null(int32)<= 999999999requerido

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

Ejemplo: 60
number_of_installments_outstandinginteger or null(int32)<= 999999999requerido

El número de cuotas restantes por pagar.

Ejemplo: 48
number_of_installments_paidinteger or null(int32)<= 999999999requerido

El número de cuotas ya pagadas.

Ejemplo: 32
number_of_installments_past_dueinteger or null(int32)<= 999requerido

El número de cuotas que están vencidas.

Ejemplo: 2
disbursement_datesArray of strings or null or nullnon-emptyrequerido

Un array de fechas cuando se desembolsó el préstamo.

Ejemplo: ["2021-09-23"]
settlement_datestring or null<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

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

Ejemplo: "2021-09-23"
contract_start_datestring(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

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

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil.

Ejemplo: "2020-03-01"
contract_end_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

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

Ejemplo: "2027-10-01"
contract_remaining_frequencystring or nullrequerido

La frecuencia de los pagos de las cuotas restantes contratadas, tal como se definió cuando se firmó el contrato por primera vez. Devolvemos uno de los siguientes valores:

  • DAY
  • WEEK
  • MONTH
  • YEAR
  • NO_DEADLINE_REMAINING
  • null
Enum"DAY""WEEK""MONTH""YEAR""NO_DEADLINE_REMAINING"null
Ejemplo: "MONTH"
contract_remaining_totalinteger or null(int32)<= 999999999requerido

El número total de cuotas restantes del préstamo.

Ejemplo: 20
amortization_schedulestringrequerido

El calendario de amortización del préstamo.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "SEM_SISTEMA_AMORTIZACAO"
amortization_schedule_infostring or null<= 200 characters[\w\W\s]*requerido

Información adicional sobre el amortization_schedule.

Ejemplo: "No need for a schedule."
consignee_idstring or null<= 14 characters^\d{14}$requerido

El ID del consignatario del préstamo.

Ejemplo: "60500998000135"
contract_numberstring or null[ 1 .. 100 ] characters^\d{1,100}$requerido

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

Ejemplo: "1324926521496"
monthly_paymentnumber or null(float)requerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
principalnumber or null(float)requerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
payment_daystring or nullrequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
outstanding_principalnumber or null(float)requerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
credit_limitnumber or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
last_period_balancenumber or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
interest_ratenumber or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
limit_daystring or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
cutting_daystring or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
cutting_datestring or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
last_payment_datestring or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
no_interest_paymentnumber or nullObsoletorequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
funds_datastring or nullrequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
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)requerido

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"
value_datestring(date)^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

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

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "2019-10-23"
transacted_atstring(date-time)(^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0...

La marca de tiempo ISO-8601 de cuando ocurrió la transacción (en la zona horaria UTC).

Nota: Para transacciones que ocurrieron antes del 31.01.2024, la marca de tiempo puede indicar solo el día (por ejemplo, 2016-01-29T00:00:00.000Z). Sin embargo, las transacciones que ocurrieron después de esta fecha deben incluir la fecha y la hora (2024-02-20T12:29:03.374Z).

Instituciones que no cumplen con este formato: Algunas instituciones pueden no proporcionar la hora exacta de la transacción. En este caso, la marca de tiempo se establecerá en 00:00:00.000Z. Belvo ha identificado las siguientes instituciones como no cumpliendo con la regulación y ha planteado el problema a los reguladores: Bradesco, Itau y Sicoob.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor para transacciones de tarjeta de crédito y cuenta corriente.

Ejemplo: "2024-02-20T12:29:03.374Z"
accounting_datestring or nullrequerido

La fecha en que la transacción fue procesada y contabilizada por la institución, en formato YYYY-MM-DD.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor para transacciones con tarjeta de crédito.

Ejemplo: "2019-10-23"
inferred_accounting_datestring(date)

En el caso de que la transacción ocurra en un fin de semana o día festivo, Belvo inferirá la fecha en que la transacción es contabilizada por la institución. Normalmente, este es el siguiente día hábil.

Ejemplo: "2019-10-23"
amountnumber(float)^\d{1,15}\.\d{2,4}$requerido

El monto de la transacción.
ℹ️ El monto mostrado siempre es positivo, ya que indicamos la dirección de la transacción en el parámetro type.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: 2145.45
local_currency_amountnumber or null(float)<= 20 characters^\d{1,15}\.\d{2,4}$requerido

El valor de la transacción en la moneda local.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor para las transacciones con tarjeta de crédito.

Ejemplo: 7623.64
balancenumber or null(float)requerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

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

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

Ejemplo: "BRL"
descriptionstring or nullrequerido

La descripción de la transacción proporcionada por la institución. Generalmente, este es el texto que el usuario final ve en la plataforma en línea.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "SEVEN BUDDHAS RFC:XXXXXXXXXX"
observationsstring or nullrequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
merchantobject or nullrequerido

Datos adicionales sobre el comerciante involucrado en la transacción. Solo devolvemos información del comerciante para nuevas transacciones realizadas desde cuentas de cheques o tarjeta de crédito.

Obtener información del comerciante Recuperamos la información del comerciante para una transacción como parte de nuestro producto de Categorización de transacciones, convirtiendo datos en bruto en información procesable. Para habilitar este producto, simplemente contáctanos, y nos pondremos manos a la obra.

logostring or null

La URL del logotipo del comerciante.

Ejemplo: "https://logo.clearbit.com/asesor-contable.es"
websitestring or null

La URL al sitio web del comerciante.

Ejemplo: "https://merchants-r-us.com"
merchant_namestring

El nombre del comerciante.

Ejemplo: "Merchants R Us Global"
categorystring or nullrequerido

El nombre de la categoría de transacción.

Obtener categorización de transacciones Con la categorización de transacciones, limpiamos y categorizamos las transacciones por ti, convirtiendo datos en bruto en información procesable. Para habilitar esta función, simplemente contáctanos y nos pondremos manos a la obra.

Devolvemos uno de los siguientes valores de 'enum':

  • Bills & Utilities
  • Credits & Loans
  • Deposits
  • Fees & Charges
  • Food & Groceries
  • Home & Life
  • Income & Payments
  • Insurance
  • Investments & Savings
  • Online Platforms & Leisure
  • Personal Shopping
  • Taxes
  • Transfers
  • Transport & Travel
  • Unknown*
  • Withdrawal & ATM
  • null

* Para los clientes que no utilizan nuestro producto de Categorización de Transacciones, devolvemos null en su lugar.

Enum"Bills & Utilities""Credits & Loans""Deposits""Fees & Charges""Food & Groceries""Home & Life""Income & Payments""Insurance""Investments & Savings""Online Platforms & Leisure"
Ejemplo: "Income & Payments"
subcategorystring or nullrequerido

La subcategoría de la transacción.

Obtener categorización de transacciones Para los clientes que no utilizan nuestra categorización de transacciones, devolvemos null en su lugar. Para habilitar esta función, simplemente contáctanos, y lo activaremos de inmediato.

Devolvemos uno de los siguientes valores de enum:

  • Electricity & Energy
  • Rent
  • Telecommunications
  • Water
  • Auto
  • Credit Card
  • Instalment
  • Interest & Charges
  • Mortgage
  • Pay Advance
  • Personal
  • Adjustments
  • Bank Fees
  • Chargeback
  • Refund
  • Blocked Balances
  • Alimony
  • Alcohol & Tobacco
  • Bakery & Coffee
  • Bars & Nightclubs
  • Convenience Store
  • Delivery
  • Groceries
  • Restaurants
  • Education
  • Gyms & Fitness
  • Hair & Beauty
  • Health
  • Home Decor & Appliances
  • Laundry & Dry Cleaning
  • Pharmacies
  • Professional Services
  • Veterinary Services
  • Freelance
  • Interest
  • Retirement
  • Salary
  • Government
  • Home Insurance
  • Auto Insurance
  • Health & Life Insurance
  • Savings
  • Fixed income
  • Equity
  • Investment Funds
  • Derivatives
  • Cryptocurrencies
  • Apps, Software and Cloud Services
  • Events, Parks and Museums
  • Gambling
  • Gaming
  • Lottery
  • Movie & Audio
  • Books & News
  • Clothing & Accessories
  • Department Store
  • Electronics
  • E-commerce
  • Gifts
  • Office Supplies
  • Pet Supplies
  • Auto Tax & Fees
  • Donation
  • Government Fees
  • Income Tax
  • Real Estate Tax & Fees
  • Tax Return
  • Accommodation
  • Auto Expenses
  • Auto Rental
  • Flights
  • Gas
  • Mileage Programs
  • Parking & Tolls
  • Public Transit
  • Taxis & Rideshares
  • Other
  • null
Enum"Electricity & Energy""Rent""Telecommunications""Water""Auto""Credit Card""Instalment""Interest & Charges""Mortgage""Pay Advance"
Ejemplo: "Freelance"
referencestring or null<= 128 charactersrequerido

Nota: Este campo no es aplicable para OF Brazil y devolverá null.

Ejemplo: null
typestring or nullrequerido

La dirección de la transacción:

  • INFLOW indica dinero que entra en la cuenta.
  • OUTFLOW indica dinero que sale de la cuenta.
  • null cuando no hay información presente sobre la dirección de la transacción.
Enum"OUTFLOW""INFLOW"null
Ejemplo: "INFLOW"
statusstring or nullrequerido

El estado de la transacción. Devolvemos uno de los siguientes valores:

  • PROCESSED (La transacción ha sido procesada por la institución.)
  • PENDING (La institución indica claramente que la transacción aún no ha sido procesada.)
  • UNCATEGORIZED (obsoleto)
  • null (obsoleto)
Enum"PENDING""PROCESSED""UNCATEGORIZED"null
Ejemplo: "PROCESSED"
credit_card_dataobject or nullrequerido

Datos adicionales proporcionados por la institución para transacciones con tarjeta de crédito.

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"
bill_namestring or nullrequerido

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"
bill_due_datestring or null(date)

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

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: "2023-06-17"
bill_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.

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: "927921260199292792126508222219893192525A6"
bill_statusstring or nullrequerido

Nota: Este campo no es aplicable para OFDA Brasil y devolverá null.

Ejemplo: null
previous_bill_totalstring or nullrequerido

Nota: Este campo no es aplicable para OFDA Brasil y devolverá null.

Ejemplo: null
bill_amountnumber or null(float)^-?\d{1,15}\.\d{2,4}$requerido

El monto de la factura, a partir de collected_at. Para más información, consulta credit_card_bill.

Ejemplo: 300
card_numberstring[ 1 .. 100 ] characters^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$requerido

El número de la tarjeta de crédito.

Nota: A menudo, esto es solo los últimos cuatro dígitos de la tarjeta de crédito.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "4453"
fee_typestring or nullrequerido

La tarifa que se puede cobrar por una transacción con tarjeta. Devolvemos uno de los siguientes valores:

  • ANNUAL_FEE
  • NATIONAL_WITHDRAWAL
  • INTERNATIONAL_WITHDRAWAL
  • EMERGENCY_CREDIT_EVALUATION_FEE
  • DUPLICATE_ISSUANCE_FEE
  • PAYMENT_FEE
  • SMS_FEE
  • OTHERS
  • null
Enum"ANNUAL_FEE""NATIONAL_WITHDRAWAL""INTERNATIONAL_WITHDRAWAL""EMERGENCY_CREDIT_EVALUATION_FEE""DUPLICATE_ISSUANCE_FEE""PAYMENT_FEE""SMS_FEE""OTHERS"null
Ejemplo: "NATIONAL_WITHDRAWAL"
fee_type_additional_infostring or null<= 140 characters^[\w\W\s]{0,140}$requerido

Información adicional sobre la tarifa.

Ejemplo: "ATM withdrawal in Curitiba."
credits_typestring or nullrequerido

Otros tipos de crédito que se han contratado en la tarjeta. Devolvemos uno de los siguientes valores:

  • REVOLVING_CREDIT
  • BILL_INSTALLMENT_PAYMENT
  • LOAN
  • OTHERS
  • null
Enum"REVOLVING_CREDIT""BILL_INSTALLMENT_PAYMENT""LOAN""OTHERS"null
Ejemplo: "BILL_INSTALLMENT_PAYMENT"
credits_type_additional_infostring or null<= 140 characters^[\w\W\s]{0,140}$requerido

Información adicional sobre el tipo de crédito.

Ejemplo: "Some additional information."
installment_identifierstring<= 140 characters^[\w\W\s]{0,140}$requerido

Un identificador para la cuota, según la institución.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

Ejemplo: "PARCELA_896"
number_of_installmentsinteger or null<= 999requerido

El número total de cuotas para la transacción con tarjeta, si corresponde.

Ejemplo: 4
credit_card_billobject or null

Información sobre la factura en la que aparece esta transacción.

counterpartyobject or nullrequerido

Información sobre la otra parte de esta transacción, si está disponible.

typestring or nullrequerido

El tipo de contraparte de la transacción. Devolvemos uno de los siguientes valores:

  • INDIVIDUAL
  • COMPANY
  • null
Enum"INDIVIDUAL""COMPANY"null
Ejemplo: "INDIVIDUAL"
document_numberstring or null<= 11 characters^\d{11}$requerido

El número de documento del representante.

Nota:

Para Brasil:

  • Cuando el type es INDIVIDUAL, este es el número de CPF.
  • Cuando el type es COMPANY, este es el número de CNPJ.
Ejemplo: "73677831148"
clearing_codestring or null<= 3 characters^\d{3}$requerido

El código de compensación bancaria.

Ejemplo: "001"
agencystring or null<= 4 characters^\d{1,4}$requerido

El código de sucursal donde se abrió la cuenta.

Ejemplo: "6272"
check_digitstring or null<= 2 characters[\w\W\s]*requerido

El dígito de control del número de cuenta, si corresponde.

Ejemplo: "7"
numberstring or null<= 20 characters^\d{8,20}$requerido

El número de cuenta del producto.

Ejemplo: "24550245"
loan_dataobject or nullrequerido

Información sobre los datos transaccionales del préstamo, si corresponde.

is_detachedbooleanrequerido

Boolean para indicar si este pago de préstamo fue parte del calendario de pagos original.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.

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

El ID único de la institución para esta cuota de pago.

Ejemplo: "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH"
feesArray of objects or nullrequerido

Detalles relacionados con las tarifas asociadas con este pago. Solo aplicable cuando is_detached = true.

namestring<= 140 characters^[\w\W\s]{0,140}$requerido

El nombre de la tarifa.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil cuando el campo fees está presente.

Ejemplo: "Reavaliação periódica do bem"
codestring<= 140 characters^[\w\W\s]{0,140}$requerido

El código de la institución para la tarifa.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil cuando el campo fees está presente.

Ejemplo: "aval_bem"
amountnumber or null(float)^-?\d{1,15}\.\d{2,4}$requerido

El monto de la tarifa.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil cuando el campo fees está presente.

Ejemplo: 8903.77
chargesArray of objects or null>= 0 itemsrequerido

Detalles relacionados con los cargos asociados con este pago. Solo aplicable cuando is_detached = true.

typestring<= 140 characters^[\w\W\s]{0,140}$requerido

El tipo de cargo.

No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil cuando el campo charges está presente.

Ejemplo: "MULTA_ATRASO_PAGAMENTO"
infostring<= 140 characters^[\w\W\s]{0,140}$requerido

Información adicional sobre el type de cargo.

Ejemplo: "Late payment charge."
amountnumber(float)^-?\d{1,15}\.\d{2,4}$requerido

El monto del cargo.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor cuando el campo charges está presente.

Ejemplo: 8903.77
payment_typestring or nullrequerido

El tipo de pago de la transacción. Devolvemos uno de los siguientes valores:

  • FULL
  • INSTALLMENT
  • null
Enum"FULL""INSTALLMENT"null
Ejemplo: "FULL"
operation_typestring<= 50 characters^[A-Za-z_]{0,50}$requerido

El tipo de transacción. Por ejemplo, un pago PIX o un depósito.

No anulable: La red de finanzas abiertas de Brasil debe devolver un valor para transacciones de cuentas que no sean de préstamo.

Ejemplo: "TRANSFERENCIA_MESMA_INSTITUICAO"
operation_type_additional_infostring or null<= 140 characters^\S[\s\S]*$requerido

Información adicional sobre el operation_type, si corresponde.

Ejemplo: "Internal transfer."
mccinteger or null(int32)^[0-9]{4}$requerido

El código de categoría de comerciante (MCC) de cuatro dígitos (compatible con ISO-18245) para la transacción. Este campo solo es aplicable para transacciones con tarjeta de crédito.

Ejemplo: 5137
Respuesta
application/json
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl", "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 }, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "value_date": "2019-10-23", "transacted_at": "2024-02-20T12:29:03.374Z", "accounting_date": "2019-10-23", "inferred_accounting_date": "2019-10-23", "amount": 2145.45, "local_currency_amount": 7623.64, "balance": null, "currency": "BRL", "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX", "observations": null, "merchant": { "logo": "https://logo.clearbit.com/asesor-contable.es", "website": "https://merchants-r-us.com", "merchant_name": "Merchants R Us Global" }, "category": "Income & Payments", "subcategory": "Freelance", "reference": null, "type": "INFLOW", "status": "PROCESSED", "credit_card_data": { "collected_at": "2022-02-09T08:45:50.406032Z", "bill_name": "apr-2020", "bill_due_date": "2023-06-17", "bill_internal_identification": "927921260199292792126508222219893192525A6", "bill_status": null, "previous_bill_total": null, "bill_amount": 300, "card_number": "4453", "fee_type": "NATIONAL_WITHDRAWAL", "fee_type_additional_info": "ATM withdrawal in Curitiba.", "credits_type": "BILL_INSTALLMENT_PAYMENT", "credits_type_additional_info": "Some additional information.", "installment_identifier": "PARCELA_896", "number_of_installments": 4, "credit_card_bill": {} }, "counterparty": { "type": "INDIVIDUAL", "document_number": "73677831148", "clearing_code": "001", "agency": "6272", "check_digit": "7", "number": "24550245" }, "loan_data": { "is_detached": true, "installment_id": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH", "fees": [], "charges": [] }, "payment_type": "FULL", "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO", "operation_type_additional_info": "Internal transfer.", "mcc": 5137 }

Eliminar una transacción

Solicitud

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

Seguridad
basicAuth
Ruta
idstring(uuid)requerido

El transaction.id que deseas eliminar.

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

Respuestas

No hay contenido

Respuesta
Sin contenido

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

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