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 |
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 |
---|---|---|---|---|---|---|
beneficiaryAccountCode |
String |
Numeric |
M |
3
Note : SNAP BI length (8) |
Kode Bank tujuan |
002 |
beneficiaryAccountNo |
String |
Numeric |
M |
34 |
Nomor Rekening penerima |
88880 10001 57508 |
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 |
Alphanum eric |
M |
150 |
response Message |
Successful |
referenceNo |
String |
Numeric |
O Note : SNAP BI (C) |
64 |
Identifikasi transaksi pada pada sistem penyedia layanan. harus diisi setelah transaksi berhasil |
20201 02977 77000 0000009
|
partnerReferenceNo |
String |
Alphanumeric |
O |
64 |
Identifikasi transaksi pada sitem layanan konsumen |
20201 02900 00000 0000001 |
beneficiaryAccount Name |
String |
Alphanum eric |
M |
100 |
Nama Rekening Penerima |
Yories Yolanda |
beneficiaryAccount No |
String |
Numeric |
M |
34 |
Nomor Rekening Penerima |
88880 10001 57508 |
beneficiaryBankCo de |
String |
Numeric |
O |
8 |
Kode Bank penerima |
002 |
beneficiaryBankNa me |
String |
Alphanum eric |
O |
50 |
Nama Bank penerima |
Bank BRI |
currency |
String |
Alphanum eric |
O |
3 |
Mata Uang |
IDR |
additionalInfo |
Object |
|
O |
|
|
mobilephone |
>deviceId |
String |
Alphanum eric |
O |
|
|
12345 679237 |
>channel |
String |
Alphanum eric |
O |
|
|
mobilephone |
Request & Response Payload Sample
Request :
{
"beneficiaryAccountCode": "002",
"beneficiaryAccountNo": "888801000157508",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone"
}
}
Normal Response :
{ “responseCode”: “2001600”, “responseMessage”: “Successful”, “referenceNo”: “2020102977770000000009”, “partnerReferenceNo”: “2020102900000000000001”, “beneficiaryAccountName”: “Yories Yolanda”, “beneficiaryAccountNo”: “888801000157508”, “beneficiaryBankCode”: “002”, “beneficiaryBankName”: “Bank BRI”, “currency”: “IDR”, “additionalInfo”: { “channel”: “mobilephone”, “deviceId”: “12345679237” } }
Error Response :
{ "responseCode": "4001601", "responseMessage": "Invalid Field Format beneficiaryAccountCode" }
List of Error/Response Code
HTTP Status |
Service Code |
Code |
Status |
Response Description |
Deskripsi |
---|---|---|---|---|---|
200 |
16 |
00 |
Sukses |
Successful |
|
400 |
16 |
01 |
Gagal |
Invalid Field Format |
|
400 |
16 |
02 |
Gagal |
Invalid Mandatory |
|
403 |
16 |
15 |
Gagal |
Transaction Not Permitted |
|
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 |
|
504 | 16 | 00 | Pending | Timeout | |
500 | 16 | 01 | Pending | Unknown Error |
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 |
X-EXTERNAL-ID = customerReference |
Request Structure
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
partnerReferen ceNo |
String |
Alphanum eric |
M |
64 |
Identifikasi transaksi pada sistem penyedia layanan |
2020102900000 000000001 |
amount |
Object |
|
O |
|
|
|
>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 |
Alphanum eric |
M |
3 |
Mata uang |
IDR |
beneficiaryAcc ountName |
String |
Alphanum eric |
M |
100 |
Nama rekening penerima |
Yories Yolanda |
beneficiaryAcc ountNo |
String |
Numeric |
M |
16
Note : SNAP BI Length (34) |
Rekening Penerima |
8888010001575 08 |
beneficiaryAdd ress |
String |
Alphanum eric |
O |
100 |
Alamat penerima |
Palembang |
beneficiaryBan kCode |
String |
Numeric |
M |
3
Note : SNAP BI Length (8) |
Kode Bank penerima |
002 |
beneficiaryBan kName |
String |
Alphanum eric |
O |
50 |
Nama Bank penerima |
Bank BRI |
beneficiaryEm ail |
String |
Alphanum eric |
O |
50 |
Email penerima |
|
customerRefer ence |
String |
Alphanum eric |
M Note : SNAP BI (O) |
20
Note : SNAP BI Length (30) |
Nomor referensi / No Referral / ID transaksi |
10052022 |
sourceAccount No |
String |
Numeric |
M |
15
Note : SNAP BI Length (19) |
Nomor akun sumber |
8888010001575 20 |
transactionDate |
String |
Datetime |
M |
25 |
tanggal transaksi : ISO 8601 |
2021-11-25 |
additionalInfo |
Object |
|
O |
|
Informasi tambahan |
|
>deviceId |
String |
Alphanum eric |
M |
|
|
1234579237 |
>channel |
String |
Alphanum eric |
M |
|
|
mobilephone |
Response Structure & Sample
Field |
Data Type |
Format |
Mandatory |
Length |
Deskripsi |
Contoh |
---|---|---|---|---|---|---|
responseCode |
String |
Numeric |
M |
7 |
Response code |
2001800 |
responseMes sage |
String |
Alphanum eric |
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 |
202010297777 0000000009 |
partnerRefer enceNo |
String |
Alphanum eric |
O |
64 |
Identifikasi transaksi pada sitem layanan konsumen |
202010290000 0000000001 |
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 |
Alphanum eric |
M |
3 |
Mata uang |
IDR |
beneficiaryAc countNo |
String |
Numeric |
M |
34
Note : SNAP BI Length (19) |
Nomor rekening penerima |
888801000157 508 |
beneficiaryBa nkCode |
String |
Numeric |
O |
3
Note : SNAP BI Length (8) |
Kode Bank penerima |
002 |
sourceAccou ntNo |
String |
Numeric |
O |
15
Note : SNAP BI Length (19) |
Nomor akun sumber |
888801000157 520 |
additionalInfo |
Object |
|
O |
|
Informasi tambahan |
|
>deviceId |
String |
Alphanum eric |
O |
|
|
12345679237 |
>channel |
String |
Alphanum eric |
O |
|
|
mobilephone |
Request & Response Payload Sample
Request :
{
"partnerReferenceNo": "2021113000000000000001",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"beneficiaryAccountName": "Yories Yolanda",
"beneficiaryAccountNo": "888801000157508",
"beneficiaryAddress": "Palembang",
"beneficiaryBankCode": "002",
"beneficiaryBankName": "Bank BRI",
"beneficiaryEmail": "yories.yolanda@work.bri.co.id",
"customerReference": "10052022",
"sourceAccountNo": "888801000157520",
"transactionDate": "2021-11-30T10:30:24+07:00",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone"
}
}
Normal Response :
{ "responseCode": "2001800", "responseMessage": "Successful", "referenceNo": "202112010000000001", "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 |
|
400 |
18 |
02 |
Gagal |
Invalid Mandatory Field |
|
403 |
18 |
02 |
Failed |
Exceeds Transaction Amount Limit |
|
403 |
18 |
14 |
Gagal |
Insufficient Funds |
|
403 |
18 |
15 |
Gagal |
Transaction Not Permitted |
|
403 |
18 |
16 |
Pending |
Suspend Transaction |
|
403 |
18 |
18 |
Gagal |
Invalid Card/Account/Customer |
|
404 |
18 |
11 |
Gagal |
Invalid Card/Account/Customer[info]/Virtual Account |
|
404 |
18 |
13 |
Gagal |
Invalid Amount |
|
409 |
18 |
00 |
Gagal |
Conflict |
|
500 | 18 | 00 | Pending | General | |
504 | 18 | 00 | Pending | Timeout |