Skip to main content
POST
Cancelar saque
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.
Só funciona em requested. Assim que o saque é aprovado, a janela fecha: approved, processing, paid, cancelled, rejected e failed respondem 409. Não há como chamar de volta um saque que já entrou no processamento bancário.
A janela é curta e não é sua. A aprovação acontece do nosso lado, no ritmo da operação — não há prazo garantido em que o saque continue cancelável. Se o cancelamento faz parte do seu fluxo, trate o 409 como resultado normal, não como exceção.
O valor volta ao saldo disponível, sem taxa. A taxa só é cobrada no saque que se concretiza.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do saque

Body

application/json
reason
string

Motivo do cancelamento do saque.

Minimum string length: 1

Response

Saque cancelado

id
string

Identificador único do registro.

amount
integer

Valor bruto em centavos

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

fee
integer

Taxa em centavos

netAmount
integer

Valor líquido (amount - fee) em centavos

status
string

Situação do saque. Valores: requested, approved, processing, paid, cancelled, rejected, failed.

bankAccountId
string | null

ID da conta bancária de destino do saque.

paidAt
string<date-time> | null

Data e hora em que o pagamento foi liquidado (ISO 8601).

statusHistory
object[] | null

Histórico de mudanças de status do saque.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).