Webhooks

Payment expired

The payment expired before being completed. For boleto this is not always terminal — a boleto paid on or shortly after its due date can settle late, producing a PAYMENT_PAID afterwards for the same charge.

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_EXPIRED

Payload

idstring uuid

Payment id. Present only on some expiry paths.

txIdstring

Payment transaction id.

status'EXPIRED'

Always EXPIRED.

amountnumber

Gross amount in BRL. Present only on some expiry paths.

Response

Return a 2xx status to acknowledge receipt.

Changes