Solicitar saque
Pede a retirada do saldo disponível de um recebedor para a conta bancária dele.
POST /withdrawals
Faz parte do recurso Saques — os estados e o fluxo de aprovação estão lá.
Solicita a retirada do saldo de um recebedor. O saque não sai na hora: ele entra como
requested e espera aprovação.
recipientId, não por carteira: a Z2Pay soma
todas as carteiras daquele recebedor na moeda indicada (BRL por padrão). Você não escolhe de
qual carteira sai.GET /withdrawals/config: taxa percentual, taxa fixa e valor mínimo.
Abaixo do mínimo, o pedido é recusado.bankAccountId da resposta é a conta bancária
cadastrada do recebedor — para mudá-la, o caminho é
atualizar o recebedor.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Body
ID do recebedor cuja carteira será sacada.
1Valor do saque, em centavos.
x >= 1Código de moeda ISO 4217. Hoje o único valor aceito é 'BRL', que também é o padrão quando o campo é omitido.
BRL Response
Saque solicitado
Identificador único do registro.
Valor bruto em centavos
Moeda no padrão ISO 4217 (ex.: BRL).
Taxa em centavos
Valor líquido (amount - fee) em centavos
Situação do saque. Valores: requested, approved, processing, paid, cancelled, rejected, failed.
ID da conta bancária de destino do saque.
Data e hora em que o pagamento foi liquidado (ISO 8601).
Histórico de mudanças de status do saque.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).