Bank Statement

Informasi API

Title

API Bank Statement

Version

v1.0

URL Sandbox

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

URL Production

  

Kendali Versi

v2.0

Versi API

Tanggal

Tautan Dokumen

Deskripsi

v1.0

7 Desember

Halaman ini.

Baseline version

v2.0

22 April 2022

Halaman ini

Update field format

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

v1.0/bank-statement

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure & Sample

Key

Value

Format

Mandatory

Length

Descripsi

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 :

 

Length SNAP BI (16)

Nomor Rekening

234567891012345

fromDateTi me

String

ISODateTime ISO-8601

O

25

Rentang waktu mulai. Default:

NOW (DESC)

or NOW –1 months (ASC)

020-11-08T12:07:56-

07:00

toDateTime

String

ISODateTime ISO-8601

O

25

Rentang waktu berakhir. Default: NOW (DESC) - 1 months (ASC)

2020-11-09T12:09:57-

07:00

Response Structure & Sample

Field

Data Type

Format

Mandatory

Length

Deskripsi

Contoh

respons eCode

String

Numeric

M

7

respon code

2001400

respons eMessage

String

Alphanum eric

M

150

Respon Deskripsi

Successful

totalCre ditEntries

Object

 

O

 

Jumlah total transaksi dengan tipe = KREDIT

“numberOf

Entries”: “10”,

“amount”:

{ "value": "10000.00",

"currency":"IDR" } }

>numbe rOfEntri es

Int

Numeric

O

5

Jumlah entri

10

>amount

Object

 

M

 

 

 

>>value

String

Decimal

M

15,2

Note :

Length S

NAP BI

(16,2)

Nilai Jumlah,

Jika itu Rupiah maka nilainya termasuk 2 angka desimal,

misalnya Rp. 10.000,- maka akan menjadi 10000.00

1000

0.00

>>curre ncy

String

Alphanum eric

M

3

Mata uang

IDR

totalDeb itEntries

Object

 

O

 

Jumlah total transaksi dengan tipe = DEBIT

 

>numbe rOfEntri es

int

Numeric

O

5

 

10

>amount

Object

 

M

 

 

 

>>value

String

Decimal

M

15,2

 

Note :

 

Length S NAP BI (16,2)

Nilai Jumlah,

 

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

1000

0.00

>>curre ncy

String

Alphanum eric

M

3

Mata Uang

IDR

detailDa ta

Object

 

O

 

 

 

>detailB alance

Object

 

O

 

Saldo awal dan akhir sebelum dan sesudah transaksi

 

>>startA mount

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

 

>>>value

String

Decimal

M

15,2

 

Note :

 

Length S NAP 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

1000

0.00

>>>curr ency

String

Alphanum eric

M

3

Mata uang

IDR

>>endA mount

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

 

>>>value

String

Decimal

M

15,2

 

Note :

 

Length S NAP 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

2000

0.00

>>>curr ency

String

Alphanum eric

M

3

Mata uang

IDR

transacti onDate

String

ISODateTi me ISO-8601

M

25

Timestamp of the transaction.

2009-07-03T12:

08:56-07:00

remark

String

Alphanum eric

M

256

Catatan transaksi

Payment to

Warung Ikan Bakar

transacti onId

String

Alphanum eric

O

35

Pengidentifikasi transaksi internal dari perspektif penerbit

202008011982

30912830091123

type

String

Alphanum eric

M

6

Jenis transaksi CREDIT/DEBIT

 

Request & Response Payload Sample

Request :


	'{
		"accountNo":"1234567891012348",
		"fromDateTime":"2021-10-10T12:07:56-07:00",
		"toDateTime":"2021-11-09T12:09:57-07:00"
	}'

Normal Response :

{
	"responseCode": "2001400",
	"responseMessage": "Successful",
	"totalCreditEntries": {
	"numberOfEntries": "10",
	"amount": {
		"value": "10000.00",
		"currency": "IDR"
		}
	},
		"totalDebitEntries": {
		"numberOfEntries": "10",
		"amount": {
		"value": "10000.00",
		"currency": "IDR"
		}
	},
	"detailData": [
		{
		"detailBalance": {
		"startAmount": [
		{
		"value": "10000.00",
		"currency": "IDR"
		}
	],
	"endAmount": [
		{
		"value": "20000.00",
		"currency": "IDR"
		}
		]
	},
	"amount": {
			"value": "10000.00",
			"currency": "IDR"
			},
			"transactionDate": "2009-07-03T12:08:56-07:00",
			"remark": "Payment to Warung Ikan Bakar",
			"transactionId": "20200801198230912830091123",
			"type": "Credit"
			}
		]
	}

Error Response :

	{
		"ResponseCode": "4001402",
		"ResponseMessage": "Invalid Mandatory Field AccountNo"
	}

List of Error/Response Code

HTTP Status

Service Code

Code

Status

Response Message

Deskripsi

200

14

00

Sukses

Successfull

  

400

14

02

Gagal

Invalid Mandatory Field AccountNo

  

400

14

01

Gagal

Invalid Field Format PartnerReferenceNo

  

403

14

18

Gagal

Inactive Card/Account/Customer

  

404

14

01

Gagal

Transaction not found

  

404

14

11

Gagal

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

  

500

14

00

Gagal

General Eror

  

504

14

00

Pending

Timeout