Cancelar saque
Desfaz um pedido de saque que ainda não foi aprovado.
POST /withdrawals/:id/cancel
Faz parte do recurso Saques — os estados e o fluxo de aprovação estão lá.
Cancela o pedido e devolve o valor ao saldo disponível do recebedor.
409 como resultado normal, não como exceção.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do saque
Body
Motivo do cancelamento do saque.
1Response
Saque cancelado
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).