Un consentimiento es un permiso otorgado por el usuario final para acceder a sus datos financieros en la Red de Finanzas Abiertas en Brasil.
Documentación de la API de Belvo (1.223.0)
Alcanza nuevas audiencias y convierte más usuarios conectándote fácil y seguramente a sus datos financieros, entendiendo su comportamiento y habilitando pagos instantáneos con finanzas abiertas. A través de nuestra API, puedes acceder a:
Belvo es una API de banca abierta para América Latina que permite a las empresas acceder a información bancaria y fiscal de manera segura y ágil.
A través de nuestra API, puedes acceder a:
- Información Bancaria en Brasil
- Información Laboral en Brasil
- Información Laboral en México
- Información Fiscal en México
- Información Fiscal en Chile
También puedes usar nuestra API para realizar pagos en:
- Brasil
- México
Si deseas la documentación de respuesta en formato Excel o CSV, por favor descárgalos desde nuestro Repositorio Público de GitHub: Diccionarios de Datos de Belvo Open Finance.
Nuestros archivos EXCEL y CSV están adicionalmente localizados en español y portugués (Brasil).
Disponible para:
- 🟢 Agregación y Enriquecimiento
- ⚪️ Iniciación de Pagos
Usa nuestro entorno Sandbox para construir tu integración. Ofrecemos datos ficticios que imitan casos de uso del mundo real, lo que significa que puedes probar todos los endpoints, usar el widget e implementar webhooks, tal como lo harías con datos reales.
Todo lo que necesitas para comenzar con el entorno Sandbox es obtener tus claves API. Realmente recomendamos que comiences creando tu integración en este entorno.
Disponible para:
- 🟢 Agregación y Enriquecimiento
- 🟢 Iniciación de Pagos
Después de haber probado tu integración en el entorno Sandbox y estar listo para ir en vivo, necesitarás solicitar acceso a nuestro entorno de Producción. Después de solicitar acceso, nuestro equipo de ventas se pondrá en contacto contigo para programar una reunión solo para asegurarse de que se cumplan tus necesidades, y luego solo necesitarás pasar por un proceso de certificación con uno de nuestros ingenieros para asegurarte de que tu integración esté funcionando de manera óptima. Para prepararte para la reunión de certificación, solo sigue nuestra lista de verificación de integración.
Una vez que tu integración esté certificada, todo lo que necesitarás hacer es:
- Solicitar claves API de Producción (y cambiar tus claves API de Sandbox en el código por estas nuevas).
- Cambiar la URL base a la que haces solicitudes de
sandbox.belvo.comaapi.belvo.com. - Si estás usando webhooks, asegúrate de establecer una URL de Producción para tus webhooks.
Usamos el siguiente código de estado HTTP en la respuesta dependiendo del éxito o fracaso:
| Código de Estado | Descripción |
|---|---|
200 | ✅ Éxito - El contenido está disponible en el cuerpo de la respuesta. |
201 | ✅ Éxito - El contenido fue creado exitosamente en Belvo. |
204 | ✅ Éxito - No hay contenido para devolver. |
400 | ❌ Error de Solicitud Incorrecta - La solicitud devolvió un error, detalle en el contenido. |
401 | ❌ No Autorizado - Las credenciales de Belvo proporcionadas no son válidas. |
404 | ❌ No Encontrado - El recurso al que intentas acceder no se puede encontrar. |
405 | ❌ Método No Permitido - El método HTTP que estás usando no es aceptado para este recurso. |
408 | ❌ Tiempo de Solicitud Agotado - La solicitud se agotó y fue terminada por el servidor. |
428 | ❌ Se Requiere Token MFA - La institución requirió un token MFA para conectar. |
500 | ❌ Error Interno del Servidor - El detalle del error está disponible en el cuerpo de la respuesta. |
Los errores de la API de Belvo se devuelven en formato JSON. Por ejemplo, un error podría verse así:
[
{
"request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
"message": "Este campo es obligatorio.",
"code": "required",
"field": "link"
}
]Típicamente, una respuesta de error tendrá los siguientes parámetros:
request_id: un ID único para la solicitud, debes compartirlo con el equipo de soporte de Belvo para investigaciones.message: descripción del error en lenguaje humano.code: un código único para el error. Consulta la tabla a continuación para ver cómo manejar cada código de error.field(opcional): El campo específico en el cuerpo de la solicitud que tiene un problema.
Cuando necesites ayuda con un error específico, incluye el identificador de solicitud (request_id) en tu mensaje al equipo de soporte de Belvo. Esto acelerará las investigaciones y te permitirá volver a funcionar en poco tiempo.
Para una lista completa de errores y cómo solucionarlos, por favor consulta nuestro artículo dedicado al Manejo de Errores.
Implementa un retroceso exponencial automatizado de hasta cinco reintentos. Recomendamos usar un intervalo base de tres segundos con un factor de dos. Por ejemplo, el primer reintento debe ser después de tres segundos, el segundo reintento después de seis segundos (2 * 3), el tercer reintento después de 12 segundos (2 * 6), el cuarto reintento después de 24 segundos (2 * 12), y el quinto reintento después de 48 segundos (2 * 24).
No debes reintentar hacer solicitudes si recibes una respuesta 40x, ya que esto es un error del cliente.
La única excepción es el error de "Demasiadas Sesiones", ya que significa que tu usuario final está accediendo a la cuenta desde otro navegador al mismo tiempo. En este caso, por favor implementa la misma política de reintentos que con los errores 50x.
En nuestro esquema, puedes ver que un campo ha sido marcado como deprecated. Esto significa que este campo ya no es mantenido por el equipo de Belvo. Aún puedes recibir datos para este campo dependiendo de la institución, sin embargo, no debes confiar en este campo.
En nuestra especificación de API, verás que algunos parámetros de respuesta tendrán una anotación de required. Según la especificación de OpenAPI, cuando un parámetro de respuesta está marcado como required, esto significa que la clave de respuesta debe ser devuelta. Sin embargo, el valor de ese parámetro de respuesta puede ser null.
📘 Info
En resumen, cualquier parámetro de respuesta marcado como requerido será devuelto por nuestra API, pero el valor puede ser establecido en null.
Descargar el archivo de descripción OpenAPI
Resumen
URL
Need help?
Idiomas
Servidores
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.
SchemasOperaciones
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
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.
SchemasOperaciones
Exchanges
Un intercambio es una operación de cambio de divisas en la Red de Finanzas Abiertas de Brasil. El recurso contiene detalles de las operaciones de cambio de divisas, incluyendo tasas de cambio, montos en monedas locales y extranjeras, e información de liquidación. Cada operación de intercambio puede tener eventos de historial asociados que registran cualquier modificación al contrato original.
SchemasOperaciones
Objeto de Intercambio (Brasil)
Detalles sobre una operación de cambio en la Red de Finanzas Abiertas de Brasil.
Un Exchange representa una operación de cambio de divisas contratada por el cliente, incluyendo los detalles principales del contrato, tasas de cambio, montos en monedas locales y extranjeras, e información de liquidación.
Identificador único de Belvo para el elemento actual.
Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
El link.id al que pertenecen los datos.
Ejemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
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"
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
Ejemplo: "2022-02-09T08:45:50.406032Z"
El identificador único de la red para la operación de intercambio.
Ejemplo: "92792126019929240"
El número de registro de operación de 12 dígitos del Banco Central de Brasil (Bacen). Esto puede ser null si la operación aún no ha sido registrada.
Ejemplo: "393874649456"
El tipo de operación de cambio.
Devolvemos uno de los siguientes valores de enum:
COMPRA- Comprar (el cliente está comprando moneda extranjera)VENDA- Vender (el cliente está vendiendo moneda extranjera)
Enum"COMPRA""VENDA"
Ejemplo: "COMPRA"
La marca de tiempo ISO-8601 cuando se contrató la operación de intercambio.
Ejemplo: "2023-03-07T08:30:00Z"
El CNPJ de la institución autorizada para llevar a cabo la operación.
Ejemplo: 11225860000140
El nombre de la institución autorizada.
Ejemplo: "AGENCIA CORRETORA"
El CNPJ de la institución intermediaria, si se utilizó una.
Ejemplo: 11225860000140
El nombre de la institución intermediaria. Debe estar presente si intermediary_institution_identifier está disponible.
Ejemplo: "AGENCIA CORRETORA"
operation_due_datestring(date)= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido
La fecha de liquidación programada actualmente para la operación, en formato YYYY-MM-DD.
Nota: Este campo se actualiza si se realizan cambios en la operación de intercambio.
Ejemplo: "2018-02-15"
El tipo de cambio aplicado a la operación.
Ejemplo: 1.3
El código de moneda de tres letras (ISO-4217) para la tasa de cambio.
Ejemplo: "BRL"
El valor total de la operación en moneda local.
Ejemplo: 1000.04
El código de moneda de tres letras (ISO-4217) para la moneda local.
Ejemplo: "BRL"
El valor total de la operación en la moneda extranjera.
Ejemplo: 1000.04
El código de moneda de tres letras (ISO-4217) para la moneda extranjera.
Ejemplo: "USD"
El saldo pendiente por liquidar, en la moneda extranjera. En el caso de que la operación de cambio esté programada para liquidarse dentro de los dos días posteriores a operation_requested_at, este valor puede ser null.
Ejemplo: 1000.04
La moneda del saldo pendiente. Obligatorio si operation_outstanding_balance_amount no es null.
Ejemplo: "USD"
El "All-in Rate" (Valor Efetivo Total/Total Effective Cost), que representa el costo total de la operación. Es requerido cuando se programa que la operación se liquide dentro de los dos días posteriores a operation_requested_at y no excede los $100,000 USD.
Ejemplo: 1000.000004
La moneda del VET (siempre BRL). Obligatorio si tev_amount_amount no es null.
Ejemplo: "BRL"
El porcentaje del valor de la moneda extranjera que se otorgó al cliente por adelantado. En el caso de que la operación de cambio esté programada para liquidarse dentro de los dos días posteriores a operation_requested_at, este valor puede ser null.
Ejemplo: 0.12
El método de entrega para la moneda extranjera.
Devolvemos uno de los siguientes valores del enum:
CARTA_CREDITO_A_VISTA(Código 10) - Carta de crédito a la vistaCARTA_CREDITO_A_PRAZO(Código 15) - Carta de crédito a plazoCONTA_DEPOSITO(Código 20) - Cuenta de depósitoCONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS(Código 21) - Cuenta de depósito en moneda extranjera en el paísCONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR(Código 22) - Cuenta de depósito del exportador mantenida en el exteriorCONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR(Código 23) - Cuenta de depósito o pago al exportador en institución extranjeraCONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS(Código 25) - Convenio de pagos y créditos recíprocosCHEQUE(Código 30) - ChequeESPECIE_CHEQUES_VIAGEM(Código 50) - Efectivo o cheques de viajeroCARTAO_PREPAGO(Código 55) - Tarjeta prepagaTELETRANSMISSAO(Código 65) - Transferencia electrónicaTITULOS_VALORES(Código 75) - Títulos/bonosSIMBOLICA(Código 90) - SimbólicaSEM_MOVIMENTACAO_VALORES(Código 91) - Sin movimiento de fondosDEMAIS(Código 99) - OtrosOUTRO_NAO_MAPEADO_OFB- Otro no mapeado por Open Finance Brazilnull
Enum"CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS""CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR""ESPECIE_CHEQUES_VIAGEM""CARTAO_PREPAGO""TELETRANSMISSAO""SEM_MOVIMENTACAO_VALORES""DEMAIS""CARTA_CREDITO_A_VISTA""CARTA_CREDITO_A_PRAZO""CONTA_DEPOSITO"
Ejemplo: "CARTA_CREDITO_A_PRAZO"
El código de 5 dígitos del Banco Central que clasifica la "naturaleza" de la operación.
Este código debe cumplir con los códigos de naturaleza referenciados en la Resolución 277 o Circular 3690, según corresponda al contrato de cambio.
Ejemplo: "90302"
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "collected_at": "2022-02-09T08:45:50.406032Z", "operation_identifier": "92792126019929240", "operation_number": "393874649456", "operation_type": "COMPRA", "operation_requested_at": "2023-03-07T08:30:00Z", "authorized_institution_identifier": 11225860000140, "authorized_institution_name": "AGENCIA CORRETORA", "intermediary_institution_identifier": 11225860000140, "intermediary_institution_name": "AGENCIA CORRETORA", "operation_due_date": "2018-02-15", "local_operation_tax_amount": 1.3, "local_operation_tax_currency": "BRL", "local_operation_value_amount": 1000.04, "local_operation_value_currency": "BRL", "foreign_operation_value_amount": 1000.04, "foreign_operation_value_currency": "USD", "operation_outstanding_balance_amount": 1000.04, "operation_outstanding_balance_currency": "USD", "tev_amount_amount": 1000.000004, "tev_amount_currency": "BRL", "local_currency_advance_percentage": 0.12, "settlement_method": "CARTA_CREDITO_A_PRAZO", "operation_category_code": "90302" }
Objeto de Historial de Intercambio (Brasil)
Detalles sobre los eventos de modificación para una operación de intercambio en la Red de Finanzas Abiertas de Brasil.
Cada entrada en el historial representa un evento de modificación (una pista de auditoría) para una operación de intercambio. El objeto Exchange contiene los datos originales del contrato, mientras que cualquier cambio en el contrato (alteraciones, cambios en los acuerdos, etc.) se registra como eventos en el historial.
Identificador único de Belvo para el elemento actual.
Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
El link.id al que pertenecen los datos.
Ejemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
El identificador único generado por Belvo para la operación de intercambio original.
Ejemplo: "c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321"
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"
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
Ejemplo: "2022-02-09T08:45:50.406032Z"
El identificador único de la red para la operación de intercambio.
Ejemplo: "92792126019929240"
El número de secuencia del registro del evento en el Banco Central (Bacen).
Ejemplo: "493874649457"
El tipo de evento que ocurrió para la operación de intercambio.
Devolvemos uno de los siguientes valores de 'enum':
1- Contrato en el mercado primario2- Modificación de la operación de intercambio en el mercado primario3- Cancelación de la operación de intercambio en el mercado primario4- Liquidación de la operación de intercambio en el mercado primario5- Anulación del monto pendiente por liquidar en el mercado primario6- Restablecimiento del monto pendiente anulado en el mercado primario9- Anulación de la operación de intercambio en el mercado primario (utilizado, por ejemplo, en la anulación de un evento de liquidación/cancelación)
Nota: Los códigos siguen el formato de mensajería enviado por las instituciones al Banco Central de Brasil.
Enum1234569
Ejemplo: 2
La marca de tiempo ISO-8601 cuando ocurrió el evento.
Ejemplo: "2023-03-10T14:00:00Z"
operation_due_datestring or null(date)= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...
La fecha en la que la operación (compra o venta), después del evento, está programada para ser liquidada, en formato YYYY-MM-DD.
Ejemplo: "2023-03-20"
El tipo de cambio aplicado a la operación después del evento.
Ejemplo: 1.4
El código de moneda de tres letras (ISO-4217) para la tasa de cambio.
Ejemplo: "BRL"
El valor total de la operación en moneda local después del evento.
Ejemplo: 950
El código de moneda de tres letras (ISO-4217) para la moneda local.
Ejemplo: "BRL"
El valor total de la operación en moneda extranjera después del evento.
Ejemplo: 678.57
El código de moneda de tres letras (ISO-4217) para la moneda extranjera.
Ejemplo: "USD"
El saldo pendiente a liquidar en moneda extranjera después del evento.
Este campo es obligatorio para eventos creados (event_created_at) a partir del 15 de abril de 2024, en casos de operaciones de cambio con liquidación futura.
Ejemplo: 678.57
La moneda del saldo pendiente. Obligatorio si operation_outstanding_balance_amount no es null.
Ejemplo: "USD"
El "All-in Rate" (Valor Efetivo Total/Total Effective Cost), que representa el costo total de la operación después del evento.
Este campo es obligatorio para operaciones de cambio al contado que alcancen hasta el límite de $100,000 USD o su equivalente en otras monedas.
Ejemplo: 1002
La moneda del VET (siempre BRL). Obligatorio si tev_amount_amount no es null.
Ejemplo: "BRL"
El porcentaje del valor de la moneda extranjera que se otorgó al cliente por adelantado después del evento.
Este campo es obligatorio en casos de operaciones de cambio con liquidación futura.
Ejemplo: 0.12
El método de entrega para la moneda extranjera.
Devolvemos uno de los siguientes valores del enum:
CARTA_CREDITO_A_VISTA(Código 10) - Carta de crédito a la vistaCARTA_CREDITO_A_PRAZO(Código 15) - Carta de crédito a plazoCONTA_DEPOSITO(Código 20) - Cuenta de depósitoCONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS(Código 21) - Cuenta de depósito en moneda extranjera en el paísCONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR(Código 22) - Cuenta de depósito del exportador mantenida en el exteriorCONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR(Código 23) - Cuenta de depósito o pago al exportador en institución extranjeraCONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS(Código 25) - Convenio de pagos y créditos recíprocosCHEQUE(Código 30) - ChequeESPECIE_CHEQUES_VIAGEM(Código 50) - Efectivo o cheques de viajeroCARTAO_PREPAGO(Código 55) - Tarjeta prepagaTELETRANSMISSAO(Código 65) - Transferencia electrónicaTITULOS_VALORES(Código 75) - Títulos/bonosSIMBOLICA(Código 90) - SimbólicaSEM_MOVIMENTACAO_VALORES(Código 91) - Sin movimiento de fondosDEMAIS(Código 99) - OtrosOUTRO_NAO_MAPEADO_OFB- Otro no mapeado por Open Finance Brazilnull
Enum"CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS""CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR""ESPECIE_CHEQUES_VIAGEM""CARTAO_PREPAGO""TELETRANSMISSAO""SEM_MOVIMENTACAO_VALORES""DEMAIS""CARTA_CREDITO_A_VISTA""CARTA_CREDITO_A_PRAZO""CONTA_DEPOSITO"
Ejemplo: "CARTA_CREDITO_A_PRAZO"
El código de 5 dígitos del Banco Central que clasifica la "naturaleza" de la operación.
Este código debe cumplir con los códigos de naturaleza referenciados en la Resolución 277 o Circular 3690, según corresponda al contrato de cambio.
Ejemplo: "90302"
El código que indica la relación entre el cliente y el pagador/receptor extranjero.
Este código debe cumplir con los códigos de relación referenciados en la Resolución 277 o Circular 3690, según corresponda al contrato de cambio.
Nota: Este campo es opcional cuando:
- El campo
settlement_methodesESPECIE_CHEQUES_VIAGEMoCARTAO_PREPAGO.- El campo
event_typees diferente de4(Liquidación de operación de cambio en el mercado primario).Si la institución tiene esta información, es obligatorio enviarla. Si la información se actualiza después de la contratación, debe enviarse a través de eventos.
Ejemplo: "50"
El nombre del pagador o receptor extranjero.
Nota: Este campo es opcional cuando:
- El campo
settlement_methodesESPECIE_CHEQUES_VIAGEMoCARTAO_PREPAGO.- El campo
event_typees diferente de4(Liquidación de operación de cambio en el mercado primario).Si la institución tiene esta información, es obligatorio enviarla. Si la información se actualiza después de la contratación, debe enviarse a través de eventos.
Ejemplo: "Global Tech Imports LLC"
El código de país del pagador o receptor extranjero, siguiendo el estándar ISO 3166-1.
Nota: Este campo es opcional cuando:
- El campo
settlement_methodesESPECIE_CHEQUES_VIAGEMoCARTAO_PREPAGO.- El campo
event_typees diferente de4(Liquidación de operación de cambio en el mercado primario).Si la institución tiene esta información, es obligatorio enviarla. Si la información se actualiza después de la contratación, debe enviarse a través de eventos.
Ejemplo: "US"
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "exchange_id": "c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321", "created_at": "2022-02-09T08:45:50.406032Z", "collected_at": "2022-02-09T08:45:50.406032Z", "operation_identifier": "92792126019929240", "event_sequence_number": "493874649457", "event_type": 2, "event_created_at": "2023-03-10T14:00:00Z", "operation_due_date": "2023-03-20", "local_operation_tax_amount": 1.4, "local_operation_tax_currency": "BRL", "local_operation_value_amount": 950, "local_operation_value_currency": "BRL", "foreign_operation_value_amount": 678.57, "foreign_operation_value_currency": "USD", "operation_outstanding_balance_amount": 678.57, "operation_outstanding_balance_currency": "USD", "tev_amount_amount": 1002, "tev_amount_currency": "BRL", "local_currency_advance_percentage": 0.12, "settlement_method": "CARTA_CREDITO_A_PRAZO", "operation_category_code": "90302", "foreign_partie_relationship_code": "50", "foreign_partie_name": "Global Tech Imports LLC", "foreign_partie_country_code": "US" }
Solicitud
Próximamente
Este endpoint está actualmente en desarrollo. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo.
Con el método List Exchanges, puedes:
- [Requerido] Listar intercambios relacionados con un
link.idespecífico (usando el parámetro de consultalink). - Obtener los detalles de un
exchange.idespecífico (usando el parámetro de consultaid).
Consulta la lista de campos a continuación por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas.
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.
Seguridad
basicAuth
Consulta
El link.id por el que deseas filtrar.
Ejemplo: link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4
Devuelve información solo para este recurso id.
Ejemplo: id=24ccab1d-3a86-4136-a6eb-e04bf52b356f
Devuelve resultados solo para estos link.ids.
Ejemplo: link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6
Devuelve información para estos ids de recursos.
Ejemplo: id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6
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
Un número de página dentro del conjunto de resultados paginados.
Ejemplo: page=1
Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve los elementos que fueron recuperados de la institución en esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
Ejemplo: collected_at=2022-05-01
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
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
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
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
Devolver elementos que fueron recuperados de la institución entre dos fechas (YYYY-MM-DD o marca de tiempo completa ISO-8601). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
Ejemplo: collected_at__range=2022-01-01,2022-12-31
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
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
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
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
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
Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD). El primer valor indica el inicio del rango y el segundo valor indica el final del rango.
Ejemplo: created_at__range=2022-01-01,2022-12-31
- Sandboxhttps://sandbox.belvo.com/api/br/exchanges/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://sandbox.belvo.com/api/br/exchanges/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&page_size=100&page=1&omit=string&fields=string&collected_at=2022-05-01&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-01-01%2C2022-12-31&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-01-01%2C2022-12-31'OK - Intercambios recuperados
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"
La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.
Ejemplo: null
Respuesta
application/json
{ "count": 130, "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2", "previous": null, "results": [ { … } ] }
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)
SchemasOperaciones
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)
SchemasOperaciones
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.
SchemasOperaciones
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.
SchemasOperaciones
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.
SchemasOperaciones
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 único punto 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.
Operaciones