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

Completar una solicitud de facturas

Solicitud

Se utiliza para reanudar una sesión de recuperación de Factura que se pausó porque la institución requería un token MFA.

Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para obtener más información.

Seguridad
basicAuth
Consulta
omitstring

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

fieldsstring

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

Cuerpoapplication/jsonrequerido
sessionstring[a-f0-9]{32}requerido

La sesión que deseas reanudar. Necesitas usar el valor de session que se proporciona en la respuesta 428 Token Required que recibes después de realizar tu solicitud POST.

Ejemplo: "6e7b283c6efa449c9c028a16b5c249fa"
tokenstring

El token MFA generado por la institución que se requiere para continuar una sesión.

Ejemplo: "1234ab"
linkstring(uuid)requerido

El link.id que deseas reanudar. Debe ser el mismo link.id que recibes en la respuesta 428 Token Required que contiene el ID de session.

Ejemplo: "683005d6-f45c-4adb-b289-f1a12f50f80c"
save_databoolean

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

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

Predeterminado true
Ejemplo: true
curl -i -X PATCH \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/invoices/?omit=string&fields=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "session": "6e7b283c6efa449c9c028a16b5c249fa",
    "token": "1234ab",
    "link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
    "save_data": true
  }'

Respuestas

Ok (cuando save_data=false)

