Webhooks

Payment paid

Funds were received and the net amount was credited to your balance.

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.

postWebhookPAYMENT_PAID

Payload

idstring uuid

Payment id.

txIdstring

Payment transaction id.

status'PAID'

Always PAID.

amountnumber

Gross amount in BRL.

paidAtstring date-time nullable

Settlement timestamp. null when not recorded.

endToEndIdstring nullable

PIX end-to-end identifier, safe for bank reconciliation. null when the network did not supply one.

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.