Enabling Webhooks for Fiat Payments

The Integrations Channel in the BVNK Portal allows you to configure real-time notifications via webhooks for key events such as; payins received, payouts sent out, and Virtual Accounts created.

This feature will ensure that you are automatically informed about changes to your BVNK account, and minimises the requirement for you to ask for assistance in configuring your required webhook setup.

Below is the list of steps to enable fiat webhooks via the BVNK Portal:

  1. Log into the BVNK Portal.
  2. Select Integrations in the side bar.
  3. Click Webhooks in the toggle button.
  4. Select the Call to Action button Add webhook.
  5. Enter the Webhook URL which as a user you would like to receive the events.
  6. Select the events to send from the list provided.
  7. Select the Call to Action button Add.
  8. Once added you can see the active webhook in the list of webhooks.

You will be able to:

  1. List destinations of webhook URLs.
  2. Create destination of webhook URLs.
  3. Remove destination of webhook URLs.
  4. List events when creating a destination or viewing detail.

You can access a product demo of the Notification feature here and read more on the Help Centre article.

Once the payment has been processed, you will receive an asynchronous response (Webhook) with the details of the event that you subscribed to on the Webhook URL you provided at the point of creation in the Integrations Channel within the BVNK Portal.

The most significant benefit to you as a user is that you will be able to automate your workflows by setting up triggers to determine which operations or activities to carry out once you receive a deposit. For example, if you operate a business that issues wallets to customers and these customers make deposits to fund their wallets, you can credit the customers' wallets as soon as you receive the webhook for the successful deposit, thereby eliminating the manual approach of having to periodically check the BVNK Portal to confirm deposits.

Types of Webhooks

There are two types of webhooks you can expect for payouts

Payout Webhooks:
payout:status-change Represents the payment flow for a payment out.

Payin Webhooks:
payin:status-change Represents the payment flow for a payment in.