Webhooks

Payment confirmed

A card or boleto payment was authorized by the issuer. The funds are a held receivable, not yet a balance credit.

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_CONFIRMED

Payload

txIdstring

Payment transaction id.

status'CONFIRMED'

Always CONFIRMED.

methodstring

Payment method, e.g. CARD or BOLETO.

sourcestring

Present and equal to reconciler when the confirmation came from reconciliation rather than the provider callback.

Response

Return a 2xx status to acknowledge receipt.

Changes