Get Started with Income

Let's get started by running Income in the sandbox environment. To start, you will need to sign up for an account on the Brankas Dashboard and generate an API key. We will be guiding you through in this article from how to get started in the sandbox environment followed by the transition to go live.

Set Up Your Sandbox

There are 2 environments available. In the Sandbox environment, you can transact and call data with dummy banks, amounts, currencies and prototype your integrations. There are no limits in the sandbox environment and when you are ready, transition to the live mode where you will be transacting and calling data from customers.

We will be walking you through how to get started in the sandbox environment in this article.

Brankas provides 2 modes:

Account Setup Guide

1. Set up your Brankas Dashboard
   To start integrating with Brankas products, sign up for an account. A verification email will be sent to your inbox.

2. Set up your business details

3. Generate API Key

• Go to API Keys > Create Sandbox API Key
• Create a name for your API Key
• Grant permission to each product, in this case Data = Read/Write
• Click Continue

Postman Setup Guide

1. Import the Brankas API Collection in Postman.
   https://api.postman.com/collections/14772901-6f00cda2-8b61-4405-aba6-4e28aa11e7cc?access_key=PMAT-01GJEPY7PCNBWR7DPJ338YRJGR

   📘

   Our Postman collection is a permanent link and contains all products available on the sandbox.

2. Set up your authorization

a. Select Statement on the Collection Panel
b. Update Authorization Type to API key
c. Enter x-api-key in the Key field
d. Paste the API key generated on the Brankas Dashboard into the Value field

3. Generate your first sandbox static link
   a. Select [POST] Create Statement Retrieval request.
   b. In the Authorization tab, set Authorization type to Inherit Auth from Parent. The authentication method from the previous step.
   c. Update and customize Tap in the Body tab with app_redirect_uri , bank_codes, country, external_id and organization_display_name.

d. Click Send
e. statement_id and redirect_uri will be generated. Open redirect_uri in a browser.

4. Click on Get All Statement Data to view income data shared. Click Send and view Income data shared in the response body. Income status will be listed as sub_status = INCOME_AVAILABLE

To receive webhook notifications on income statuses, set a callback URL on the Brankas Dashboard.

Go Live

📘

Prerequisites

Verified account on the Brankas Dashboard

Once you have tested in the sandbox environment and ready to go live, follow through with these steps:

1. 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.
   cURL

   POST 'https://example.com/callback' \
   -H 'Content-Type: application/json' \
   --data-raw '{
       "transaction_id": "f6355a01-e32b-426e-b2af-85366d305743",
       "status": 2
       "reference_id": “9005376336”
   }'
   

   

2. Click Go Live Requirements in the banner on your Brankas Dashboard.

3. You will be walked through to submit required documents and details based on your business entity and country of operation. Select the tiles applicable to you:
   A summary of required document and details will be listed for you before proceeding. Below is a sample requirement for registering a foreign company in Indonesia.

4. Our team will review your submission and reach out to shortly!

👍

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].