Cuerpoapplication/jsonArray [
idstring(uuid)

Identificador único de Belvo para el elemento actual.

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

El link.id al que pertenecen los datos.

Ejemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
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"
invoice_identificationstring or nullrequerido

El ID único de la institución fiscal para la factura.

Ejemplo: "A1A1A1A1-2B2B-3C33-D44D-555555E55EE"
invoice_datestring or nullrequerido

La fecha de la factura, en formato YYYY-MM-DD.

Ejemplo: "2019-12-01"
statusstring or nullrequerido

El estado de la factura. Puede ser Vigente (válido) o Cancelado (cancelado).

Ejemplo: "Vigente"
invoice_typestring or nullrequerido

La clasificación de la factura por parte de la institución fiscal.

Para el SAT de México, devolvemos uno de los siguientes valores:

  • Egreso
  • Ingreso
  • Nómina
  • Pago
  • Traslado
Enum"Egreso""Ingreso""Nómina""Pago""Traslado"
Ejemplo: "Ingreso"
typestring or nullrequerido

La dirección de la factura (desde la perspectiva del propietario del Link).

  • OUTFLOW indica una factura enviada.
  • INFLOW indica una factura recibida.
Enum"OUTFLOW""INFLOW"null
Ejemplo: "INFLOW"
tax_detailsobject

Información general sobre los impuestos de la factura.

sender_idstring or nullrequerido

El ID fiscal del remitente de la factura

Ejemplo: "AAA111111AA11"
sender_fiscal_regimestring or null

El régimen fiscal del remitente, según lo definido por la entidad legal en el país.

Ejemplo: "601"
sender_namestring or nullrequerido

El nombre del remitente de la factura.

Ejemplo: "ACME CORP"
sender_tax_fraud_statusstring or null

Indica si el remitente está o no en la lista de fraude fiscal del SAT por haber presentado datos incorrectos, tener pagos pendientes o haber realizado negocios que violan las regulaciones de la institución fiscal.

El SAT actualiza la lista de fraude fiscal cada tres meses.

Para más información sobre las razones por las cuales un contribuyente puede ser incluido en la lista de fraude fiscal, consulte el Artículo 69 y el Artículo 69-B del Código Fiscal de la Federación de México.

Los estados posibles son:

  • INVESTIGATING
    La institución fiscal ha identificado irregularidades y ha abierto una investigación sobre el contribuyente.
  • DISMISSED
    La institución fiscal ha investigado al contribuyente y lo ha declarado inocente.
  • CONFIRMED
    La institución fiscal ha confirmado que el contribuyente es culpable.
  • OVERTURNED
    La institución fiscal ha reevaluado a un contribuyente previamente confirmado y, basándose en nueva evidencia, lo ha retirado de la lista de fraude fiscal.
  • NO_TAX_FRAUD_STATUS
    El receptor o remitente no se encuentra en la lista (en otras palabras, están cumpliendo con las regulaciones de la institución fiscal).
Ejemplo: "NO_TAX_FRAUD_STATUS"
receiver_idstring or nullrequerido

El ID fiscal del receptor de la factura.

Ejemplo: "BBB222222BB22"
receiver_postal_codestring

El código postal del receptor.

Ejemplo: "11560"
receiver_fiscal_regimestring or null

El régimen fiscal del receptor, según lo definido por la entidad legal en el país.

Ejemplo: "601"
receiver_namestring or nullrequerido

El nombre del receptor de la factura.

Ejemplo: "BELVO CORP"
receiver_tax_fraud_statusstring or null

Indica si el receptor está o no en la lista de fraude fiscal del SAT por haber presentado datos incorrectos, tener pagos pendientes o haber realizado negocios que violan las regulaciones de la institución fiscal.

El SAT actualiza la lista de fraude fiscal cada tres meses.

Para obtener más información sobre las razones por las cuales un contribuyente puede ser incluido en la lista de fraude fiscal, consulte el Artículo 69 y el Artículo 69-B del Código Fiscal de la Federación de México.

Los estados posibles son:

  • INVESTIGATING
    La institución fiscal ha identificado irregularidades y ha abierto una investigación sobre el contribuyente.
  • DISMISSED
    La institución fiscal ha investigado al contribuyente y lo ha declarado inocente.
  • CONFIRMED
    La institución fiscal ha confirmado que el contribuyente es culpable.
  • OVERTURNED
    La institución fiscal ha reevaluado a un contribuyente previamente confirmado y, basándose en nueva evidencia, lo ha retirado de la lista de fraude fiscal.
  • NO_TAX_FRAUD_STATUS
    El receptor o emisor no se encuentra en la lista (en otras palabras, está cumpliendo con las regulaciones de la institución fiscal).
Ejemplo: "NO_TAX_FRAUD_STATUS"
cancelation_statusstring or nullrequerido

Si la factura es cancelada, este campo indica el estado de la cancelación.

cancelation_update_datestring or null(date)requerido

La fecha de la cancelación de la factura, en formato YYYY-MM-DD.

Ejemplo: "2019-12-02"
certification_datestring or null(date)requerido

La fecha de la certificación fiscal, en formato YYYY-MM-DD.

Ejemplo: "2019-12-01"
certification_authoritystring or nullrequerido

El ID fiscal del proveedor de certificación.

Ejemplo: "CCC333333CC33"
payment_typestring or nullrequerido

El código de tipo de pago utilizado para esta factura, según lo definido por la entidad legal del país.

Ejemplo: "99"
payment_methodstring or null

El código del método de pago utilizado para esta factura, según lo definido por la entidad legal del país.

Enum"PUE""PPD"null
Ejemplo: "PUE"
usagestring or null

El código de uso de la factura, tal como lo define la entidad legal del país.

Ejemplo: "P01"
versionstring or null

La versión CFDI de la factura.

Ejemplo: "3.3"
place_of_issuestring or null

El código postal de donde se emitió la factura.

Ejemplo: "01165"
invoice_detailsArray of objectsrequerido

Una lista de descripciones para cada artículo (producto comprado o servicio prestado) en la factura.

collected_atstring(date-time)

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

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

La descripción del artículo de la factura (una factura puede tener uno o más artículos).

Ejemplo: "December 2019 accounting fees"
product_identificationstring or nullrequerido

El código de identificación del producto o del servicio, tal como lo define la entidad legal en el país.\n- \U0001F1F2\U0001F1FD México.

Ejemplo: "84101600"
quantitynumber or null(float)requerido

La cantidad de este artículo de factura.

Ejemplo: 10
unit_codestring or nullrequerido

La unidad de medida, según lo definido por la entidad legal en el país. \n- \U0001F1F2\U0001F1FD México Referencia del catálogo SAT.

Ejemplo: "E48"
unit_descriptionstring or nullrequerido

La descripción del artículo, según lo definido por la entidad legal en el país.\n- \U0001F1F2\U0001F1FD México Referencia del catálogo SAT.

Ejemplo: "Unidad de servicio"
unit_amountnumber or null(float)requerido

El precio de un artículo singular.

Ejemplo: 200
tax_typestring or null

El tipo de impuesto del artículo.

Ejemplo: null
pre_tax_amountnumber or null(float)requerido

El precio total de este artículo antes de aplicar impuestos es (quantity x unit_amount).

Ejemplo: 400
tax_percentagenumber or null(float)requerido

El porcentaje de impuesto a aplicar.

Ejemplo: 16
tax_amountnumber or null(float)requerido

El monto del impuesto para este artículo de factura (pre_tax_amount x tax_percentage).

Ejemplo: 64
total_amountnumber or null(float)requerido

El precio total para este artículo de factura (pre_tax_amount + tax_amount).

Ejemplo: 464
retained_taxesArray of objects

El impuesto retenido en el artículo de la factura.

transferred_taxesArray of objects

Los impuestos transferidos relacionados con la factura.

currencystring or nullrequerido

La moneda de la factura. Por ejemplo:

  • 🇧🇷 BRL (Real Brasileño)
  • 🇨🇴 COP (Peso Colombiano)
  • 🇲🇽 MXN (Peso Mexicano)
  • 🇺🇸 USD (Dólar Estadounidense)
Ejemplo: "MXN"
subtotal_amountnumber or null(float)requerido

El monto antes de impuestos de esta factura (suma del pre_tax_amount de cada artículo).

Ejemplo: 400
exchange_ratenumber or null(float)requerido

El tipo de cambio utilizado en esta factura para la moneda.

Ejemplo: 0.052
tax_amountnumber or null(float)requerido

El monto del impuesto para esta factura (suma del tax_amount de cada artículo).

Ejemplo: 64
discount_amountnumber or null(float)requerido

El monto total descontado en esta factura.

Ejemplo: 10
total_amountnumber or null(float)requerido

El monto total de la factura (subtotal_amount + tax_amount - discount_amount)

Ejemplo: 454
related_invoicesArray of objects

Una lista de facturas relacionadas.

paymentsArray of objectsrequerido

Una lista que detalla todos los pagos de facturas.

datestring or null(date-time)requerido

Marca de tiempo ISO-8601 cuando se realizó el pago.

Ejemplo: "2020-03-17T12:00:00.000Z"
payment_typestring or nullrequerido

Código de tipo de pago utilizado para esta factura, según lo definido por la entidad legal del país.

Ejemplo: "03"
currencystring or nullrequerido

La moneda del pago. 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: "BRL"
exchange_ratestring or nullrequerido

La tasa de cambio de currency a MXN cuando se realizó el pago.

Ejemplo: "3.75"
amountnumber or null(float)requerido

El monto de la factura, en la moneda de la factura original.

Ejemplo: 8000.5
operation_numberstring or nullrequerido

El identificador interno de la institución fiscal para la operación.

Ejemplo: "831840"
beneficiary_rfcstring or null

El ID fiscal del beneficiario del pago.

Ejemplo: "BNM840515VB1"
beneficiary_account_numberstring or nullrequerido

El número de cuenta bancaria del beneficiario del pago.

Ejemplo: "12343453245633"
payer_rfcstring or nullrequerido

El ID fiscal del emisor del pago.

Ejemplo: "BKJM840515VB1"
payer_account_numberstring or nullrequerido

El número de cuenta bancaria del emisor del pago.

Ejemplo: "13343663245699"
payer_bank_namestring or nullrequerido

La institución bancaria que fue utilizada por el emisor del pago.

Ejemplo: "CITI BANAMEX"
related_documentsArray of objectsrequerido

Una lista de todas las facturas diferidas relacionadas afectadas por el pago.

invoice_identificationstring or nullrequerido

El ID único de la institución fiscal para la factura diferida relacionada.

Ejemplo: "7EE015F3-6311-11EA-B02A-00155D014007"
currencystring or nullrequerido

La moneda de la factura relacionada. 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"
payment_methodstring or nullrequerido

El método de pago de la factura relacionada.

Ejemplo: "PPD"
partiality_numberinteger(int32)

El número de cuota de pago.

Ejemplo: 1
previous_balancenumber or null(float)requerido

El monto de la factura antes del pago.

Ejemplo: 18877.84
amount_paidnumber or null(float)requerido

El monto pagado en esta cuota.

Ejemplo: 8000
outstanding_balancenumber or null(float)requerido

El monto restante por pagar.

Ejemplo: 10877.84
payrollobject or nullrequerido

Detalles sobre el pago de nómina. Solo aplicable para facturas de nómina.

daysinteger or null(int32)requerido

El número de días cubiertos por el pago.

Ejemplo: 30
typestring or nullrequerido

El tipo de nómina, según lo definido por la entidad legal del país.

Ejemplo: "O"
amountnumber(float)requerido

El monto total del pago de nómina.

Ejemplo: 20400.1
versionstringrequerido

La versión del objeto de nómina.

Ejemplo: "1.2"
date_fromstring or null(date)requerido

La fecha de inicio del período de pago, en formato YYYY-MM-DD.

Ejemplo: "2018-07-01"
date_tostring or null(date)requerido

La fecha de finalización del período de pago, en formato YYYY-MM-DD.

Ejemplo: "2018-07-31"
collected_atstring(date-time)

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

Ejemplo: "2022-02-09T08:45:50.406032Z"
payment_datestring(date)requerido

La fecha de pago, en formato YYYY-MM-DD.

Ejemplo: "2018-07-16"
periodicitystring or null

Con qué frecuencia se realiza el pago de nómina.

Para el SAT de México, devolvemos uno de los siguientes valores:

  • DAILY
  • WEEKLY
  • TENTH_DAY
  • FOURTEENTH_DAY
  • FIFTEENTH_DAY
  • MONTHLY
  • BIMONTHLY
  • PER_TASK
  • COMMISSION
  • ONE_OFF
  • OTHER_PERIODICITY
Enum"DAILY""WEEKLY""TENTH_DAY""FOURTEENTH_DAY""FIFTEENTH_DAY""MONTHLY""BIMONTHLY""PER_TASK""COMMISSION""ONE_OFF"
Ejemplo: "MONTHLY"
earnings_breakdownArray of objects or null or null

Un desglose de las ganancias para el pago de nómina.

tax_deductionsArray of objects or null or null

Un desglose de las deducciones fiscales en el pago de nómina.

other_paymentsArray of objects or null or null

Un desglose de otros pagos para la nómina.

foliostring or null

El número de control interno que el contribuyente asigna a la factura.

Ejemplo: "26"
export_typestring or null

El tipo de exportación de la factura, según lo definido por la entidad legal en el país. Para más información, consulta nuestro artículo de referencia del catálogo SAT.

Ejemplo: "01"
xmlstring or null

XML del documento de factura.

warningsobject or null

Objeto que contiene información sobre cualquier advertencia relacionada con esta factura.

payment_type_descriptionstring or nullObsoletorequerido

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

Ejemplo: null
payment_method_descriptionstring 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 descripción del método de pago utilizado para esta factura.

Ejemplo: null
sender_blacklist_statusstring 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 sender_tax_fraud_status en su lugar.

Ejemplo: null
receiver_blacklist_statusstring 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 receiver_tax_fraud_status en su lugar.

Ejemplo: null
]
Respuesta
application/json
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "invoice_identification": "A1A1A1A1-2B2B-3C33-D44D-555555E55EE", "invoice_date": "2019-12-01", "status": "Vigente", "invoice_type": "Ingreso", "type": "INFLOW", "tax_details": {}, "sender_id": "AAA111111AA11", "sender_fiscal_regime": "601", "sender_name": "ACME CORP", "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "receiver_id": "BBB222222BB22", "receiver_postal_code": "11560", "receiver_fiscal_regime": "601", "receiver_name": "BELVO CORP", "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "cancelation_status": "string", "cancelation_update_date": "2019-12-02", "certification_date": "2019-12-01", "certification_authority": "CCC333333CC33", "payment_type": "99", "payment_type_description": null, "payment_method": "PUE", "payment_method_description": null, "usage": "P01", "version": "3.3", "place_of_issue": "01165", "invoice_details": [], "currency": "MXN", "subtotal_amount": 400, "exchange_rate": 0.052, "tax_amount": 64, "discount_amount": 10, "total_amount": 454, "related_invoices": [], "payments": [], "payroll": {}, "folio": "26", "export_type": "01", "xml": "string", "warnings": {}, "sender_blacklist_status": null, "receiver_blacklist_status": null } ]

