Direction: Outbound (BNPL WL → Partner). This is NOT a callable API endpoint — it documents the payload we send to your configured webhook_url.
Sent to your webhook_url when a payment is confirmed or fails.
A single payment may cover installments from multiple orders (applications).
The order_references array lists all affected orders.
Note: One payment.status_change event is dispatched per batch payment (one boleto/PIX transaction), regardless of how many invoices are covered. Use invoice.status_change to track per-invoice state changes.
Note: The payment provider may use a CONFIRMED state internally (boleto/PIX issuance acknowledged), but this is never exposed to partners. From the partner perspective, payment status is either PENDING or PAID.
Headers sent:
| Header | Description |
|---|---|
Content-Type | application/json |
X-Webhook-Signature | base64url ECDSA signature of the body (verify with our public key) |
Your endpoint must:
- Return HTTP 2xx within 10 seconds
- Be idempotent (you may receive the same event more than once)
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Your endpoint should return HTTP 2xx to acknowledge receipt