余额

返回账户当前的余额。total 等于 disponivel 加 emLiquidacao，加 bloqueado 的各项，再加 reserva。

GET /v2/ex/saldo

权限范围：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"
}

字段	类型	说明
`disponivel`	字符串	现在可用于提现的金额。提现会预留金额加手续费。
`saqueMaximo`	字符串	当前 `disponivel` 在计入提现手续费后能支付、且一笔 Pix 能容纳的最大提现金额：在对每笔提现 Pix 设有最高金额的账户中，不会超过该金额。带 `data` 时不返回，手续费无法计算或无法读取提现所经账户时也不返回。
`tetoPorPix`	字符串	账户中每笔提现 Pix 的最高金额，仅当它限制了 `saqueMaximo` 时返回：`disponivel` 足以支付不止一笔 Pix，其余部分通过其他提现发出。最高金额未起限制作用时不返回。
`emLiquidacao`	字符串	账户更换机构时，机构之间正在转移的金额。进行中的提现和退款不在这里：它们在创建时就从 `disponivel` 和 `total` 中扣除，未能完成时退回。
`bloqueado.med`	字符串	因进行中的争议而冻结。`GET /v2/ex/bloqueios` 列出每一项冻结。
`bloqueado.judicial`	字符串	因司法命令而冻结。
`bloqueado.cautelar`	字符串	因风险分析而冻结，最长 72 小时。
`bloqueado.chargeback`	字符串	因银行卡拒付争议而冻结。仅使用 Pix 的账户为零。
`reserva`	字符串	按期限冻结的保证金，到期后退回可用余额。
`aReceber`	字符串	尚未结算的银行卡和 boleto 应收款。不计入 `total`。
`aRecuperar`	字符串	您欠我们的金额。不计入 `total`。

参数	类型	说明
`subconta`	字符串	子账户的余额。响应会回显 `subconta`。
`data`	字符串	已结束日期的日终余额，`AAAA-MM-DD`。

要全部提现，请在提现的 valor 中使用 saqueMaximo：该金额在余额范围之内，多一分钱就会返回 422 saldo_insuficiente。在对每笔提现 Pix 设有最高金额的账户中，当余额足以支付该最高金额加上手续费时，saqueMaximo 就是该最高金额，响应会同时返回金额相同的 tetoPorPix，多一分钱就会返回 422 valor_acima_do_maximo，其余部分通过另一笔提现发出。提现上限（见限额）另行适用：超过上限的提现返回 422 limite_excedido。计算遵循您的手续费，无论是固定金额、按比例还是两者兼有。收款人收到的是确切金额，手续费从余额中扣除。如果在提现前余额发生变化而提现返回 422，请重新查询余额。控制台发送 Pix 页面上的 Sacar tudo（全部提现）按钮不读取此字段：在那里，超过每笔 Pix 最高金额的发送会拆分为多笔金额相同的 Pix，每笔各收手续费，按钮填入按这种方式能发出的最大总额。本 API 不拆分提现。

错误 #

状态码	`title`	触发条件
400	`data_invalida`	`data` 不符合 `AAAA-MM-DD`。
422	`dia_nao_encerrado`	`data` 是当天或将来的日期。
403	`subconta_de_outro`	凭证属于某个子账户，却请求了另一个子账户。
404	`nao_encontrado`	该 `subconta` 在此账户中不存在。