Webhooks

Withdrawal failed

The network rejected the transfer and the funds were returned to your balance. This also carries provider-driven reversals.

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

Merchant-safe failure description. Never null — the key is absent when the network supplied no usable reason text.

Response

Return a 2xx status to acknowledge receipt.

Changes