Overview

bankhub.dev provides Vietnamese banks with open banking solutions

Message formats

Requests are sent as JSON, in some cases form-encoded. Date properties are represented by ISO 8601, string properties are encoded using UTF-8.

Versioning

The API will rely on the X-BankHub-Api-Version field set in the headers of each API call, to select the appropriate version of the API, otherwise it will get the latest version, see details

Rate Limits

To ensure stable service, the bankHub API sets access limits on each Application call.

If you make too many requests at a time or within the limit of each BankHub Application, you will get a HTTP result of 429 Too Many Requests.

Troubleshooting

With each request bankHub returns the requestId field, this is the identifier field for each request, with the handling issues related to errors.

Authentication

Each application created from bankHub Console will have two values: client-id and secret-key.

The bankHub API uses access tokens to authenticate requests. 'accessToken' will be set with 'Authorization' in Headers. For each request with an expired code, you will get a result with the HTTP Status Code 401.

Scopes

The scope will be set for each application, and then rely on what the grant initialized scope is to limit the risk on each decentralization.

With each time you create a 'grant', you pass the corresponding scope field to limit the scope of this decentralization.

Scope	Description
identity	View identification information including: name, citizen identification number, date of birth, phone number, email
transaction	View account transaction history