Informasi Rekening

Buat API

 

 

Apa Itu Informasi Rekening?

Di dalam setiap transaksi digital, akan selalu ada catatan mengenai informasi terkait jumlah uang yang terdapat pada suatu rekening. Catatan ini disebut sebagai balance inquiry atau informasi saldo.

Untuk memudahkan akses terhadap informasi saldo rekening perusahaan Anda, BRIAPI menyediakan produk API Informasi saldo. API ini akan memudahkan Anda untuk mendapatkan jumlah dari saldo perusahaan secara real time langsung dari dasbor perusahaan Anda. Dengan begitu, tim internal perusahaan Anda dalam memantau keuangan perusahaan dan membuat perencanaan finansial secara lebih mudah dan cepat.

Informasi API

Judul

Informasi Rekening

Versi

v2.0

URL Sandbox

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

URL Production

https://partner.api.bri.co.id/v2/inquiry

Kendali Versi

Versi Dok

Versi API

Tanggal

Tautan Dokumen

Deskripsi
v1.0

v2.0

1 February 2019

Deprecated

Versi awal
v2.0

v2.0

1 April 2020

Halaman ini

Perubahan Struktur API

Deskripsi Produk

API ini digunakan untuk menampilkan informasi detail rekening dengan mudah dan cepat. Sehingga memudahkan perusahaan anda untuk membuat anggaran financial dengan tepat.

Flow API

Endpoint

A. Informasi Rekening

Penjelasan Endpoint

API ini digunakan untuk memeriksa informasi akun perusahaan Anda, termasuk nama akun, saldo dan status.

Informasi Umum

HTTP Method

GET

Path

/v2/inquiry{{Account Number}}

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 

 Value

 

 Mandatory

 

 Length

 

 Deskripsi

 

Authorization

Bearer (token)

M

 

Token OAuth 2.0

https://developers.bri.co.id/id/docs/
dokumentasi#token

BRI-Signature

 

M

64

Signature

https://developers.bri.co.id/id/docs/
dokumentasi#signature

BRI-Timestamp

 

M

 

Timestamp

Timestamp Waktu dimana anda memanggil API. Format waktu yang digunakan mengacu ke format ISO8601 (yyyy-MMddTHH:mm:ss.SSSZ). Waktu tersebut harus dalam UTC nol.

Query Param Structure

Sample of HTTP request:

GET https://sandbox.partner.api.bri.co.id/v2/inquiry/{{ACCOUNT_NUMBER}}

Field Data Type Mandatory Length Deskripsi Contoh
ACCOUNT_NUMBER numeric M 15 Account number. Tambahkan 0 di depan jika digit akun kurang dari 15. 888801000157508

Response Structure

Field Data Type Mandatory Length Deskripsi Contoh
responseCode String M 4 response code 0100
responseDescription String M   response description Inquiry success
errorDescription String     Error Description String kosong untuk inquiry sukses. Selain itu, silahkan lihat list error/response code.
Data Array M   Berisi informasi source dan destination account.  Berisi kosong jika response error "Data":{}
sourceAccount String M   Source Account 020601000003301
sourceAccountName String M   Source Account Name  
sourceAccountStatus String M   Source Account Status Rekening Aktif
sourceAccountBalace String M   Source Account Balance 1000000
registrationStatus String M   Source account registration status   

Request & Response Payload Sample

Request :


curl --location --request GET 'https://sandbox.partner.api.bri.co.id/v2/inquiry/888801000157508' \
--header 'BRI-Timestamp: 2021-07-09T03:24:49.013Z' \
--header 'BRI-Signature: j6s41wC2saUFOIQpVhxQSdV+4lhJ/MMcBXQvmeaSHq8=' \
--header 'Authorization: Bearer 0zbSMMIp7vcPfuXv3B75OuYAbM9C'

Normal Response :

{
    "responseCode": "0100",
    "responseDescription": "Inquiry success",
    "errorDescription": "",
    "Data": {
        "sourceAccount": "888801000157508",
        "sourceAccountName": "John Doe",
        "sourceAccountStatus": "Rekening Aktif",
        "sourceAccountBalace": "49615063835.3",
        "registrationStatus": "Rekening terdaftar an. BRI Application Program Interface"
    }
}

Error Response :

{
    "responseCode": "0101",
    "responseDescription": "Inquiry failed",
    "errorDescription": "InqRekAsal: Nomor Rekening Tidak Dikenal & InqRekTujuan: VA number not found",
    "Data": {
        "sourceAccount": "8888010000033012"
    }
}
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan