Get Started with Balance

A step-by-step guide to help you get started with Balance.

Let's get started by running Balance 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 guide you through this article from how to get started in the sandbox environment and transition to go live.

Set Up Your Sandbox

Brankas provides 2 modes:

EnvironmentDescription
SandboxA testing ground that allows you to test Brankas APIs with test banks, transactions, and currency. Sandbox endpoints contain .sandbox.bnk.to in the base URL.
LiveAfter you have tested in sandbox mode and are ready to go live, submit your go-live requirements on the Brankas Dashboard, and our team will be reaching out to you shortly.

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.
  1. Set up your business details
  1. Generate API Key
  • Go to API Keys > Create Sandbox API Key
  • Create a name for your API Key
  • Grant permission to the product that you will be testing, in this case Balance = Read/Write
  • Click Continue

Postman Setup Guide

  1. Import the Brankas API Collection in Postman.
    https://www.getpostman.com/collections/bafd08a7069dda4e4b80
  1. Setting up your authorization
  • Select Balance on the Collection Panel
  • Update Authorization Type to API key
  • Enter x-api-key in the Key field
  • Paste the API key generated on the Brankas Dashboard into the Value field
  1. Generate your first sandbox static link.
    a. Select [POST] Send Balance Retrieval Initiation 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:
  • country - Enter either PH or ID.
  • bank_codes - Enter DUMMY_BANK_PERSONAL
  • app_redirect_uri - Enter a redirect link. For example, your website homepage.
  • app_redirect_duration - Set a duration time for the redirection. Time is set in seconds.
  • remember_me - Enable remember me option by either setting it to True or False.
  • auto_consent - Skip consent page by setting it True.
    d. Click Send
    e. balance_id and redirect_uri will be generated. Open redirect_uri in a browser.
    f. Enter either of these account credentials.

Identifier/Account

Password

[email protected]

user+7

[email protected]

user+8

[email protected]

user+9

  1. View statement shared
    a. Select [GET] Get Balance List Request
    b. Paste the API key in the Authorization tab.
    c. Click Send
    d. View the balance data shared in the Body tab. Alternatively, you can also view the data shared on the Brankas Dashboard by looking up for the the transaction id.

Go Live

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

  1. Click Go Live Requirements in the banner on your Brankas Dashboard.
  1. 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:
  1. A summary of required document and details will be listed for you before proceeding. View detailed requirements here.
  1. Our team will review your submission and reach out to shortly!

Did this page help you?