Saldo agregado por moeda
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/balance \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/balance"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"recipientId": "rec_t8wq4hz2mxk9rpf5snc7ydv3b",
"balances": [
{
"currency": "BRL",
"availableBalance": 1250000,
"pendingBalance": 380000,
"blockedBalance": 0,
"withdrawableBalance": 1250000
},
{
"currency": "USD",
"availableBalance": 45000,
"pendingBalance": 12000,
"blockedBalance": 0,
"withdrawableBalance": 45000
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}Carteiras
Saldo agregado por moeda
Quanto o recebedor tem — disponível, a liberar, bloqueado — e quanto disso dá para sacar.
GET
/
wallets
/
owner
/
{ownerId}
/
balance
Saldo agregado por moeda
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/balance \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/balance"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"recipientId": "rec_t8wq4hz2mxk9rpf5snc7ydv3b",
"balances": [
{
"currency": "BRL",
"availableBalance": 1250000,
"pendingBalance": 380000,
"blockedBalance": 0,
"withdrawableBalance": 1250000
},
{
"currency": "USD",
"availableBalance": 45000,
"pendingBalance": 12000,
"blockedBalance": 0,
"withdrawableBalance": 45000
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}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
curl https://api.sandbox.z2pay.com/v1/wallets/owner/rec_v57bi6ruyolouw3cpaq2ofy1k/balance \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
Resposta 200
{
"recipientId": "rec_v57bi6ruyolouw3cpaq2ofy1k",
"balances": [
{
"currency": "BRL",
"availableBalance": 1250000,
"pendingBalance": 380000,
"blockedBalance": 0,
"withdrawableBalance": 1250000
}
]
}
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.