Account Statement v2.0
Informasi API
Judul |
Riwayat Transaksi |
---|---|
Versi |
v2.0 |
URL Sandbox |
https://sandbox.partner.api.bri.co.id/v2.0/statement |
URL Production |
https://partner.api.bri.co.id/v2.0/statement |
Kendali Versi
Versi Dok |
Versi API |
Tanggal |
Tautan Dokumen |
Deskripsi |
---|---|---|---|---|
v1.0 |
v2.0 |
1 February 2019 |
Versi Dasar. |
|
v2.0 |
v2.0 |
1 April 2021 |
halaman ini |
Perubahan Struktur API |
Deskripsi Produk
Gambaran Produk
API ini akan menampilkan riwayat transaksi rekening perusahaan Anda dengan jangka waktu maksimal satu bulan atau maksimal data 10mb tiap response untuk setiap permintaan dan riwayat data transaksi yang tersedia maksimal dua belas (12) bulan ke belakang. Apabila Anda menginputkan tanggal yang tidak ada transaksinya, maka sistem akan mengembalikan response data transaksi di tanggal terakhir pada bulan yang diinputkan.
Flow API
Endpoint
A. Riwayat Transaksi
Penjelasan Endpoint
Endpoint ini digunakan untuk melakukan pengecekan riwayat transaksi debit maupun kredit sesuai dengan nomor rekening dan dengan periode yang diinginkan.
Informasi Umum
HTTP Method |
POST |
---|---|
Path |
/v2.0/statement |
Format Type |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Header Structure
Key |
Value |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|
Authorization |
Bearer (token) |
Ya |
|
Token OAuth 2.0 |
|
BRI-Signature |
|
Ya |
64 |
Signature |
|
BRI-Timestamp |
|
Ya |
|
Timestamp Timestamp Waktu dimana anda memanggil API. Format waktu yang digunakan mengacu ke format ISO8601 |
|
BRI-External-Id |
alphanum |
Ya |
9 |
Unique ID di setiap request API |
|
Content-Type |
application/json |
Ya |
|
|
|
Request Structure
Field |
Data Type |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|
accountNumber |
String |
Ya |
15 |
nomor rekening. Tambahkan 0 di depan jika digit rekening kurang dari 15. |
008301031142500 |
startDate |
String |
Ya |
- |
Format : yyyy-mm-dd |
2020-12-01 |
endDate |
String |
Ya |
- |
Format : yyyy-mm-dd |
2020-12-30 |
Response Structure
Field |
Data Type |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|
transactionTime |
String |
Ya |
- |
tanggal dan waktu transaksi : yyyy-mm-dd HH:mm::ss |
|
debitAmount |
String |
Ya |
- |
nominal transaksi untuk transaksi debit |
|
creditAmount |
String |
Ya |
- |
nominal transaksi untuk transaksi credit |
|
typeAmount |
String |
Ya |
- |
jenis transaksi (debit / credit) |
|
remark |
String |
Ya |
- |
remark transaksi |
|
startBalance |
String |
Ya |
- |
saldo awal |
|
endBalance |
String |
Ya |
- |
saldo akhir |
|
Request & Response Payload Sample
Request :
curl --location --request POST 'https://sandbox.partner.api.bri.co.id/v2.0/statement' \ --header 'BRI-Timestamp: 2021-07-07T08:05:09.417Z' \ --header 'BRI-Signature: aNyXGxxx6FCJ7xxxww92be+dysMQJjJevkZua0Bjo=' \ --header 'Content-Type: application/json' \ --header 'BRI-External-Id: 1234' \ --header 'Authorization: Bearer xxxxT4lgcJtlbmOH3otgev8SXZX' \ --data-raw '{ "accountNumber":"008301031142500", "startDate":"2020-12-01", "endDate":"2020-12-31" }'
Normal Response:
{ "responseCode": "0000", "responseDescription": "Transaction Success", "data": [ { "transactionTime": "2020-12-03 05:56:07", "debitAmount": "1000.00", "creditAmount": "0.00", "typeAmount": "Debit", "remark": "BRIVA88099085868580099IBNKOVO HI****T WI ", "startBalance": "11567861.40", "endBalance": "11566861.40" }, { "transactionTime": "2020-12-03 05:56:07", "debitAmount": "300000.00", "creditAmount": "0.00", "typeAmount": "Debit", "remark": "BRIVA88099085868580099IBNKOVO HI****T WI ", "startBalance": "11566861.40", "endBalance": "11266861.40" } ] }
Error Response:
{ "responseCode": "0103", "responseDescription": "Account length must be 15 character" }
List of Error/Response Code
HTTP Status |
Code |
Status |
Response Description |
Deskripsi |
---|---|---|---|---|
200 |
0000 |
Success |
Inquiry account statement Success |
|
400 |
0101 |
Failed |
invalid Time Range |
|
400 |
0102 |
Failed |
No data found |
|
400 |
0103 |
Failed |
Account length must be 15 character |
|
400 |
0104 |
Failed |
Invalid Account |
|
400 |
0105 |
Failed |
Maximum range in 30 days |
|
400 |
0601 |
Failed |
Invalid Token |
|
400 |
0602 |
Failed |
Invalid Signature |
|
400 |
0603 |
Failed |
Invalid BRI-External-Id |
|
400 |
0999 |
Failed |
General Error |
|
400 |
0106 |
Failed |
Data size is too large, please try with shorter period |
|
503 |
0503 |
Failed |
Service unavailable |
|
504 |
0504 |
Failed |
Gateway timeout |
|