Obtener los detalles de una factura

Solicitud

Obtener los detalles de una factura específica.

Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.

Seguridad
basicAuth
Ruta
idstring(uuid)requerido

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

Respuestas

De acuerdo

Cuerpoapplication/json
idstring(uuid)

Identificador único de Belvo para el elemento actual.

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

El link.id al que pertenecen los datos.

Ejemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
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"
invoice_identificationstring or nullrequerido

El ID único de la institución fiscal para la factura.

Ejemplo: "A1A1A1A1-2B2B-3C33-D44D-555555E55EE"
invoice_datestring or nullrequerido

La fecha de la factura, en formato YYYY-MM-DD.

Ejemplo: "2019-12-01"
statusstring or nullrequerido

El estado de la factura. Puede ser Vigente (válido) o Cancelado (cancelado).

Ejemplo: "Vigente"
invoice_typestring or nullrequerido

La clasificación de la factura por parte de la institución fiscal.

Para el SAT de México, devolvemos uno de los siguientes valores:

  • Egreso
  • Ingreso
  • Nómina
  • Pago
  • Traslado
Enum"Egreso""Ingreso""Nómina""Pago""Traslado"
Ejemplo: "Ingreso"
typestring or nullrequerido

La dirección de la factura (desde la perspectiva del propietario del Link).

  • OUTFLOW indica una factura enviada.
  • INFLOW indica una factura recibida.
Enum"OUTFLOW""INFLOW"null
Ejemplo: "INFLOW"
tax_detailsobject

Información general sobre los impuestos de la factura.

sender_idstring or nullrequerido

El ID fiscal del remitente de la factura

Ejemplo: "AAA111111AA11"
sender_fiscal_regimestring or null

El régimen fiscal del remitente, según lo definido por la entidad legal en el país.

Ejemplo: "601"
sender_namestring or nullrequerido

El nombre del remitente de la factura.

Ejemplo: "ACME CORP"
sender_tax_fraud_statusstring or null

Indica si el remitente está o no en la lista de fraude fiscal del SAT por haber presentado datos incorrectos, tener pagos pendientes o haber realizado negocios que violan las regulaciones de la institución fiscal.

El SAT actualiza la lista de fraude fiscal cada tres meses.

Para más información sobre las razones por las cuales un contribuyente puede ser incluido en la lista de fraude fiscal, consulte el Artículo 69 y el Artículo 69-B del Código Fiscal de la Federación de México.

Los estados posibles son:

  • INVESTIGATING
    La institución fiscal ha identificado irregularidades y ha abierto una investigación sobre el contribuyente.
  • DISMISSED
    La institución fiscal ha investigado al contribuyente y lo ha declarado inocente.
  • CONFIRMED
    La institución fiscal ha confirmado que el contribuyente es culpable.
  • OVERTURNED
    La institución fiscal ha reevaluado a un contribuyente previamente confirmado y, basándose en nueva evidencia, lo ha retirado de la lista de fraude fiscal.
  • NO_TAX_FRAUD_STATUS
    El receptor o remitente no se encuentra en la lista (en otras palabras, están cumpliendo con las regulaciones de la institución fiscal).
