• Overview
  • Authorization
  • Testing
  • Responses

Overview


Our APIs are designed to provide effective retrieval of the bank’s data with ease of integration into your applications. And we'd like to make it even easier, so all facilities from setting up to testing and getting responses from our APIs are available in this store.

Please refer to Terms of Use before using our API.



Authorization


You need an access token to pass into the HTTP header to call this API for authorization. To do this, follow the steps below:

  1. Sign-up if you are new or Sign-in if you have an existing account.
  2. From the Menu, click on Applications.
  3. Fill in the Name and Description of your application, then click the Add button.
  4. From the Menu, click on APIs, then choose an API that you will like to consume.
  5. From the API Console, select the application you just created, then click on the Subscribe button. From the dialog box, click on Go to Subscriptions.
  6. Select your application from the dropdown list, then click on the Generate keys button to get your access token.
  7. In the Validity Time field, input the number of seconds that you want the access token to remain valid for. If you do not want your access token to expire, input -1.
  8. Scroll down to the Subscribed APIs section and click on your API. This will bring you back to its API Console.
  9. You are now ready to test the API.



Testing


Through the API Console, you may use your access token to test the API for your application. Below are steps to use the API console:

  1. At the API Console, select your application in Try. Under Using, select either Sandbox or Production (if applicable). The access token associated with the application and environment should be populated automatically under Set Request Header.
  2. Click on GET to expand the call method details, then fill in the keyword parameter(s).
  3. Click on the Try it out! button to see the response, request URL and cURL of the API call.
  4. To integrate the API into your application, simply add the provided access token in the HTTP header (e.g. Authorization: Bearer 489efb0ee095e75d625ccc0fa5f23e30)


Note: Please check out usage guidelines about Tiers and call limitations for this API.



Responses


The response object provides a HTTP status code which indicates whether a call succeeded or failed:


HTTP Status Code: 200
Indication: Successful

HTTP Status Code: 4xx/5xx
Indication: Failed. Response body will provide more details of the error


Usage Guidelines


The API access token shall be kept securely and must not be shared with anyone. By default, each user will be permitted to make 10 API calls every minute. If your application requires a larger number of calls per minute, please contact us.
Do note that we will review all call limit increment requests on a case-by-case basis. Approval will also be subject to our standards for acceptable use-cases.