Usability of Webhooks for My Application

This document provides a overview of how webhook events are used across the payment products in our PIX-based payments API. Each product exposes its own notification structure while sharing a common transaction event that delivers PIX-related information.

---

Overview of the Webhook System (events)

Our API uses a unified webhook system named Events. Webhooks allow your application to receive real-time updates whenever key actions occur within our payment products.

Every product emits its own domain-specific events, but all products also share a common transaction webhook that carries PIX payment information.

---

Product-Specific Webhook Channels

Below is the mapping between products and the webhook types they emit:

Instant Payment

• Uses charge webhooks

• Also emits transaction webhooks

Bolepix

• Uses charge webhooks

• Also emits transaction webhooks

Withdrawal

• Uses withdrawal webhooks

• Also emits transaction webhooks

Payment Link

• Uses payment-link webhooks

• Also emits charge and transaction webhooks, but only once the payer begins the payment process via the link. The system may send multiple webhook events for the same transaction, up until its final state (paid or expired).

---

Understanding the transaction Webhook

The transaction webhook is common to all products and carries the PIX-specific data for completing a payment.

This event contains everything required to initiate or confirm the PIX payment. For example:

• data.qrCodeUrl Provides a QR-Code image URL to be displayed and scanned.

• data.dynamicPixCode Contains the PIX “copy and paste” code used to complete the payment without scanning.

Summary Table

Product	Product Webhook Type	Transaction Webhook
Instant Payment	charge	Yes (transaction)
Bolepix	charge	Yes (transaction)
Withdrawal	withdrawal	Yes (transaction)
Payment Link	payment-link	Yes (transaction)