# Recuperar el saldo actual de un enlace

Recupere el saldo actual de todas las cuentas corrientes y de ahorros para un enlace existente. Recomendamos también enviar el  para que reciba los saldos de una cuenta específica.

Endpoint: POST /api/br/balances/
Version: 1.223.0
Security: basicAuth

## Query parameters:

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

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

## Request fields (application/json):

  - `link` (string, required)
    El  para el que deseas recuperar información.
    Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

  - `account_id` (string)
    El  de Belvo para el que deseas recuperar información.
    Example: "e2cdb621-f44a-4558-89f6-8ab2a57add7a"

  - `save_data` (boolean)
    Indica si se debe o no persistir los datos en Belvo. Por defecto, esto está configurado en  y devolvemos una respuesta 201 Created.

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

## Response 200 fields (application/json):

  - `id` (string, required)
    El identificador único creado por Belvo utilizado para referenciar el saldo actual.
    Example: "0b94bdf9-3719-43a9-81e7-be95d2318595"

  - `link` (string, required)
    El identificador único del enlace al que pertenece este balance.
    Example: "0b94bdf9-3719-43a9-81e7-be95d2318595"

  - `account_id` (string, required)
    El  de Belvo al que pertenece este balance.
    Example: "c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321"

  - `account_internal_identification` (string, required)
    La identificación interna de la institución para la cuenta.
    Example: "92792126019929279212650822221989319252576"

  - `collected_at` (string, required)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2024-05-21T08:32:00Z"

  - `created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2024-05-21T08:32:00Z"

  - `last_updated_at` (string, required)
    La marca de tiempo ISO-8601 de cuando esta institución actualizó por última vez el saldo.

> 🚧 Advertencia
>
> El parámetro  depende de cómo la institución procesa (o almacena) los datos. En el caso de que la institución almacene datos de manera sincrónica (es decir, tan pronto como ocurre una transacción, el saldo se actualiza), entonces  reflejará el saldo en tiempo casi real. En el caso de que la institución almacene datos de manera asincrónica (es decir, recupera datos en bloque y luego actualiza el saldo), la información del saldo puede referirse a horas o días atrás. Además, en el caso de que la institución no pueda proporcionar la hora específica (debido a un error interno), la institución puede proporcionar una hora general en la que actualizaron por última vez la información de la cuenta y el saldo.
    Example: "2021-05-21T08:30:00Z"

  - `currency` (string, required)
    El código de moneda de tres letras (ISO-4217).
    Example: "USD"

  - `available` (number, required)
    El saldo disponible de la cuenta.
    Example: 1000.02

  - `blocked` (number, required)
    La cantidad que está actualmente bloqueada debido, por ejemplo, a transacciones pendientes.
    Example: 1000.02

  - `automatically_invested` (number, required)
    La cantidad que se invierte automáticamente (según lo acordado con la institución).
    Example: 1000.02

## Response 201 fields (application/json):

  - `id` (string, required)
    El identificador único creado por Belvo utilizado para referenciar el saldo actual.
    Example: "0b94bdf9-3719-43a9-81e7-be95d2318595"

  - `link` (string, required)
    El identificador único del enlace al que pertenece este balance.
    Example: "0b94bdf9-3719-43a9-81e7-be95d2318595"

  - `account_id` (string, required)
    El  de Belvo al que pertenece este balance.
    Example: "c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321"

  - `account_internal_identification` (string, required)
    La identificación interna de la institución para la cuenta.
    Example: "92792126019929279212650822221989319252576"

  - `collected_at` (string, required)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2024-05-21T08:32:00Z"

  - `created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2024-05-21T08:32:00Z"

  - `last_updated_at` (string, required)
    La marca de tiempo ISO-8601 de cuando esta institución actualizó por última vez el saldo.

> 🚧 Advertencia
>
> El parámetro  depende de cómo la institución procesa (o almacena) los datos. En el caso de que la institución almacene datos de manera sincrónica (es decir, tan pronto como ocurre una transacción, el saldo se actualiza), entonces  reflejará el saldo en tiempo casi real. En el caso de que la institución almacene datos de manera asincrónica (es decir, recupera datos en bloque y luego actualiza el saldo), la información del saldo puede referirse a horas o días atrás. Además, en el caso de que la institución no pueda proporcionar la hora específica (debido a un error interno), la institución puede proporcionar una hora general en la que actualizaron por última vez la información de la cuenta y el saldo.
    Example: "2021-05-21T08:30:00Z"

  - `currency` (string, required)
    El código de moneda de tres letras (ISO-4217).
    Example: "USD"

  - `available` (number, required)
    El saldo disponible de la cuenta.
    Example: 1000.02

  - `blocked` (number, required)
    La cantidad que está actualmente bloqueada debido, por ejemplo, a transacciones pendientes.
    Example: 1000.02

  - `automatically_invested` (number, required)
    La cantidad que se invierte automáticamente (según lo acordado con la institución).
    Example: 1000.02

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

  - .
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de , la descripción es:

  - .
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de forma programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 428 token_required.
    Example: "token_required"

  - `message` (string)
    Una breve descripción del error. 
Para los errores , la descripción es:

  - .
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Un ID único de 32 caracteres de la sesión de inicio de sesión (que coincide con un patrón de regex de: ).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tiempo de duración de la sesión en segundos.
    Example: 9600

  - `link` (string)
    Identificador único creado por Belvo, utilizado para referenciar el Link actual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalles sobre cómo generar el token.

  - `token_generation_data.instructions` (string)
    Instrucciones para la generación de tokens.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de datos para generar el token (código QR, desafío numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a utilizar para generar el token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica si el usuario necesita proporcionar información para completar la autenticación. Cuando se establece en , es posible que su usuario necesite:
- confirmar el inicio de sesión en otro dispositivo
- escanear un código QR
Aún necesitará realizar una llamada PATCH para completar la solicitud.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

- .
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"