Introduction

The BCB Payments API utilizes webhooks to provide real-time notifications to your application whenever a system event occurs. Webhooks are essential for managing asynchronous workflows, such as bank-executed payments or the receipt of automated account statements.

Events are triggered whenever an object is created or modified—whether the action was initiated via the API, the BCB Dashboard, or automated internal processes. This includes updates to statuses, timestamps, or any other resource attributes. For every event, BCB Payments will transmit a POST request in JSON format to your configured endpoint, containing a detailed event object for your system to process.

BCB Provides three types of Webhooks:

1. Status Webhooks
2. Transaction Webhooks
3. Virtual Account Webhooks

In order to use Status webhooks, you should create a webhook on your server and register it via an API Call

Payment Status Webhook

To ensure optimal security and performance, Transaction and Virtual Account webhooks are currently configured via our dedicated support team. Please contact your BCB Customer Success (CS) Agent, who will assist you in establishing your endpoint and verifying the initial connection.

BCB actively monitors the health of all webhook deliveries. Should we detect persistent errors or connection timeouts at your endpoint, our team will reach out to help resolve the issue. In the event of a delivery failure, you may request a manual replay of specific events by contacting your CS Agent.