API Account Inquiry External & Interbank Transfer
Informasi API
Title |
API Account Inquiry/Interbank Transfer |
---|---|
Version |
v1.0 |
URL Sandbox |
|
URL Production |
Kendali Versi
Versi API |
Tanggal |
Tautan Dokumen |
Deskripsi |
---|---|---|---|
v1.0 |
7 Desember |
Halaman ini. |
Baseline version |
v2.0 |
12 April 2022 |
Halaman ini. |
Update Field Format |
v2.1 |
16 September 2022 |
Halaman ini. |
Update response code |
Deskripsi Produk
Gambaran Produk
Fitur ini digunakan untuk pemindahbukuan dana yang bersumber dari PJP PIAS melalui layanan transfer kredit di Bank PJP AIS menggunakan API transfer Interbank
Endpoint
A. Eksternal Account Inquiry
Endpoint ini digunakan untuk validasi nomor dan nama rekening tujuan Sebelum melakukan pemindahbukuan Interbank, RTGS, atau SKNBI
General Information
HTTP Method |
POST |
---|---|
Path |
|
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Header Structure
Key |
Value |
Format |
Mandatory |
Length |
Deskripsi |
---|---|---|---|---|---|
Authorization |
Authorization |
String |
M |
|
Bearer {Token} |
X-TIMESTAMP |
timestamp |
Datetime |
M |
|
Format Timestamp ISO8601 |
X-SIGNATURE |
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 |
36 |
|
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
beneficiaryBankCode |
String |
Numeric |
M |
3
Note : SNAP BI length (8) |
Kode Bank tujuan |
002 |
beneficiaryAccountNo |
String |
Numeric |
M |
34 |
Nomor Rekening penerima |
888801000157508 |
additionalInfo |
Object |
|
O |
|
|
|
>deviceId |
String |
Alphanumeric |
O |
|
|
|
>channel |
String |
Alphanumeric |
O |
|
|
|
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Response code |
2000000 |
responseMessage |
String |
Alphanumeric |
M |
150 |
response Message |
Successful |
referenceNo |
String |
Numeric |
O Note : SNAP BI (C) |
20 Note : SNAP BI length (64) |
Identifikasi transaksi pada pada sistem penyedia layanan. harus diisi setelah transaksi berhasil |
202112 |
beneficiaryAccountName |
String |
Alphanumeric |
M |
100 |
Nama Rekening Penerima |
John Doe |
beneficiaryAccountNo |
String |
Numeric |
M |
34 |
Nomor Rekening Penerima |
888801000157508 |
beneficiaryBankCode |
String |
Numeric |
O |
3 Note : SNAP BI length (8) |
Kode Bank penerima |
002 |
currency |
String |
Alphanumeric |
O |
3 |
Mata Uang |
IDR |
additionalInfo |
Object |
|
O |
|
|
mobilephone |
>deviceId |
String |
Alphanumeric |
O |
|
|
12345679237 |
>channel |
String |
Alphanumeric |
O |
|
|
mobilephone |
Request & Response Payload Sample
Request :
{ "beneficiaryBankCode": "002", "beneficiaryAccountNo": "888801000157508", "additionalInfo": { "deviceId": "12345679237", "channel": "mobilephone" } }
Normal Response :
{ “responseCode”: “2001600”, “responseMessage”: “Successful”, “referenceNo”: “2020102977770000000009”, “beneficiaryAccountName”: “John Doe”, “beneficiaryAccountNo”: “888801000157508”, “beneficiaryBankCode”: “002”, “currency”: “IDR”, “additionalInfo”: { “channel”: “mobilephone”, “deviceId”: “12345679237” } }
Error Response :
{ "responseCode": "4001601", "responseMessage": "Invalid Field Format beneficiaryBankCode" }
List of Error/Response Code
HTTP Status |
Service Code |
Code |
Status |
ResponseDescription |
Deskripsi |
---|---|---|---|---|---|
200 |
16 |
00 |
Sukses |
Successful |
|
400 |
16 |
01 |
Gagal |
Invalid Field Format {fieldName} |
|
400 |
16 |
02 |
Gagal |
Invalid Mandatory Field {fieldName} |
|
401 |
16 |
00 |
Gagal |
Unauthorized. Client |
|
403 |
16 |
15 |
Gagal |
Transaction Not Permitted. [reason] |
|
403 |
16 |
16 |
Pending |
Suspend Transaction |
|
403 |
16 |
18 |
Gagal |
Inactive Card/Account/Customer |
|
404 |
16 |
11 |
Gagal |
Invalid Card/Account/Customer[info]/Virtual Account |
|
500 |
16 |
00 |
Pending |
General Error |
|
504 |
16 |
00 |
Pending |
Timeout |
|
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan
B. Transfer interbank
Endpoint ini digunakan untuk melakukan pemindahbukuan dana dari satu rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS Lembaga Selain Bank, pada PJP AIS Bank ke rekening tujuan pada PJP AIS Bank lain melalui perantaraan Penyelenggara Infrastruktur Pembayaran (PIP) seperti GPN atau BI-FAST.
General Information
HTTP Method |
POST |
---|---|
Path |
|
Tipe Format |
JSON |
Authentication |
OAuth 2.0 with Access Token |
Header Structure
Key |
Value |
Format |
Mandatory |
Length |
Deskripsi |
---|---|---|---|---|---|
Authorization |
Authorization |
String |
M |
|
Bearer {Token} |
X-TIMESTAMP |
timestamp |
Datetime |
M |
|
Format Timestamp ISO8601 |
X-SIGNATURE |
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 |
36 |
|
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
partnerReferenceNo |
String |
Alphanumeric |
M |
20 Note : SNAP BI Length (64) |
Identifikasi transaksi pada sistem penyedia layanan |
2020102900000000000001 |
amount |
Object |
|
M |
|
|
|
>value |
String (ISO4 217) |
Decimal |
M |
15,2 Note : SNAP BI Length (18,2) |
Jumlah bersih transaksi, jika rupiah maka nilainya termasuk 2 angka desimal. misalnya 10.000 akan menjadi 10000.00 |
10000.00 |
>currency |
String |
Alphanumeric |
M |
3 |
Mata uang |
IDR |
beneficiaryAccountName |
String |
Alphanumeric |
M |
100 |
Nama rekening penerima |
John Doe |
beneficiaryAccountNo |
String |
Numeric |
M |
16 Note : SNAP BI Length (34) |
Rekening Penerima |
888801000157508 |
beneficiaryAddress |
String |
Alphanumeric |
O |
100 |
Alamat penerima |
Palembang |
beneficiaryBankCode |
String |
Numeric |
M |
3 Note : SNAP BI Length (8) |
Kode Bank penerima |
002 |
beneficiaryBankName |
String |
Alphanumeric |
O |
50 |
Nama Bank penerima |
Bank BRI |
beneficiaryEmail |
String |
Alphanumeric |
O |
50 |
Email penerima |
|
customerReference |
String |
Alphanumeric |
O |
20 Note : SNAP BI Length (30) |
Nomor referensi / No Referral / ID transaksi |
10052022 |
sourceAccountNo |
String |
Numeric |
M |
15 Note : SNAP BI Length (19) |
Nomor akun sumber |
888801000157520 |
transactionDate |
String |
Datetime |
M |
25 |
tanggal transaksi : ISO 8601 |
2021-11-25 |
additionalInfo |
Object |
|
O |
|
Informasi tambahan |
|
>deviceId |
String |
Alphanumeric |
M |
|
|
1234579237 |
>channel |
String |
Alphanumeric |
M |
|
|
mobilephone |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Response code |
2001800 |
responseMessage |
String |
Alphanumeric |
M |
150 |
Response deskripsi |
Successful |
referenceNo |
String |
Numeric |
O Note : SNAP BI (C) |
7 Note : SNAP BI Length (64) |
Identifikasi transaksi pada pada sistem penyedia layanan. harus diisi setelah transaksi berhasil |
2021120 |
partnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi pada sitem layanan konsumen |
2020102900000000000001 |
amount |
Object |
|
O |
|
|
|
>value |
String (ISO4217) |
Decimal |
M |
15,2 Note : SNAP BI Length (16,2) |
Jumlah bersih transaksi, jika rupiah maka nilainya termasuk 2 angka desimal. misalnya 10.000 akan menjadi 10000.00 |
10000.00 |
>currency |
String |
Alphanumeric |
M |
3 |
Mata uang |
IDR |
beneficiaryAccountNo |
String |
Numeric |
M |
34 Note : SNAP BI Length (19) |
Nomor rekening penerima |
888801000157508 |
beneficiaryBankCode |
String |
Numeric |
O |
3 Note : SNAP BI Length (8) |
Kode Bank penerima |
002 |
sourceAccountNo |
String |
Numeric |
O |
15 Note : SNAP BI Length (19) |
Nomor akun sumber |
888801000157520 |
additionalInfo |
Object |
|
O |
|
Informasi tambahan |
|
>deviceId |
String |
Alphanumeric |
O |
|
|
12345679237 |
>channel |
String |
Alphanumeric |
O |
|
|
mobilephone |
Request & Response Payload Sample
Request :
{ "partnerReferenceNo": "2021113000000000000001", "amount": { "value": "10000.00", "currency": "IDR" }, "beneficiaryAccountName": "John Doe", "beneficiaryAccountNo": "888801000157508", "beneficiaryAddress": "Palembang", "beneficiaryBankCode": "002", "beneficiaryBankName": "Bank BRI", "beneficiaryEmail": "foo.bar@baz.com", "customerReference": "10052022", "sourceAccountNo": "888801000157520", "transactionDate": "2021-11-30T10:30:24+07:00", "additionalInfo": { "deviceId": "12345679237", "channel": "mobilephone" } }
Normal Response :
{ "responseCode": "2001800", "responseMessage": "Successful", "referenceNo": "2021120", "partnerReferenceNo": "2021113000000000000001", "amount": { "currency": "IDR", "value": "10000.00" }, "beneficiaryAccountNo": "888801000157508", "beneficiaryBankCode": "002", "sourceAccountNo": "888801000157520", "additionalInfo": { "channel": "mobilephone", "deviceId": "12345679237" } }
Error Response :
{ "responseCode": "4001801", "responseMessage": "Invalid Field Format transaction date" }
List of Error/Response Code
HTTP Status |
Service Code |
Code |
Status |
Response Description |
Deskripsi |
---|---|---|---|---|---|
200 |
18 |
00 |
Sukses |
Successful |
|
202 |
18 |
00 |
In Progress |
Request In Progress |
|
400 |
18 |
01 |
Gagal |
Invalid Field Format {fieldName} |
|
400 |
18 |
02 |
Gagal |
Invalid Mandatory Field {fieldName} |
|
401 |
18 |
00 |
Gagal |
Unauthorized. Client |
|
403 |
18 |
02 |
Gagal |
Exceeds Transaction Amount Limit |
|
403 |
18 |
14 |
Gagal |
Insufficient Funds |
|
403 |
18 |
15 |
Gagal |
Transaction Not Permitted. [reason] |
|
403 |
18 |
16 |
Pending |
Suspend Transaction |
|
403 |
18 |
18 |
Gagal |
Inactive Card/Account/Customer |
|
404 |
18 |
11 |
Gagal |
Invalid Card/Account/Customer[info]/Virtual Account |
|
404 |
18 |
13 |
Gagal |
Invalid Amount |
|
409 |
18 |
01 |
Gagal |
Duplicate partnerReferenceNo |
|
500 |
18 |
00 |
Pending |
General Error |
|
504 |
18 |
00 |
Pending |
Timeout |
|
Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan