Account Information
What is Account Balance ?
There is always a record for current/remaining fund balance in every bank accounts. This record is called account balance.
To gain access to check your company’s current account balance, BRIAPI offers this API account balance. API will give you an easy way to check your company’s real-time account balance directly from your business’ dashboard. Thus, your internal team can monitor the financial activities and make a financial plan easier and faster.
API Information
Title |
Account Information |
---|---|
Version |
v2.0 |
URL Sandbox |
https://sandbox.partner.api.bri.co.id/v2/inquiry |
URL Production |
https://partner.api.bri.co.id/v2/inquiry |
Version Control
Doc Version |
API Version |
Date |
Link to document |
Description |
---|---|---|---|---|
v1.0 |
v2.0 |
1 February 2019 |
Deprecated |
Baseline version. |
v2.0 |
v2.0 |
1 April 2020 |
In this page |
API structure changes |
Note : This API service is not recommended to be performed during the End of Day (EOD) period due to the possibility of data anomalies during that time.
Note : This API service is recommended to be performed minimum 15 minutes after the transaction.
Product Description
This API will give you a simple way to check your company’s real-time account information, including account name, balance and status. Therefore, you can monitor all of your financial activities.
Flow API
Endpoint
A. Account Information
Endpoint Description
This API is used to check your company account information, including account name, balance and status.
General Information
HTTP Method |
GET |
---|---|
Path |
/v2/inquiry/{{Account Number}} |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Header Structure
Key
|
Value
|
Mandatory
|
Length
|
Description
|
---|---|---|---|---|
Authorization |
Bearer (token) |
M |
|
Token OAuth 2.0 |
BRI-Signature |
|
M |
64 |
Signature |
BRI-Timestamp |
|
M |
|
The time you call the API. The time format used refers to the ISO8601 format |
Query Param Structure
Sample of HTTP request:
GET https://sandbox.partner.api.bri.co.id/v2/inquiry/{{ACCOUNT_NUMBER}}
Field | Data Type | Mandatory | Length | Description | Example |
---|---|---|---|---|---|
ACCOUNT_NUMBER | numeric | M | 15 | Account number. Add 0 in front if the account digit is less than 15. | 888801000157508 |
Response Structure
Field | Data Type | Mandatory | Length | Description | Example |
---|---|---|---|---|---|
responseCode | String | M | 4 | response code | 0100 |
responseDescription | String | M | response description | Inquiry success | |
errorDescription | String | Error Description | Empty string for successful inquiry. Also, please see the list of error/response codes. | ||
Data | Array | M | Contains source and destination account information. | Contains empty if the response error is "Data":{} | |
sourceAccount | String | M | Source Account | 020601000003301 | |
sourceAccountName | String | M | Source Account Name | ||
sourceAccountStatus | String | M | Source Account Status | Rekening Aktif | |
sourceAccountBalace | String | M | Source Account Balance | 1000000 | |
registrationStatus | String | M | Source account registration status |
Request & Response Payload Sample
Request :
curl --location --request GET 'https://sandbox.partner.api.bri.co.id/v2/inquiry/888801000157508' \ --header 'BRI-Timestamp: 2021-07-09T03:24:49.013Z' \ --header 'BRI-Signature: j6s41wC2saUFOIQpVhxQSdV+4lhJ/MMcBXQvmeaSHq8=' \ --header 'Authorization: Bearer 0zbSMMIp7vcPfuXv3B75OuYAbM9C'
Normal Response :
{ "responseCode": "0100", "responseDescription": "Inquiry success", "errorDescription": "", "Data": { "sourceAccount": "888801000157508", "sourceAccountName": "John Doe", "sourceAccountStatus": "Rekening Aktif", "sourceAccountBalace": "49615063835.3", "registrationStatus": "Rekening terdaftar an. BRI Application Program Interface" } }
Error Response :
{ "responseCode": "0101", "responseDescription": "Inquiry failed", "errorDescription": "InqRekAsal: Nomor Rekening Tidak Dikenal & InqRekTujuan: VA number not found", "Data": { "sourceAccount": "8888010000033012" } }
Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.