Webhooks

Payment refunded

A refund completed for this payment. Note this body identifies the payment as paymentId and carries no txId.

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_REFUNDED

Payload

paymentIdstring uuid

Payment id.

refundIdstring uuid

Refund id.

amountnumber

Refunded amount in BRL.

sourcestring

Present when the refund was driven by a PIX MED; names the settling provider.

Response

Return a 2xx status to acknowledge receipt.

Changes