Back to Brankas.comAPI ReferenceLoginSign Up

Go Live Checklist

A detailed checklist to help you transition from sandbox to go live.

Suggest Edits

We have compiled a detailed checklist to accompany you as you transition to go live.

1. Who is this checklist for

This document is for you if you want to:

  1. Go Live using Brankas products
  2. Test our API on production environment
  3. You have tested in Brankas Sandbox and ready to move on to the next step

📘

Ensure you are familiar with our sandbox before going through this checklist. If you are new to Brankas, we recommend you going through our Quickstart document.

2. How to apply for go-live production

To use our APIs live on production, you need to onboard through our go-live KYC in the Brankas dashboard.

  1. You can access our KYC through the Brankas dashboard by pressing the “Get Live Access” button. You can choose the most appropriate flow for you and follow our simple KYC submission process.
  2. You will be granted live access in a maximum of 2 working days after you have submitted all the required documents. If you have any questions, don’t hesitate to reach out to [email protected].

3. Add source or destination bank account

📘

This step is applicable only for Direct and Disburse

  • Add Destination account for Direct
  • Add Source account for Disburse

After getting live access, to begin testing in a production environment with real transactions, add real accounts of financial institutions to work as source/destination accounts. You can find this in the settings tab in the dashboard.

  1. For Disburse: Don’t forget to add the relevant source account with the appropriate API keys. If you don’t have them yet, Brankas can help you onboard with the required financial institution (not yet available for all financial institutions).
  2. For Direct: Add destination account

4. Update Callback URL

Brankas Direct returns callbacks to your pre-registered webhook URL.

In order for you to receive Final and Transitional statuses, you will need to set-up your callback URL for your listener to push the status to required platforms. These statuses are asynchronous to the actual funds transfer process and to ensure that the pushed status won’t be blocked it is best practice to whitelist Brankas call back URL IP: 35.240.194.107 only for callback notification from this IP should be interpreted.

POST 'https://merchant.com/callback' \
'Idempotency-Key: d4325bd23eba5b0a02799299c1759214ab33374f20c2314c9978bb69af1d2b1f' \
'Content-Type: application/json' \
'{
     "transaction_id": "2577b241-fe5f-4d4e-996a-c5a5ee1778f0",
     "status": 2,
     "reference_id": "dummy_ref_id"

The callback to your webhook URL will include both the relevant fund transfer request’s internal transaction_id along with the status of the operation. This can be then used to query the Brankas Direct Transaction Database directly using the RetrieveTransaction endpoint to retrieve all relevant transaction details.

FieldTypeDescription
Idempotency-KeyHash / 64-character stringNetwork instability can be an issue for callback notifications affecting the accuracy of the first callback. Brankas implements a retry mechanism via idempotency-key. This notify merchants to accordingly.

Scenarios:

1. Receives idempotency-key value for the first time – You should take action.
2. Receive the same idempotency-key value within 24 hrs from first time encounter – You should ignore.
3. Receives the same idempotency-key value received after 24 hrs from the first encounter – You should take action.

Note: If your system is not susceptible for double processing, ignore implementing this feature.
reference_idStringAny additional identifier, such as a UUID, that corresponds to an invoice, cart, or transaction object.
transaction_idInteger
COMPLETED = 2
(aka Success)
ERROR = 3
EXPIRED = 11
FLAGGED = 12
CANCELLED = 13
DENIED = 14
FAILED = 15		Brankas generates a transaction status after checkout API are triggered. This corresponds to the transaction’s current status.
transaction_idStringThe unique ID assigned to the fund transfer request

5. Generate LIVE API Key

Once your Brankas account has been granted live access, you can access the live environment by pressing the top left button on the dashboard.

  1. Go to API Keys > Create LIVE API Key
  2. Create a name for your API Key
  3. Select permission
  4. Continue

Permission settings:

PermissionDescription
ExcludedExcludes access to the selected product
Read OnlyEnable access to GET API method of the selected product
Read/WriteEnable access to GET and POST API method of the selected product

6. Update all URLs from Sandbox to Production

To begin transacting in production environment and use live data, make sure to change all URLs

ProductSandboxProduction
Directdirect.sandbox.bnk.todirect.bnk.to
Disbursedisburse.sandbox.bnk.todisburse.bnk.to
Statementstatement.sandbox.bnk.tostatement.bnk.to
Incomestatement.sandbox.bnk.tostatement.bnk.to
Balancebalance.sandbox.bnk.tobalance.bnk.to

7. Tap Customization

Optionally you can also update your Tap (the UI that customers interact with) customization in the production environment.

📘

  • Note that Tap customization does not carry over from sandbox to production so you must update this for the custom interface to be reflected in live.
  • This step is not applicable for Disburse.

8. Testing on production environment

After adding bank accounts, generating production API keys and changing the urls from sandbox to production, updating callback URL and optionally customizing Tap, you are ready for testing on production environment.

9. Go Live

Once you’re satisfied with testing on the production environment, you can immediately go live and empower your business using Brankas.

👍

Congratulations, you have reached the end of this article!

Redeem exclusive Brankas merchandise. Quote “Better With Open Finance” and share this page’s URL to a Brankas representative or email [email protected].

Updated about 2 months ago