Ejemplo: "NO_TAX_FRAUD_STATUS"
receiver_idstring or nullrequerido

El ID fiscal del receptor de la factura.

Ejemplo: "BBB222222BB22"
receiver_postal_codestring

El código postal del receptor.

Ejemplo: "11560"
receiver_fiscal_regimestring or null

El régimen fiscal del receptor, según lo definido por la entidad legal en el país.

Ejemplo: "601"
receiver_namestring or nullrequerido

El nombre del receptor de la factura.

Ejemplo: "BELVO CORP"
receiver_tax_fraud_statusstring or null

Indica si el receptor está o no en la lista de fraude fiscal del SAT por haber presentado datos incorrectos, tener pagos pendientes o haber realizado negocios que violan las regulaciones de la institución fiscal.

El SAT actualiza la lista de fraude fiscal cada tres meses.

Para obtener más información sobre las razones por las cuales un contribuyente puede ser incluido en la lista de fraude fiscal, consulte el Artículo 69 y el Artículo 69-B del Código Fiscal de la Federación de México.

Los estados posibles son:

  • INVESTIGATING
    La institución fiscal ha identificado irregularidades y ha abierto una investigación sobre el contribuyente.
  • DISMISSED
    La institución fiscal ha investigado al contribuyente y lo ha declarado inocente.
  • CONFIRMED
    La institución fiscal ha confirmado que el contribuyente es culpable.
  • OVERTURNED
    La institución fiscal ha reevaluado a un contribuyente previamente confirmado y, basándose en nueva evidencia, lo ha retirado de la lista de fraude fiscal.
  • NO_TAX_FRAUD_STATUS
    El receptor o emisor no se encuentra en la lista (en otras palabras, está cumpliendo con las regulaciones de la institución fiscal).
