Skip to main content
Um saque (wdr_) transfere o saldo sacável de um recebedor para a conta bancária dele. Você solicita por recebedor e moeda; a Z2Pay agrega o saldo das carteiras daquela moeda e debita o valor na hora da solicitação. O saque não é imediato nem automático: ele nasce solicitado e passa por aprovação antes de seguir para o banco. Entre a solicitação e o dinheiro na conta há estados intermediários, e é por eles que você acompanha — não pelo retorno da chamada.
Todas as requisições usam o header x-api-key. Veja Autenticação. A base URL de sandbox é https://api.sandbox.z2pay.com/v1.

​
Endpoints

​
Status do saque

Quem determina o status é a nossa análise e, depois dela, o banco. Você só provoca dois: a solicitação e o cancelamento.
Só três estados geram webhook: withdrawal.requested, withdrawal.paid e withdrawal.rejected. Os demais você observa consultando o saque. Veja Webhooks.

​
Antes de solicitar

Sem conta bancária no recebedor, a solicitação não falha — o saque nasce sem destino. A criação não confere a conta: responde 201 com bankAccountId: null, o valor sai do saldo e o saque tende a ser recusado na análise (com devolução). Cadastre a conta antes.
A conta bancária faz parte do cadastro do recebedor: você a envia em bankAccount ao criar ou atualizar o recebedor, e ela aparece como defaultBankAccount na resposta. O destino do saque é resolvido a partir dela no momento da solicitação — não é um campo do corpo. Além da conta, o recebedor precisa estar apto a receber (vínculo active) e ter saldo sacável na moeda. Quanto sai de taxa e qual o valor mínimo estão em Configuração de saque; quanto há para sacar, em Carteiras.

​
Veja também

Carteiras

De onde sai o dinheiro e por que o sacável difere do disponível.

Recebedores

Cadastro do recebedor e da conta bancária de destino.

Liquidação

Quando o saldo de uma venda fica disponível.

Webhooks

Os eventos withdrawal.* e o que cada um carrega.