API Bank Statement SNAP BI
Informasi API
Title |
API Bank Statement |
---|---|
Version |
v2.1 |
URL Sandbox |
|
URL Production |
Kendali Versi
Versi Dokumen |
Versi API |
Tanggal |
Tautan Dokumen |
Deskripsi |
---|---|---|---|---|
v1.5 |
v1.1 |
19 Mar 2024 |
Perubahan field fromDateTime dan toDateTime menjadi Mandatory |
|
v1.7 |
v2.1 |
30 Oct 2024 |
Halaman ini |
|
Deskripsi Produk
Deskripsi Produk
API ini merupakan layanan yang digunakan untuk mengakses riwayat transaksi keuangan secara menyeluruh dari sebuah rekening Bank, baik rekening milik individu pemilik rekening. Konsumen dapat memanfaatkan platform dari Non-PJP Pengguna Layanan, atau PJP PIAS yang telah disertifikasi oleh PJP AIS untuk mengakses API ini sehingga dapat dengan mudah melihat rincian keuangannya dalam satu aplikasi..
Endpoint
A. API Bank Statement
A. API Bank Statement
Endpoint ini digunakan untuk mengakses riwayat transaksi keuangan secara menyeluruh dari sebuah rekening Bank.
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v2.0/bank-statement |
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Header Structure & Sample
Key |
Value |
Format |
Mandatory |
Length |
Description |
---|---|---|---|---|---|
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 |
Request Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
accountNo |
String |
Numeric |
C Note : (M) |
15 Note : SNAP BI (16) |
Nomor Rekening |
1234567891012348 |
bankCardToken | String |
C Note : (M) |
560 Note : SNAP BI (128) |
token yang didapatkan dari fitur Account Binding atau Directdebit | ||
fromDateTime |
String |
ISODateTime ISO-8601 |
M Note : SNAP BI (O) |
25 |
Rentang waktu mulai |
2020-11-08T12:07:56-07:00 |
toDateTime |
String |
ISODateTime ISO-8601 |
M Note : SNAP BI (O) |
25 |
Rentang waktu berakhir |
2020-11-09T12:09:57-07:00 |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Description |
Example |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Respon code |
2001400 |
responseMessage |
String |
Alphanumeric |
M |
150 |
Response description |
Successful |
referenceNo | String | Numeric | C | 64 |
Identifier transaksi pada sistem penyedia layanan. Harus diisi ketika transaksi berhasil. |
1710394058397946381 |
totalCreditEntries |
Object |
O |
Jumlah total transaksi dengan tipe = KREDIT |
“numberOfE ntries”: “10”, “amount”: { "value": "10000.00", "currency": "IDR" } } |
||
>numberOfEntries |
Integer |
Numeric |
O |
5 |
Jumlah entry |
10 |
>amount |
Object |
M |
||||
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI (18) |
Nilai Jumlah, |
10000.00 |
>>currency |
String |
Alphanumeric |
M |
3 |
Mata uang |
IDR |
totalDebitEntries |
Object |
O |
Jumlah total transaksi dengan tipe = DEBIT |
|||
>numberOfEntries |
integer |
Numeric |
O |
5 |
10 |
|
>amount |
Object |
M |
||||
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI (18) |
Nilai Jumlah, |
10000.00 |
>>currency |
String |
Alphanumeric |
M |
3 |
Mata uang |
IDR |
detailData |
Array of Object |
O |
||||
>detailBalance |
List<DetailBalance> See object definition. |
O |
Saldo awal dan akhir sebelum dan sesudah transaksi |
|||
>>startAmount |
Object |
O |
|
Active Currency And Amount ISO-4217 Jumlah saldo. Jika itu rupiah maka nilainya termasuk 2 angka desimal misal RP10.000, akan diubah menjadi 10000.00 |
||
>>>amount | Object | O | ||||
>>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI (16,2) |
Jumlah bersih dari transaksi. Jika itu rupiah lalu nilai termasuk 2 angka desimal. misalnya Rp 10.000, akan diubah menjadi 10000.00 |
10000.00 |
>>>currency |
String |
Alphanumeric |
M |
3 |
Mata uang |
IDR |
>>endAmount |
Object |
O |
|
Active Currency And Amount ISO-4217 Jumlah bersih dari transaksi. jika itu rupiah maka nilainya termasuk 2 angka desimal. misalnya Rp 10.000, akan di ubah menjadi 10000.00 |
||
>>>amount | Object | O | ||||
>>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI (16,2) |
Jumlah bersih dari transaksi. Jika itu rupiah lalu nilai termasuk 2 desimal angka. misalnya Rp 10.000, akan diubah menjadi 10000.00 |
20000.00 |
>>>currency |
String |
Alphanumeric |
M |
3 |
Mata uang |
IDR |
>amount | Object | O | ||||
>>value | String | Decimal | M |
15,2 Note : SNAP BI (16,2) |
Jumlah bersih dari transaksi. Jika itu rupiah lalu nilai termasuk 2 desimal angka. misalnya Rp 10.000, akan diubah menjadi 10000.00 | 20000.00 |
>>currency | String | Alphanumeric | M | 3 | Mata uang | IDR |
>transactionDate |
String |
ISODateTime ISO-8601 |
M |
25 |
Stempel waktu transaksi |
2009-07-03T12:08:56-07:00 |
>remark |
String |
Alphanumeric |
M |
256 |
Catatan transaksi |
Payment to Warung Ikan Bakar |
>transactionId |
String |
Alphanumeric |
O |
35 |
Pengidentifikasi transaksi internal dari perspektif penerbit |
20200801198230912830091123 |
>type |
String |
Alphanumeric |
M |
6 |
Jenis transaksi CREDIT/DEBIT |
|
>detailInfo | Object | O | Additional info | |||
>>remarkCustom | String | Alphanumeric | M | 255 | Remark custom | Transfer Dari DENNI LA ANACI via BRImo |
Request & Response Payload Sample
Request :
{
"accountNo": "234567891012349",
"fromDateTime": "2024-03-08T10:41:45+07:00",
"toDateTime": "2024-03-08T11:41:45+07:00"
}
Use Bank Card Token
Request :
{
"bankCardToken": "account_.eyJpYXQiOjE3MTU5MTg1NDIsImlzcyI6IkJhbmsgQlJJIC0gRERCIiwianRpIjoiZjg1MjdhN2MtMDEzYS00ODAyLTk0NWEtYzgwMWM3MjcyMDZjIiwicGFydG5lcklkIjoiIiwic2VydmljZU5hbWUiOiJERF9FWFRFUk5BTF9TRVJWSUNFIn0.ZNA6AJ_gHfwq3_vl4QlpWO8ZGS5t3j4n4yCiThLIdmf2BObvWYZM5GSwNdbbpFe_jVD1xq4afYvDPlbFN9SxCzgUqBrsvxif8Y09ib8kZaUWZhHwU5Yr0QkN5fcFeif_eYcsrLVqaDiQjRi6ru8YmTFGqayG9yenES-dTmtDd_KErXSmzcyvG2BEtZIykO5xgWW5I1wBamFjAouQozZbKWTxaUVsp_BmNzn-RI9HyEQbP-RkRZii9RTVNtByziRC3ZPDjX_oPkfbIFBKICPfUCTcG1ElPRrWRiqrIX9aSEhz6xao4HxIS9fAv8MSjQVHVm6dCjCyyyHb1mYl44Phbg",
"fromDateTime": "2023-08-31T10:12:00+07:00",
"toDateTime": "2023-09-01T23:59:00+07:00"
}
Normal Response :
{ "responseCode": "2001400", "responseMessage": "Successful", "referenceNo": "1710394058397946381", "totalCreditEntries": { "numberOfEntries": "2", "amount": { "value": "10000.00", "currency": "IDR" } }, "totalDebitEntries": { "numberOfEntries": "2", "amount": { "value": "10000.00", "currency": "IDR" } }, "detailData": [ { "detailBalance": { "startAmount": [ { "amount": { "value": "100000000.00", "currency": "IDR" } } ], "endAmount": [ { "amount": { "value": "20000.00", "currency": "IDR" } } ] }, "amount": { "value": "5000.00", "currency": "IDR" }, "transactionDate": "2024-03-08T10:41:45+07:00", "remark": "Payment to Warung Ikan Bakar 1", "transactionId": "2020080119823091283009112 0", "type": "Credit", "detailInfo": { "remarkCustom": "Transfer Dari DENNI LA ANACI via BRImo" } }, { "detailBalance": { "startAmount": [ { "amount": { "value": "100000000.00", "currency": "IDR" } } ], "endAmount": [ { "amount": { "value": "20000.00", "currency": "IDR" } } ] }, "amount": { "value": "5000.00", "currency": "IDR" }, "transactionDate": "2024-03-08T10:41:45+07:00", "remark": "Payment to Warung Ikan Bakar 2", "transactionId": "2020080119823091283009112 1", "type": "Credit", "detailInfo": { "remarkCustom": "Transfer Dari DENNI LA ANACI via BRImo" } }, { "detailBalance": { "startAmount": [ { "amount": { "value": "100000000.00", "currency": "IDR" } } ], "endAmount": [ { "amount": { "value": "20000.00", "currency": "IDR" } } ] }, "amount": { "value": "20000.00", "currency": "IDR" }, "transactionDate": "2024-03-08T10:41:45+07:00", "remark": "Payment to Warung Ikan Bakar 1", "transactionId": "2020080119823091283009122 0", "type": "Credit", "detailInfo": { "remarkCustom": "Transfer Dari DENNI LA ANACI via BRImo" } }, { "detailBalance": { "startAmount": [ { "amount": { "value": "100000000.00", "currency": "IDR" } } ], "endAmount": [ { "amount": { "value": "20000.00", "currency": "IDR" } } ] }, "amount": { "value": "20000.00", "currency": "IDR" }, "transactionDate": "2024-03-08T10:41:45+07:00", "remark": "Payment to Warung Ikan Bakar 2", "transactionId": "2020080119823091283009122 1", "type": "Credit", "detailInfo": { "remarkCustom": "Transfer Dari DENNI LA ANACI via BRImo" } } ] }
Error Response :
{ "responseCode": "4044701", "responseMessage": "Transaction Not Found" }
List of Error/Response Code
HTTP Status |
Service Code |
Code |
Status |
Response Message |
Description |
---|---|---|---|---|---|
200 |
14 |
00 |
Sukses |
Successful |
|
400 |
14 |
01 |
Gagal |
Invalid Field Format {fieldName} |
|
400 |
14 |
02 |
Gagal |
Invalid Mandatory Field {fieldName} |
|
401 |
14 |
00 |
Gagal |
Unauthorized. Client |
|
404 |
14 |
01 |
Gagal |
Transaction not found |
|
401 |
14 |
02 |
Gagal |
Invalid Customer Token |
*Note : Apabila request menggunakan field "bankCardToken" |
404 |
14 |
11 |
Gagal |
Invalid Card/Account/Customer[info]/VirtualAccount |
|
409 | 14 | 00 | Gagal | Conflict | |
500 | 14 | 00 | Gagal | General Error | |
504 | 14 | 00 | Pending | Timeout |