Ejemplo: "NO_TAX_FRAUD_STATUS"
cancelation_statusstring or nullrequerido

Si la factura es cancelada, este campo indica el estado de la cancelación.

cancelation_update_datestring or null(date)requerido

La fecha de la cancelación de la factura, en formato YYYY-MM-DD.

Ejemplo: "2019-12-02"
certification_datestring or null(date)requerido

La fecha de la certificación fiscal, en formato YYYY-MM-DD.

Ejemplo: "2019-12-01"
certification_authoritystring or nullrequerido

El ID fiscal del proveedor de certificación.

Ejemplo: "CCC333333CC33"
payment_typestring or nullrequerido

El código de tipo de pago utilizado para esta factura, según lo definido por la entidad legal del país.

Ejemplo: "99"
payment_methodstring or null

El código del método de pago utilizado para esta factura, según lo definido por la entidad legal del país.

Enum"PUE""PPD"null
Ejemplo: "PUE"
usagestring or null

El código de uso de la factura, tal como lo define la entidad legal del país.

Ejemplo: "P01"
versionstring or null

La versión CFDI de la factura.

Ejemplo: "3.3"
place_of_issuestring or null

El código postal de donde se emitió la factura.

Ejemplo: "01165"
invoice_detailsArray of objectsrequerido

Una lista de descripciones para cada artículo (producto comprado o servicio prestado) en la factura.

collected_atstring(date-time)

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

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

La descripción del artículo de la factura (una factura puede tener uno o más artículos).

Ejemplo: "December 2019 accounting fees"
product_identificationstring or nullrequerido

El código de identificación del producto o del servicio, tal como lo define la entidad legal en el país.\n- \U0001F1F2\U0001F1FD México.

Ejemplo: "84101600"
quantitynumber or null(float)requerido

La cantidad de este artículo de factura.

Ejemplo: 10
unit_codestring or nullrequerido

La unidad de medida, según lo definido por la entidad legal en el país. \n- \U0001F1F2\U0001F1FD México Referencia del catálogo SAT.

Ejemplo: "E48"
unit_descriptionstring or nullrequerido

La descripción del artículo, según lo definido por la entidad legal en el país.\n- \U0001F1F2\U0001F1FD México Referencia del catálogo SAT.

Ejemplo: "Unidad de servicio"
unit_amountnumber or null(float)requerido

El precio de un artículo singular.

Ejemplo: 200
tax_typestring or null

El tipo de impuesto del artículo.

Ejemplo: null
pre_tax_amountnumber or null(float)requerido

El precio total de este artículo antes de aplicar impuestos es (quantity x unit_amount).

Ejemplo: 400
tax_percentagenumber or null(float)requerido

El porcentaje de impuesto a aplicar.

Ejemplo: 16
tax_amountnumber or null(float)requerido

El monto del impuesto para este artículo de factura (pre_tax_amount x tax_percentage).

Ejemplo: 64
total_amountnumber or null(float)requerido

