YUyuvexpay
Webhooks

MED received

A PIX MED (special refund) was opened by the payer's bank.

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.

postWebhookMED_RECEIVED

Payload

medIdstring uuid

MED id.

paymentIdstring uuid

Payment id.

providerMedIdstring nullable

Always null when present. Kept for payload compatibility; use medId.

amountnumber

Disputed amount in BRL.

frozenAmountnumber

Amount frozen on your balance in BRL.

shortfallnumber

Amount that could not be frozen because of insufficient balance.

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.