API Bank Statement SNAP BI
API Information
Title |
API Bank Statement |
---|---|
Version |
v1.0 |
URL Sandbox |
|
URL Production |
Version Control
Doc Version |
API Version |
Date |
Link Document |
Description |
---|---|---|---|---|
v1.1 |
v1.0 |
7 Desember 2021 |
This pages. |
Baseline version |
v1.2 |
v1.0 |
22 April 2022 |
This pages |
Update field format |
v1.3 | v1.0 | 15 Feb 2024 | This pages | Update Request and Response Sample |
Product Description
Product Overview
This API is a service that is used to access complete history of financial transactions from a bank account, both accounts belonging to individual account owners. Consumers can take advantage of the platform from Non-PJP Service Users, or PJP PIAS which has been certified by PJP AIS to access this API, so they can easly view their financial details in one application.
Endpoint
A. API Bank Statement
Endpoint This endpoint is used to access the complete history of financial transactions from a bank account
General Information
HTTP Method |
POST |
---|---|
Path |
snap/v1.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 |
M Note : SNAP BI (C) |
15 Note : SNAP BI Length (16) |
Bank account number. |
1234567891012348 |
fromDateTime |
String |
ISODateTime ISO-8601 |
O |
25 |
Starting time range. Default: NOW (DESC) or NOW – 1 months (ASC) |
2020-11-08T12:07:56-07:00 |
toDateTime |
String |
ISODateTime ISO-8601 |
O |
25 |
Ending time range. Default: NOW – 1 months (DESC) or NOW (ASC |
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 |
Respon Description |
Successful |
totalCreditEntries |
Object |
|
O |
|
The total number of transactions with type = CREDIT |
“number Of Entries”: “10”, “amount”: { "value": "10000.00", "currency": "IDR" } } |
>numberOfEntries |
Int |
Numeric |
O |
5 |
Number of entries |
10 |
>amount |
Object |
|
M |
|
|
|
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI length (18) |
Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
10000.00 |
>>currency |
String |
Alphanumeric |
M |
3 |
Currency |
IDR |
totalDebitEntries |
Object |
|
O |
|
The total number of transactions with type = DEBIT |
|
>numberOfEntries |
int |
Numeric |
O |
5 |
|
10 |
>amount |
Object |
|
M |
|
|
|
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI Length (18) |
Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
10000.00 |
>>currency |
String |
Alphanumeric |
M |
3 |
Currency |
IDR |
detailData |
Array of Object |
|
|
|
|
|
>detailBalance |
Object |
|
O |
|
Initial and ending balance before and after transaction |
|
>>startAmount |
Object |
|
O |
|
Active Currency And Amount ISO-4217 Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
|
>>>amount |
Object |
|
O |
|
|
|
>>>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI Length (16,2) |
Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
10000.00 |
>>>>currency |
String |
Alphanumeric |
M |
3 |
Currency |
IDR |
>>endAmount |
Object |
|
O |
|
Active Currency And Amount ISO-4217 Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
|
>>>amount |
Object |
|
O |
|
|
|
>>>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI Length (16,2) |
Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
20000.00 |
>>>>currency |
String |
Alphanumeric |
M |
3 |
Currency |
IDR |
>amount |
Object |
|
O |
|
|
|
>>value |
String |
Decimal |
M |
15,2 Note : SNAP BI Length (16,2) |
Amount Value, If it's Rupiah then the value includes 2 decimal places, for example Rp. 10.000,- then it will be 10000.00 |
20000.00 |
>>currency |
String |
Alphanumeric |
M |
3 |
Currency |
IDR |
>transactionDate |
String |
ISODateTime ISO-8601 |
M |
25 |
Timestamp of the transaction. |
2009-07-03T12:08:56-07:00 |
>remark |
String |
Alphanumeric |
M |
256 |
Transaction records |
Payment to Warung Ikan Bakar |
>transactionId |
String |
Alphanumeric |
O |
35 |
Internal transaction identifier from issuer perspective |
20200801198230912830091123 |
>type |
String |
Alphanumeric |
M |
6 |
Transaction type. CREDIT/DEBIT |
|
Request & Response Payload Sample
Request :
{ "accountNo":"234567891012349", "fromDateTime":"2023-02-02T10:09:00+07:00", "toDateTime":"2023-02-02T12:09:00+07:00" }
Normal Response :
{ "responseCode":"2001400", "responseMessage":"Successful", "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":"2023-02-02T10:09:00+07:00", "remark":"Payment to Warung Ikan Bakar 1", "transactionId":"2020080119823091283009112 0", "type":"Credit" }, { "detailBalance":{ "startAmount":[ { "amount":{ "value":"100000000.00", "currency":"IDR" } } ], "endAmount":[ { "amount":{ "value":"20000.00", "currency":"IDR" } } ] }, "amount":{ "value":"5000.00", "currency":"IDR" }, "transactionDate":"2023-02-02T10:09:00+07:00", "remark":"Payment to Warung Ikan Bakar 2", "transactionId":"2020080119823091283009112 1", "type":"Credit" }, { "detailBalance":{ "startAmount":[ { "amount":{ "value":"100000000.00", "currency":"IDR" } } ], "endAmount":[ { "amount":{ "value":"20000.00", "currency":"IDR" } } ] }, "amount":{ "value":"20000.00", "currency":"IDR" }, "transactionDate":"2023-02-02T10:09:00+07:00", "remark":"Payment to Warung Ikan Bakar 1", "transactionId":"2020080119823091283009122 0", "type":"Credit" }, { "detailBalance":{ "startAmount":[ { "amount":{ "value":"100000000.00", "currency":"IDR" } } ], "endAmount":[ { "amount":{ "value":"20000.00", "currency":"IDR" } } ] }, "amount":{ "value":"20000.00", "currency":"IDR" }, "transactionDate":"2023-02-02T10:09:00+07:00", "remark":"Payment to Warung Ikan Bakar 2", "transactionId":"2020080119823091283009122 1", "type":"Credit" } ] }
List of Error/Response Code
HTTP Status |
Service Code |
Code |
Status |
Response Message |
Description |
---|---|---|---|---|---|
200 |
14 |
00 |
Sukses |
Successfull |
|
400 |
14 |
01 |
Failed |
Invalid Field Format {fieldName} |
|
400 |
14 |
02 |
Failed |
Invalid Mandatory Field {fieldName} |
|
401 |
14 |
00 |
Failed |
Unauthorized. Client |
|
404 |
14 |
01 |
Failed |
Transaction not found |
|
404 |
14 |
11 |
Failed |
Invalid Card/Account/Customer [Account No cannot be found] |
|
500 |
14 |
00 |
Failed |
General Eror |
|
504 |
14 |
00 |
Pending |
Timeout |
Any error response not listed in the BRIAPI response list is considered pending and requires further investigation.