API Bank Statement SNAP BI

Informasi API

Title

API Bank Statement

Version

v1.1

URL Sandbox

https://sandbox.partner.api.bri.co.id

URL Production

 

Kendali Versi

Doc Versi

API Versi

Tanggal

Tautan Dokumen

Deskripsi

v1.1

v1.0

07 Desember 2021

Disini

Baseline version

v1.2

v1.0

22 April 2022

Disini

Update field format

v1.3 v1.0 15 Feb 2024 Disini Update Request and Response Sample
v1.4 v1.1 05 Mar 2024 Halaman Ini
  • Naik versi dari v1.0 jadi v1.1
  • Penambahan field referenceNo pada bagian Response
v1.5 v1.1 19 Mar 2024 Halaman Ini Perubahan field fromDateTime dan toDateTime menjadi Mandatory

Deskripsi Produk

Gambaran 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

Endpoint ini digunakan untuk mengakses riwayat transaksi keuangan secara menyeluruh dari sebuah rekening Bank.

General Information

HTTP Method

POST

Path

snap/v1.1/bank-statement

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

 

Request Structure & Sample

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

accountNo

String

Numeric

M

Note :

SNAP BI

(C)

15

Note: 

SNAP BI 

Length

(16)

Nomor Rekening

1234567891012348

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

Deskripsi

Contoh

responseCode

String

Numeric

M

7

Respon Code

2001400

responseMessage

String

Alphanumeric

M

150

Respon Deskripsi

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

“numberOfEntries”: “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

length

(18)

Nilai Jumlah, Jika itu Rupiah maka nilainya termasuk 2 angka desimal, misalnya Rp. 10.000,- maka akan menjadi 10000.00

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 

Length

(18)

Nilai Jumlah, Jika itu Rupiah maka nilainya termasuk 2 angka desimal, misalnya Rp. 10.000 maka akan menjadi 10000.00

10000.00

>>currency

String

Alphanumeric

M

3

Mata uang

IDR

detailData

Array

of

Object

 

 

 

 

 

>detailBalance

Object

 

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 

Length

(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 

Length

(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 

Length 

(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

 

Request & Response Payload Sample

Request  :

{
   "accountNo":"234567891012349",
   "fromDateTime":"2024-03-08T10:41:45+07:00",
   "toDateTime":"2024-03-08T11:41:45+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"
      },
      {
         "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"
      },
      {
         "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"
      },
      {
         "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"
      }
   ]
}

Error Response :


{
   "responseCode":"4041411",
   "responseMessage":"Invalid Card/Account/Customer[info]/VirtualAccount"
}

List of Error/Response Code

HTTP Status

Service Code

Code

Status

Response Message

Deskripsi

200

14

00

Sukses

Successfull

 

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

 

404

14

11

Gagal

Invalid Card/Account/Customer [Account No cannot be found]

 

409

14

00

Gagal 

Conflict

 

500

14

00

Gagal

General Error

 
504 14 00 Pending Timeout  
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan