Skip to main content
A carteira guarda o saldo de um recebedor (rec_). Cada venda liquidada credita a carteira, cada taxa debita, e o extrato é a lista desses lançamentos. Você consulta saldo, resumo e extrato sempre por recebedor. O saldo não é um número só, e é aí que a maioria dos enganos acontece: o valor disponível não é o que dá para sacar. Entre um e outro entram o que está bloqueado e um limite percentual da sua conta — a seção abaixo abre a conta inteira.
Todas as requisições usam o header x-api-key. Veja Autenticação. A base URL de sandbox é https://api.sandbox.z2pay.com/v1.
“Owner” aqui é qualquer recebedor. Em Recebedores, owner é um papel único da sua conta (role: "owner"). Nas rotas de carteira o ownerId é o id de qualquer recebedor — todos têm carteira.

​
Endpoints

Não há endpoint por carteira. Um recebedor pode ter mais de uma carteira internamente, e a API sempre devolve o consolidado — por isso tudo é por ownerId e moeda, nunca por carteira.

​
O que compõe o saldo

Todos os valores são inteiros em centavos: 152030 é R$ 1.520,30.
withdrawableBalance pode ser menor que availableBalance mesmo sem nada bloqueado. A conta pode ter um teto percentual de saque configurado, e ele incide sobre o resultado. Para saber quanto realmente sai, leia withdrawableBalance — nunca calcule a partir do disponível.

​
Veja também

Saques

Como transformar saldo sacável em dinheiro na conta bancária.

Liquidação

Quando cada venda deixa de ser “a liberar” e vira disponível.

Recebedores

Quem são os donos das carteiras e como cadastrá-los.

Splits

Como o valor de uma venda chega dividido em várias carteiras.