Webhooks

Overview

This section centralizes everything you need to configure and test the complete Webhook flow within Passport’s Payments-as-a-Service (PaaS) platform. From creating the subscription to end-to-end (E2E) validation of outgoing and incoming payments.

Webhook Setup in the Dashboard

Before receiving notifications, you must register your Webhook in the Passport Dashboard. Below are the details of each field on the “Create Webhook” screen.

The Fintech administrator must:

Log in to the Passport Dashboard.
Navigate to Platform > Webhooks.
Select Create Webhook.
Configure the Webhook.
Click Save.

Create Webhook

Webhook Configuration

Webhook Configuration: Parameter Details

Field	Description
Callback URL	HTTPS address where Passport will send notifications. Must be publicly accessible.
Secret Token	Key used to calculate/verify the HMAC-SHA256 signature. Keep it secure!
Delivery Mode	Retry mechanism to use (“Once” or “Retry”).
Webhook Enabled	YES/NO selector to enable or disable notifications.
Events	Type of Events: Confirmed, Inbound, Settled, Rejected.

Webhook Retry Behavior

When the Delivery Mode is set to Retry, after a webhook delivery failure, the platform will attempt to resend up to 12 times.

The retry schedule follows exponential backoff:

1_2*0 = 1s for the first retry
1_2*1 = 2s for the second
1_2*2 = 4s for the third
1_2*3 = 8s for the fourth

Event Selection

Under the Events section, choose the Payments category and select one or more (the event name in the notification is in parentheses).

We recommend enabling all events to properly handle both inbound and outbound payment scenarios.

Confirmed (payment.confirmed)
- The inbound or outbound payment was confirmed by the Originating or Receiving Bank.
Inbound (payment.inbound)
- The payment was successfully sent to the Bre-B network.
Settled (payment.settled)
- The payment was completed at the receiving bank.
Rejected (payment.rejected)
- The payment was rejected. Check the response body for more details.

Last updated on