Webhooks

Payment refunded

A refund completed for this payment. Note this body identifies the payment as paymentId and carries no txId. It is also sent for refunds you did not start, such as a payer's refund request approved in the dashboard or automatically, or a refund YuvexPay made after such a request. The body carries no reason: read reason with GET /v1/payments/{paymentId}/refunds.

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 nullable

Present and null when the refund was driven by a PIX MED. Absent on every other refund.

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.