Introduction
Webhook API Documentation
Overview
The Webhook API provides a comprehensive solution for receiving real-time notifications about events in our system, like payment status updates, and other important events in lifecycle of our services. Webhooks enable your application to stay synchronized with payment events without the need for constant polling.
What are Webhooks?
Webhooks are HTTP callbacks that are triggered by specific events in the system. When a relevant event occurs (such as a payment confirmation, refund processing, or charge status change), the system automatically sends an HTTP POST request to your configured webhook URL with detailed information about the event.
🚀 Key Benefits
- Real-time Notifications: Receive instant updates about payment events
- Reduced Server Load: No need to constantly poll for status updates
- Better User Experience: Immediate feedback for payment confirmations
- Automated Processing: Trigger business logic based on payment events
- Reliability: Built-in retry mechanisms for failed deliveries
📋 Supported Webhook Types
Webhook Types
| Type | Description |
|---|---|
PIX_OUTBOUND | Notifications for outbound Pix transfers |
PIX_QR_INBOUND | Payment confirmation via dynamic QR Code |
PIX_QR_PARTNER_INBOUND | Partner Pix QR Code payment notifications |
CARD_PAYMENT_INBOUND | Credit/debit card payment confirmations |
CARD_CHARGEBACK | Chargeback dispute notifications submitted by customers |
CARD_RECURRING_INBOUND | Confirmation of recurring credit card charges (e.g., subscriptions) |
PAYMENT_LINK_INBOUND | Payment link transaction confirmations |
- The payload for each webhook type is in the Webhook section of each product.
🎯 Use Cases
E-commerce Integration
- Payment Confirmations: Automatically update order status when payments are received
- Refund Processing: Handle customer refunds and update inventory
- Subscription Management: Process recurring payments and renewals
Financial Services
- Transaction Monitoring: Track payment status in real-time
- Compliance Reporting: Generate reports for regulatory requirements
- Risk Management: Monitor for suspicious activities
Business Automation
- Inventory Management: Update stock levels after successful payments
- Customer Notifications: Send confirmation emails and SMS
- Analytics Integration: Feed payment data to business intelligence systems