El precio total para este artículo de factura (pre_tax_amount + tax_amount).

Ejemplo: 464
retained_taxesArray of objects

El impuesto retenido en el artículo de la factura.

transferred_taxesArray of objects

Los impuestos transferidos relacionados con la factura.

currencystring or nullrequerido

La moneda de la factura. Por ejemplo:

  • 🇧🇷 BRL (Real Brasileño)
  • 🇨🇴 COP (Peso Colombiano)
  • 🇲🇽 MXN (Peso Mexicano)
  • 🇺🇸 USD (Dólar Estadounidense)
Ejemplo: "MXN"
subtotal_amountnumber or null(float)requerido

El monto antes de impuestos de esta factura (suma del pre_tax_amount de cada artículo).

Ejemplo: 400
exchange_ratenumber or null(float)requerido

El tipo de cambio utilizado en esta factura para la moneda.

Ejemplo: 0.052
tax_amountnumber or null(float)requerido

El monto del impuesto para esta factura (suma del tax_amount de cada artículo).

Ejemplo: 64
discount_amountnumber or null(float)requerido

El monto total descontado en esta factura.

Ejemplo: 10
total_amountnumber or null(float)requerido

El monto total de la factura (subtotal_amount + tax_amount - discount_amount)

Ejemplo: 454
related_invoicesArray of objects

Una lista de facturas relacionadas.

paymentsArray of objectsrequerido

Una lista que detalla todos los pagos de facturas.

datestring or null(date-time)requerido

Marca de tiempo ISO-8601 cuando se realizó el pago.

Ejemplo: "2020-03-17T12:00:00.000Z"
payment_typestring or nullrequerido

Código de tipo de pago utilizado para esta factura, según lo definido por la entidad legal del país.

Ejemplo: "03"
currencystring or nullrequerido

La moneda del pago. 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: "BRL"
exchange_ratestring or nullrequerido

La tasa de cambio de currency a MXN cuando se realizó el pago.

Ejemplo: "3.75"
amountnumber or null(float)requerido

El monto de la factura, en la moneda de la factura original.

Ejemplo: 8000.5
operation_numberstring or nullrequerido

El identificador interno de la institución fiscal para la operación.

Ejemplo: "831840"
beneficiary_rfcstring or null

El ID fiscal del beneficiario del pago.

Ejemplo: "BNM840515VB1"
beneficiary_account_numberstring or nullrequerido

El número de cuenta bancaria del beneficiario del pago.

Ejemplo: "12343453245633"
payer_rfcstring or nullrequerido

El ID fiscal del emisor del pago.

Ejemplo: "BKJM840515VB1"
payer_account_numberstring or nullrequerido

El número de cuenta bancaria del emisor del pago.

Ejemplo: "13343663245699"
payer_bank_namestring or nullrequerido

La institución bancaria que fue utilizada por el emisor del pago.

Ejemplo: "CITI BANAMEX"
related_documentsArray of objectsrequerido

Una lista de todas las facturas diferidas relacionadas afectadas por el pago.

invoice_identificationstring or nullrequerido

El ID único de la institución fiscal para la factura diferida relacionada.

Ejemplo: "7EE015F3-6311-11EA-B02A-00155D014007"
currencystring or nullrequerido

La moneda de la factura relacionada. 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"
payment_methodstring or nullrequerido

El método de pago de la factura relacionada.

Ejemplo: "PPD"
partiality_numberinteger(int32)

El número de cuota de pago.

Ejemplo: 1
previous_balancenumber or null(float)requerido

El monto de la factura antes del pago.

Ejemplo: 18877.84
amount_paidnumber or null(float)requerido

El monto pagado en esta cuota.

Ejemplo: 8000
outstanding_balancenumber or null(float)requerido

El monto restante por pagar.

Ejemplo: 10877.84
payrollobject or nullrequerido

Detalles sobre el pago de nómina. Solo aplicable para facturas de nómina.

daysinteger or null(int32)requerido

El número de días cubiertos por el pago.

Ejemplo: 30
typestring or nullrequerido

El tipo de nómina, según lo definido por la entidad legal del país.

Ejemplo: "O"
amountnumber(float)requerido

El monto total del pago de nómina.

Ejemplo: 20400.1
versionstringrequerido

La versión del objeto de nómina.

Ejemplo: "1.2"
date_fromstring or null(date)requerido

La fecha de inicio del período de pago, en formato YYYY-MM-DD.

Ejemplo: "2018-07-01"
date_tostring or null(date)requerido

La fecha de finalización del período de pago, en formato YYYY-MM-DD.

Ejemplo: "2018-07-31"
collected_atstring(date-time)

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

Ejemplo: "2022-02-09T08:45:50.406032Z"
payment_datestring(date)requerido

La fecha de pago, en formato YYYY-MM-DD.

Ejemplo: "2018-07-16"
periodicitystring or null

Con qué frecuencia se realiza el pago de nómina.

Para el SAT de México, devolvemos uno de los siguientes valores:

  • DAILY
  • WEEKLY
  • TENTH_DAY
  • FOURTEENTH_DAY
  • FIFTEENTH_DAY
  • MONTHLY
  • BIMONTHLY
  • PER_TASK
  • COMMISSION
  • ONE_OFF
  • OTHER_PERIODICITY
Enum"DAILY""WEEKLY""TENTH_DAY""FOURTEENTH_DAY""FIFTEENTH_DAY""MONTHLY""BIMONTHLY""PER_TASK""COMMISSION""ONE_OFF"
Ejemplo: "MONTHLY"
earnings_breakdownArray of objects or null or null

Un desglose de las ganancias para el pago de nómina.

tax_deductionsArray of objects or null or null

Un desglose de las deducciones fiscales en el pago de nómina.

other_paymentsArray of objects or null or null

Un desglose de otros pagos para la nómina.

foliostring or null

El número de control interno que el contribuyente asigna a la factura.

Ejemplo: "26"
export_typestring or null

El tipo de exportación de la factura, según lo definido por la entidad legal en el país. Para más información, consulta nuestro artículo de referencia del catálogo SAT.

Ejemplo: "01"
xmlstring or null

XML del documento de factura.

warningsobject or null

Objeto que contiene información sobre cualquier advertencia relacionada con esta factura.

payment_type_descriptionstring or nullObsoletorequerido

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

Ejemplo: null
payment_method_descriptionstring 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 descripción del método de pago utilizado para esta factura.

Ejemplo: null
sender_blacklist_statusstring 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 sender_tax_fraud_status en su lugar.

Ejemplo: null
receiver_blacklist_statusstring 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 receiver_tax_fraud_status en su lugar.

Ejemplo: null
Respuesta
application/json

Ejemplo de una factura de tipo Ingreso.

{ "id": "90d90e38-0087-4b6d-b6dc-94ea561bb9cb", "link": "1bd948f7-245d-4313-b604-34d1044cb908", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:46:20.406032Z", "invoice_identification": "862B9918-3K6H-4E0B-NAI9-2BE2D833B840", "invoice_date": "2020-12-24", "status": "Vigente", "invoice_type": "Ingreso", "type": "OUTFLOW", "sender_id": "GHTF980303F7", "sender_name": "Roberto Martinez Diaz", "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "receiver_id": "MNMK3203409H1", "receiver_name": "ACNE SA DE CV", "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "cancelation_status": null, "cancelation_update_date": null, "certification_date": "2020-12-24", "certification_authority": "FGV330542BG6", "payment_type": "04", "payment_type_description": null, "payment_method": "PUE", "usage": "G03", "place_of_issue": "11000", "version": "3.3", "invoice_details": [ {} ], "currency": "MXN", "subtotal_amount": 25, "exchange_rate": 1, "tax_amount": 4, "discount_amount": 0, "total_amount": 29, "payments": [], "payroll": null, "folio": "28", "xml": "=XML-STRING=", "warnings": { "code": "warning_code", "message": "warning message" } }

Eliminar una factura

Solicitud

Eliminar una factura específica de tu cuenta de Belvo.

Seguridad
basicAuth
Ruta
idstring(uuid)requerido

El invoice.id que deseas eliminar.

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

Respuestas

No hay contenido

Respuesta
Sin contenido

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