Sign in
Webhooks

Withdrawal requested

A withdrawal was created and handed to the PIX network.

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_REQUESTED

Payload

withdrawalIdstring uuid

Withdrawal id.

txIdstring

Withdrawal transaction id.

netAmountnumber

Amount sent to the recipient in BRL, excluding the fee.

status'PENDING'

Always PENDING.

Response

Return a 2xx status to acknowledge receipt.

Changes