Get Started with BVNK

To get started with the BVNK Payments products, you'll need to create an account in our sandbox environment first.

Generate API keys

Once the BVNK Sandbox account is active, create API Keys to call BVNK endpoints:

1. Log in to the BVNK Portal.

2. On the sidebar, select Integrations and click Generate API Key.
   If 2FA is not enabled in your account yet, you'll be requested to configure it in an authenticator app.

   

3. In the Generate new API key window, specify the following parameters:

   • Name: Enter the description to identify the key in future.

   • Allowed IP addresses: Specify whitelisted IPs that your service will use to restrict IP addresses that can query the API.

   • Withdrawals: Click the toggle to allow or prevent the keys to be used for withdrawals and payouts.

     If withdrawals are disabled, you will only be able to use these keys to collect payments. Allowed IP addresses must also be specified to enable withdrawals.

   
   

4. Click Continue. You will be prompted to enter the 6-digit code from a configured F2A app.

   

5. API Keys are now generated and the Hawk Auth ID and Secret Key should be saved.

   

❗️

Save your keys immediately

Once you've created the keys, you'll see the Hawk Auth ID and Hawk Auth Key. Store these credentials privately as you won't be able to access the Hawk Auth Key again once you navigate away from this page.