Account Inquiry
Spesifikasi
Tabel berikut adalah spesifikasi dari API ini :
API Name | Account Inquiry |
---|---|
Function | API ini digunakan oleh pedagang untuk melakukan pertanyaan informasi akun bank melalui Paydia Bisnis |
Service Code | 42 |
Method | POST |
URL | /snap/v1.0/emoney/bank-account-inquiry |
Accept | application/json |
Content Type | application/json |
Related Service | Transfer to Bank |
Request
Bagian berikut akan menjelaskan tentang parameter permintaan dalam API ini:
Request Params
Tabel berikut adalah daftar parameter permintaan dalam API ini:
Header
Tabel berikut adalah Header dari Parameter Permintaan :
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | Content-Type | String | Variabel, maksimal 127 karakter | Mandatory | - | Jenis konten, nilai selalu application/json |
2 | Authorization | String | Variabel | Opsional | Jika opsi Signature adalah pendekatan asimetris | Berisi Token B2B Bearer JWT, Anda mendapatkannya dari Access Token B2B |
3 | X-TIMESTAMP | String | Tetap, maksimal 25 karakter | Mandatory | - | Waktu tanggal transaksi, dalam format YYYY MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
4 | X-SIGNATURE | String | Variabel | Mandatory | - | Signature akan dihasilkan secara otomatis dengan metode symmetricSignature atau asymmetricSignature |
5 | X-PARTNER-ID | String | Variabel, maksimal 36 karakter | Mandatory | - | ID untuk mitra yang dihasilkan oleh Paydia. ID unik untuk seorang mitra |
6 | X-EXTERNAL-ID | String | Variabel, maksimal 36 karakter | Mandatory | - | ID referensi pesan unik yang dihasilkan oleh pedagang. String numerik. Nomor referensi yang harus unik pada hari yang sama |
7 | CHANNEL-ID | String | Variabel, maksimal 5 karakter | Mandatory | - | Identifikasi perangkat tempat layanan API saat ini diakses oleh pengguna akhir (pelanggan) |
Header
Tabel berikut adalah isi dari Parameter Permintaan:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | partnerReferenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifier transaksi pada sistem konsumen layanan |
2 | amount | Uang | Variabel | Mandatory | - | Berisi dua sub-bidang:
|
3 | beneficiaryAccountNumber | String | Variabel, maksimal 32 karakter | Mandatory | - | Nomor rekening tujuan |
4 | additionalInfo | Objek JSON | Variabel | Mandatory | - | Informasi tambahan |
5 | additionalInfo.beneficiaryBankCode | String | Variabel, maksimal 8 karakter | Mandatory | - | Informasi tambahan kode bank penerima |
Contoh Request
Script berikut adalah contoh permintaan dari API ini:
POST .../snap/v1.0/emoney/bank-account-inquiry HTTP/1.1
X-Timestamp: 2023-06-20T13:37:23+07:00
X-Signature: VcyXz6UE7QMpTU6CO6CnZLt1ns1htNrxLhEgO731lhIB401B69fIRVEN5nJBHwUp2djvIeuQAcN/o2fmhDWmmg==
X-Partner-Id: 8f548c9c439139b2285269e56db6b8ed
X-External-Id: 1687243078
Channel-Id: 128
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2ODcyNDMwMzksImV4cCI6MTY4NzI0MzkzOX0.S3BZ0EPoMar1XE3l3aeKKkeGS5JjXYdLs1jXZYGAqLU
{
"partnerReferenceNo": "9d694c08-4889-40f6-8160-b51099fbc2fb",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"beneficiaryAccountNumber": "0123456789",
"additionalInfo": {
"beneficiaryBankCode": "014"
}
}
Response
Bagian berikut akan menjelaskan tentang parameter tanggapan dalam API ini:
Response Params
Tabel berikut adalah daftar parameter tanggapan dalam API ini:
Header
Tabel berikut adalah isi Parameter Body Respon:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Tetap, maksimal 7 karakter | Mandatory | - | Lihat daftar kode tanggapan |
2 | responseMessage | String | Variabel, maksimal 150 karakter | Mandatory | - | Lihat daftar kode tanggapan |
3 | referenceNo | String | Variabel, maksimal 64 karakter | Opsional | - | Identifier transaksi pada sistem Paydia |
4 | partnerReferenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifier transaksi pada sistem mitra |
5 | beneficiaryAccountNumber | String | Variabel, maksimal 32 karakter | Mandatory | - | Nomor rekening penerima |
6 | beneficiaryAccountName | String | Variabel, maksimal 64 karakter | Mandatory | - | Nama rekening penerima |
7 | beneficiaryBankCode | String | Variabel, maksimal 8 karakter | Mandatory | - | Kode Bank penerima |
8 | beneficiaryBankName | String | Variabel, maksimal 25 karakter | Mandatory | - | Nama Bank penerima |
9 | amount | Uang | Variabel | Mandatory | - | Jumlah. Berisi dua sub-bidang:
|
10 | additionalInfo | Objek JSON | Variabel | Mandatory | - | Informasi tambahan |
11 | additionalInfo.balance | Uang | Variabel | Mandatory | - | Informasi tambahan saldo pedagang. Berisi dua sub-bidang:
|
Contoh Tanggapan
Script berikut adalah contoh tanggapan dari API ini:
{
"responseCode": "2004200",
"responseMessage": "Successful",
"referenceNo": "23061658ubdl6",
"partnerReferenceNo": "31fa58e9-ca5b-4e72-aa6d-566464922278",
"beneficiaryAccountNumber": "0123456789",
"beneficiaryAccountName": "John Doe",
"beneficiaryBankCode": "014",
"beneficiaryBankName": "PT Bank Central Asia Tbk",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"balance": {
"value": "500000.00",
"currency": "IDR"
}
}
}
Response Code dan Response Message
Tabel berikut adalah daftar kode tanggapan dan pesan dari API Account Inquiry:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2004200 | Successful | Sukses untuk diproses |
2 | 4004201 | Invalid Field Format | Format tidak valid untuk beberapa bidang |
3 | 4004202 | Invalid Mandatory Field | Hilang atau format tidak valid pada bidang Mandatory |
4 | 4014200 | Unauthorized {reason} | Kesalahan tidak diotorisasi umum |
5 | 4014201 | Unauthorized [Invalid Authorization] | Token akses kedaluwarsa |
6 | 4014201 | Invalid Token | Token ditemukan dalam permintaan tidak valid (Token Akses Tidak Ada, Token Akses Kedaluwarsa) |
7 | 4044203 | Bank Not Supported By Switch | Bank tidak didukung oleh switch |
8 | 4044211 | Invalid Account | Nomor rekening tujuan tidak valid |
9 | 4094200 | Conflict | Tidak dapat menggunakan X-EXTERNAL-ID yang sama dalam satu hari yang sama |
10 | 4094201 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
11 | 5004202 | Backend system failure | Kesalahan server internal 500 |