YUyuvexpay
Webhooks

Withdrawal failed

The network rejected the transfer and the funds were returned to your balance. This also carries reversals initiated on the network side.

The HTTP body is this object exactly — there is no envelope and no type field. The event name is delivered in the X-Webhook-Event header. Most optional fields arrive as an explicit null; a few keys are dropped from the JSON entirely when unset, and those are marked as such below. Read values with a null-safe accessor rather than testing key presence.

postWebhookWITHDRAWAL_FAILED

Payload

withdrawalIdstring uuid

Withdrawal id.

txIdstring

Withdrawal transaction id.

netAmountnumber

Amount that was attempted, in BRL.

status'FAILED'

Always FAILED.

endToEndIdstring nullable

PIX end-to-end identifier. null when the network did not assign one.

failureReasonstring

Generic failure message from a fixed set: Saque não processado. O valor foi devolvido ao saldo., Saque recusado pela instituição de destino., A chave PIX informada não existe ou já não está ativa. Confira a chave e tente de novo., A conta de destino está bloqueada. Utilize outra chave PIX., A conta de destino foi encerrada. Utilize outra chave PIX., O documento informado não corresponde ao titular da chave PIX informada.. Never null — the key is absent when no reason was recorded.

Response

Return a 2xx status to acknowledge receipt.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.