Skip to main content
GET
Saldo agregado por moeda
GET /wallets/owner/:ownerId/balance Faz parte do recurso Carteiras — o modelo de saldo e liberação está lá. Devolve um item por moeda, somando todas as carteiras do recebedor. É a leitura que responde “quanto posso sacar agora”.
Ter saldo não é poder sacar. Os quatro números respondem coisas diferentes: o disponível já foi liberado, o a liberar é venda cujo prazo de liquidação ainda corre, o bloqueado está retido, e o sacável é o que a solicitação de saque aceita.O sacável é o menor de todos, e é o único que importa antes de pedir um saque — os outros três explicam por que ele é o que é.
balances é uma lista, com um item por moeda. Mesmo quando a conta só opera em BRL ela vem como array — uma integração que leia balances[0] sem conferir a currency quebra no dia em que houver duas.
O ownerId é o rec_ do recebedor, não um id de carteira. As carteiras são internas: você não as endereça uma a uma.

Exemplo

Resposta 200
Todos os valores em centavos. No exemplo, R$ 3.800,00 de vendas ainda estão no prazo de liquidação e não entram no que pode ser sacado hoje.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

ownerId
string
required

ID do recebedor

Response

Saldos agrupados por moeda

recipientId
string

ID do recebedor.

balances
object[]

Saldos do recebedor discriminados por moeda.