APIDOCS Balance Inquiry SNAP BI
Informasi API
Judul |
API Balance Inquiry |
---|---|
Versi |
v1.0 |
URL Sandbox |
|
URL Production |
Kendali Versi
Versi Dok |
Versi API |
Tanggal |
Tautan Dokumen |
Deskrispi |
---|---|---|---|---|
v1.0 |
v1.0 |
7 Desember |
Halaman ini. |
Baseline version |
v2.0 |
v1.0 |
22 April 2022 |
Halaman ini |
Update field format |
Deskripi Produk
Gambaran Produk
Fitur ini digunakan untuk mengakses informasi saldo terkini dari rekening yang dimiliki secara real time, sesuai dengan layanan yang disediakan oleh PJP AIS
Endpoint
API Balance Inquiry
Endpoint ini berfungsi Untuk mengakses informasi saldo terkini dari rekening yang dimiliki secara real time
General Information
HTTP Method |
POST |
---|---|
Path |
/snap/v1.0/balance-inquiry |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Header Structure & Sample
Key |
Value |
Format |
Mandatory |
Length |
Deskripsi |
---|---|---|---|---|---|
Authorization |
Authorization |
String |
M |
|
Bearer {Token} |
X-TIMESTAMP |
BRI - Timestamp |
Datetime |
M |
|
Format Timestamp ISO8601 |
X-SIGNATURE |
BRI - Signature |
String |
M |
|
HMAC_SHA512 |
Content-type |
application/json |
|
M |
|
application/json |
X-PARTNER-ID |
|
Alphanumeric |
M |
36 |
|
CHANNEL-ID |
|
Alphanumeric |
M |
5 |
|
X-EXTERNAL-ID |
|
Numeric |
M |
9 |
nomor unik untuk request API |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
accountNo |
String |
Numeric |
M Note : SNAP BI (C) |
15 Note : SNAP BI Length (16) |
Nomor rekening terdaftar di bank |
1231271284141 |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Response Code |
2001100 |
responseMessage |
String |
Alphanumeric |
M |
150 |
Respon deskripsi |
successful |
accountNo |
String |
Numeric |
O |
15
Note : Length SNAP BI (32) |
Nomor rekening terdaftar di bank |
115471119 |
name |
String |
Alphanumeric |
O |
140 |
Nama akun pelanggan |
John Doe |
accountInfos |
Array |
|
O |
|
|
|
>holdAmount |
Object |
|
O |
|
|
|
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah simpanan yang tidak dapat digunakan. Jika itu Rupiah maka nilainya termasuk 2 angka desimal, misalnya 20.000 maka akan menjadi 20000.00 |
20000.00 |
>>currency |
String |
Alphanum eric |
M |
3 |
Mata uang |
IDR |
>availableBalance |
Object |
|
O |
|
|
|
>>value |
String |
Decimal |
M |
15,2
Note : Length SNAP BI (16,2) |
Saldo rekening yang dapat digunakan untuk transaksi |
130000.00 |
>>currency |
String |
Alphanum eric |
M |
3 |
Mata uang |
IDR |
>ledgerBalance |
Object |
|
O |
|
|
|
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI Length (16,2) |
Saldo rekening yang dapat digunakan untuk transaksi |
30000.00 |
>>currency |
String |
Alphanum eric |
M |
3 |
Mata uang |
IDR |
>status |
String |
Numeric |
O |
4 |
1 = Active = Account masih dapat digunakan 2 = Inactive/Closed = Account sudah tidak dapat digunakan 3 = Matured but not Closed 4 = New today = Account baru saja diaktifkan (rekening yang baru dibentuk hari H, belum melalui proses EOD)
5 = Zero Accrual
6 = Restricted / (Frozen with Accrual) = Account dapat menerima dana tetapi tidak dapat mengeluarkan dana (hanya bisa di-credit) 7 = Frozen = Account tidak dapat mengirim dan menerima dana 8 = Write off 9 = Dormant = Account sudah lama tidak terpakai tetapi masih dapat diaktifkan. |
0004 |
additionalInfo |
Object |
|
O |
|
Informasi tambahan |
|
>productCode |
String |
Alphanumeric |
O |
|
|
TV |
>accountType |
String |
Alphanumeric |
O |
|
S: Saving T: Deposite D: Giro L: Loan |
SA |
Request & Response Payload Sample
Request :
'{ "accountNo": "111231271284142" }'
Normal Response :
{ "responseCode": "2001100", "responseMessage": "Successful", "accountNo": "111231271284142", "name": "John Doe", "accountInfos": [ { "holdAmount": { "value": "20000.00", "currency": "IDR" }, "availableBalance": { "value": "130000.00", "currency": "IDR" }, "ledgerBalance": { "value": "30000.00", "currency": "IDR" }, "status": "0001" } ], "additionalInfo": { "productCode": "TV", "accountType": "SA" } }
Error Response :
{ "ResponseCode": "4091100", "ResponseMessage": "Conflict" }
List of Error/Response Code
HTTP Status |
Service Code |
Code |
Status |
Response Message |
Deskripsi |
---|---|---|---|---|---|
200 |
11 |
00 |
Sukses |
Successful |
|
400 |
11 |
01 |
Gagal |
Invalid Field Format {fieldName} |
|
400 |
11 |
02 |
Gagal |
Invalid Mandatory Field {fieldName} |
|
401 |
11 |
00 |
Gagal |
Unauthorized Client |
|
404 |
11 |
11 |
Gagal |
Invalid Card/Account/Customer[info]/VirtualAccount |
|
409 |
11 |
00 |
Gagal |
Conflict |
|
500 |
11 |
00 |
Gagal |
General Error |
|
504 |
11 |
00 |
Pending |
Timeout |
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan