API Inquiry Rekening Bank RAYA
Informasi API
|
Title |
API Inquiry Rekening Bank RAYA |
|---|---|
|
Version |
SNAP v1 |
|
URL Sandbox |
https://api.sandbox.bankraya.co.id/snap/v1.0/balance-inquiry |
|
URL Production |
Informed After Production Request Approved |
Kendali Versi
|
API Version |
Date |
Link to document |
Description |
|---|---|---|---|
|
v1 |
5 Maret 2021 |
|
Baseline version. |
| SNAP v1 | 25 Januari 2023 | this pages | SNAP BI specs |
Deskripsi Produk
API ini memungkinkan mitra untuk mendapatkan informasi rekening milik nasabah. Data tersebut terdiri dari nama akun, saldo, dan status.
Endpoint
A. Inquiry Rekening: Single
Penjelasan Endpoint
API ini digunakan untuk memeriksa informasi salah satu rekening milik nasabah, seperti nama akun, saldo, dan status.
Informasi Umum
|
HTTP Method |
POST |
|---|---|
|
Path |
/snap/v1.0/balance-inquiry |
|
Tipe Format |
JSON |
|
Authentication |
Token & Signature |
Header Structure
|
Key |
Mandatory |
Type |
Description |
|---|---|---|---|
| X-SIGNATURE | M | String | HMAC_SHA512 |
| X-TIMESTAMP | M | Datetime | Format Timestamp ISO8601 |
| X-PARTNER-ID | M | Alphanumeric | Partner ID for integration. Using the same value as the client_id parameter used in Token endpoint |
| X-EXTERNAL-ID | M | Numeric | Unique numeric for API request |
| CHANNEL-ID | M | Alphanumeric | Channel used by Partner, Value provided by Bank Raya |
|
Authorization |
M |
String |
Bearer {Token} |
Request Structure
|
Key |
Mandatory |
Type |
Description |
Example |
|---|---|---|---|---|
|
accountNo |
M |
String(15) |
Account Number of the customer |
001001000060300 |
Request & Response Payload Sample
Request:
{"accountNo":"001001000060300"}
Normal Response:
{
"responseCode": "2001100",
"responseMessage": "Successful",
"accountNo": "001001000060300",
"name": "MONIKA SARI FARDANI",
"accountInfo": [
{
"holdAmount": {
"value": "273000.00",
"currency": "IDR"
},
"availableBalance": {
"value": "12997626578.50",
"currency": "IDR"
},
"ledgerBalance": {
"value": "12997899578.50",
"currency": "IDR"
},
"status": "1"
}
],
"additionalInfo": {
"productType": "00090 (SAKU BUJET)",
"accountType": "S"
}
}
Error Response:
{
"responseCode": "4011100",
"responseMessage": "Unauthorized Signature"
}
{
"responseCode": "4001101",
"responseMessage": "Invalid Format Field X-EXTERNAL-ID"
}
{
"responseCode": "4011100",
"responseMessage": "Unauthorized Client"
}
{
"responseCode": "4091100",
"responseMessage": "Conflict"
}
{
"responseCode": "4031115",
"responseMessage": "Transaction Not Permitted. Don`t Have Access At This Account"
}
{
"responseCode": "4001102",
"responseMessage": "Invalid Mandatory Field accountNo"
}
{
"responseCode": "4001101",
"responseMessage": "Invalid Field Format accountNo"
}
{
"responseCode": "5001101",
"responseMessage": "Internal Server Error"
}
B. Inquiry Rekening: Multiple
Deskripsi Endpoint
Api ini digunakan untuk memeriksa informasi beberapa rekening secara sekaligus.
Informasi Umum
|
HTTP Method |
POST |
|---|---|
|
Path |
/snap/v1.0/balance-inquiry-multiple |
|
Tipe Format |
JSON |
|
Authentication |
Token & Signature |
Header Structure
|
Key |
Mandatory |
Type |
Description |
|---|---|---|---|
| X-SIGNATURE | M | String | HMAC_SHA512 |
| X-TIMESTAMP | M | Datetime | Format Timestamp ISO8601 |
| X-PARTNER-ID | M | Alphanumeric | Partner ID for integration. Using the same value as the client_id parameter used in Token endpoint |
| X-EXTERNAL-ID | M | Numeric | Unique numeric for API request |
| CHANNEL-ID | M | Alphanumeric | Channel used by Partner, Value provided by Bank Raya |
|
Authorization |
M |
String |
Bearer {Token} |
Request Structure
|
Key |
Mandatory |
Type |
Description |
Example |
|---|---|---|---|---|
|
cifNo |
M |
String(10) |
CIF Number of the customer |
0000000423 |
Request & Response Payload Sample
Request:
{"cifNo":"0000000423"}
Normal Response:
{
"responseCode": "2001100",
"responseMessage": "Successful",
"data": [
{
"accountNo": "001001000060300",
"balance": "12997940078.50",
"currency": "IDR",
"type": "SAKU BUJET",
"name": "MONIKA SARI FARDANI",
"productType": "00090"
},
{
"accountNo": "001001001503301",
"balance": "6988810.75",
"currency": "IDR",
"type": "TABUNGAN RAYA INFINITI",
"name": "MONIKA SARI FARDANI",
"productType": "00002"
},
{
"accountNo": "001001000719307",
"balance": "0.00",
"currency": "IDR",
"type": "TABUNGAN RAYA",
"name": "MONIKA SARI FARDANI",
"productType": "00005"
},
{
"accountNo": "001001000715507",
"balance": "62983799.63",
"currency": "IDR",
"type": "IDR DEPOSITO BERJANGKA 1 BLN ",
"name": "MONIKA SARI FARDANI",
"productType": "00001"
},
{
"accountNo": "001001000716503",
"balance": "62983799.63",
"currency": "IDR",
"type": "IDR DEPOSITO BERJANGKA 1 BLN ",
"name": "MONIKA SARI FARDANI",
"productType": "00001"
},
{
"accountNo": "001001000717509",
"balance": "31491899.01",
"currency": "IDR",
"type": "IDR DEPOSITO BERJANGKA 1 BLN ",
"name": "MONIKA SARI FARDANI",
"productType": "00001"
},
{
"accountNo": "001001000784506",
"balance": "55762692.29",
"currency": "IDR",
"type": "IDR DEPOSITO BERJANGKA 1 BLN ",
"name": "MONIKA SARI FARDANI",
"productType": "00001"
}
]
}
Error Response:
{
"responseCode": "4011100",
"responseMessage": "Unauthorized Signature"
}
{
"responseCode": "4001101",
"responseMessage": "Invalid Format Field X-EXTERNAL-ID"
}
{
"responseCode": "4011101",
"responseMessage": "Unauthorized Client"
}
{
"responseCode": "4091100",
"responseMessage": "Conflict"
}
{
"responseCode": "4001101",
"responseMessage": "Invalid Field Format cifNo"
}
{
"responseCode": "4001102",
"responseMessage": "Invalid Mandatory Field cifNo"
}
{
"responseCode": "5001101",
"responseMessage": "Internal Server Error"
}