Saldo

Devuelve el saldo de la cuenta en este momento. total es disponivel más emLiquidacao más las partes de bloqueado más reserva.

GET /v2/ex/saldo

Alcance: ex.saldo.read.

GET /v2/ex/saldo
→ 200
{
  "disponivel": "300.00",
  "saqueMaximo": "299.60",
  "emLiquidacao": "0.00",
  "bloqueado": { "med": "0.00", "judicial": "0.00", "chargeback": "0.00", "cautelar": "0.00" },
  "reserva": "0.00",
  "aReceber": "0.00",
  "aRecuperar": "0.00",
  "total": "300.00"
}

Campo	Tipo	Descripción
`disponivel`	string	Lo que cubre un retiro ahora. Un retiro reserva el valor más la tarifa.
`saqueMaximo`	string	El mayor retiro que el `disponivel` cubre ahora, con la tarifa del retiro incluida, y que cabe en un Pix: en la cuenta con valor máximo por Pix de retiro, no pasa de él. No viene con `data`, ni cuando la tarifa no se pudo calcular o la cuenta por donde sale el retiro no se pudo leer.
`tetoPorPix`	string	El valor máximo de un Pix de retiro en la cuenta, cuando es él el que limita el `saqueMaximo`: el `disponivel` cubre más que un Pix, y el resto sale en otros retiros. No viene cuando el valor máximo no limitó.
`emLiquidacao`	string	En transferencia entre instituciones, cuando la cuenta cambia de institución. Los retiros y devoluciones en curso no aparecen aquí: salen del `disponivel` y del `total` al crearse y vuelven si no se realizan.
`bloqueado.med`	string	Retenido por una disputa en curso. `GET /v2/ex/bloqueios` lista cada retención.
`bloqueado.judicial`	string	Retenido por orden judicial.
`bloqueado.cautelar`	string	Retenido por hasta 72 horas por análisis de riesgo.
`bloqueado.chargeback`	string	Retenido por disputa de tarjeta. Cero en cuentas solo Pix.
`reserva`	string	Garantía retenida por un plazo, que vuelve al disponible al vencer.
`aReceber`	string	Cuentas por cobrar de tarjeta y boleto aún no liquidadas. Fuera del `total`.
`aRecuperar`	string	Lo que usted nos debe. Fuera del `total`.

Parámetro	Tipo	Descripción
`subconta`	string	El saldo de una subcuenta. La respuesta devuelve `subconta`.
`data`	string	El saldo de cierre de un día cerrado, `AAAA-MM-DD`.

Para retirar todo, use saqueMaximo en el valor del retiro: ese valor cabe en el saldo, y un centavo más responde 422 saldo_insuficiente. En la cuenta con valor máximo por Pix de retiro, cuando el saldo cubre ese máximo más la tarifa, el saqueMaximo es ese máximo, la respuesta trae tetoPorPix con el mismo valor, un centavo más responde 422 valor_acima_do_maximo, y el resto sale en otro retiro. Los topes de retiro (vea Límites) valen aparte: un retiro por encima de ellos responde 422 limite_excedido. El cálculo sigue su tarifa, fija, porcentual o ambas. El beneficiario recibe el valor exacto, y la tarifa sale del saldo. Si el saldo cambia antes del retiro y este responde 422, consulte el saldo de nuevo. El botón Sacar tudo del envío de Pix en el panel no lee este campo: allí el envío por encima del valor máximo de cada Pix sale en varios Pix iguales, cada uno con su tarifa, y el botón completa el mayor total que cabe así. Esta API no divide el retiro.

Errores #

Estado	`title`	Cuándo
400	`data_invalida`	`data` fuera de `AAAA-MM-DD`.
422	`dia_nao_encerrado`	`data` es el día en curso o un día futuro.
403	`subconta_de_outro`	La credencial es de una subcuenta y solicitó otra.
404	`nao_encontrado`	La `subconta` no existe en esta cuenta.