Balance Inquiry
| API Name | Balance Inquiry |
|---|
| Function | API ini digunakan untuk menanyakan saldo PakaiLink melalui merchant |
| Service Code | 11 |
| Method | POST |
| URL | /snap/v1.0/balance-inquiry |
| Content Type | application/json |
| Related Service | Balance Inquiry |
Request
Header
| No | Name | Type | Length | Required | Condition | Remarks |
|---|
| 1 | Content-Type | String | Variable, 127 max | Wajib | – | Tipe konten, nilai selalu application/json |
| 2 | Authorization | String | Variable | Wajib | – | Berisi B2B Bearer JWT Token, yang telah Anda peroleh dari Access Token B2B |
| 3 | Authorization – Customer | String | Variable, 64 max | Optional | Jika Anda ingin cek saldo melalui merchant | Berisi customer token yang didapat dari Access Token B2B2C |
| 4 | X-TIMESTAMP | String | Fixed, 25 max | Wajib | – | Tanggal dan waktu transaksi, dalam format. YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam format GMT+7 (Jakarta time) |
| 5 | X-PARTNER-ID | String | Variable, 36 max | Wajib | – | ID untuk mitra yang dihasilkan oleh PakaiLink. ID unik untuk setiap mitra. |
| 6 | X-EXTERNAL-ID | String | Variable, 36 max | Wajib | – | ID referensi pesan unik yang dihasilkan oleh merchant. String numerik. Nomor referensi yang harus unik dalam satu hari yang sama. |
| 7 | CHANNEL-ID | String | Variable, 5 max | Wajib | – | Identifikasi perangkat tempat layanan API diakses oleh pengguna akhir (pelanggan) saat ini. Daftar Channel ID dapat dilihat di sini. |
| 8 | X-SIGNATURE | String | Variable | Wajib | – | Signature harus dihasilkan dengan metode Symmetric Signature |
Body
| No | Name | Type | Length | Required | Condition | Remarks |
|---|
| 1 | parnerReferenceNo | String | Variable, 64 max | Wajib | – | Pengidentifikasi unik di sistem mitra untuk setiap transaksi. |
| 2. | accountNo | String | Variable, 16 max | Optional | Harus diisi jika Authorization-Customer Null. | Pengidentifikasi unik untuk masing-masing merchant. |
| 3 | balanceType | Array of String | Variable | Wajib | – | Selalu memiliki nilai balance |
Contoh Request
POST /snap/v1.0/balance-inquiry
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJQQUtBSUxJTksiLCJqdGkiOiIyNDc0NzdlNjk0ZGM3N2FhZDU5YzA4MjA1NzdmZmViNyIsImV4cCI6MTE3NDAyOTc2NzgsImFzIjoicGFydG5lciIsImlkIjoiUFRSMDAwMDAwMyJ9.XmUxHExWILJCHJG74Af8TPJljX2aOmUz4UwJXumxkqxW9uDsIrSX_M_j0uRzPOmaBkk2_rQiHIo_OX_qxv45Mg
Content-Type: application/json
X-TIMESTAMP: 2025-01-30T12:38:12+07:00
X-PARTNER-ID: PTR0000003
X-EXTERNAL-ID: 1187412354
X-SIGNATURE: AaE7rxaiIFPQYryj+JxwOi826dQG4e8RbzagEBaAywS4ETa490Cy/3b1/Ljqput67EF+OgE0V1GDw2t/lxqEJw==
CHANNEL-ID: 95221
{
"partnerReferenceNo": "6YUwldTHgKr362EkL1oWMMYjrMuUHqyNMTQT",
"accountNo": "2536265359300003",
"balanceTypes": ["Balance"]
}
Response
Body
| No | Name | Type | Length | Required | Condition | Remarks |
|---|
| 1 | responseCode | String | Fixed, 7 max | Wajib | – | Lihat daftar kode respons. |
| 2 | responseMessage | String | Variable, 150 max | Wajib | – | Lihat daftar kode respons. |
| 3 | referenceNo | String | Variable, 64 max | Wajib | – | Identifikasi transaksi yang sedang berlangsung |
| 4. | partnerReferenceNo | String | Variable, 64 max | Wajib | – | Nomor referensi yang unik yang digunakan oleh mitra untuk mengidentifikasi transaksi |
| 5 | accountNo | String | Variable, 32 max | Wajib | – | Nomor akun yang teregister |
| 6 | name | String | Variable, 140 max | Wajib | – | Nama akun mitra |
| 8 | accountInfo | Array of Object | Variable | Wajib | – | Daftar. contoh: BALANCE, CASH, QRIS, POINTS dll |
| 9 | accountInfo.balanceType | String | Variable, 70 max | Wajib | – | Untuk menentukan jenis saldo mana yang ingin dikembalikan. Akan mengembalikan semua jenis saldo yang tersedia jika parameter ini kosong |
| 10 | accountInfo.amount | Money | Variable | Wajib | – | Daftar, jumlah yang aktif. Berisi dua sub-field.
Nilai: Total Amount, termasuk pecahan Mata uang: Kode mata uang berdasarkan ISO |
| 11 | accountInfo.status | String | Variable, 4 max | Wajib | – | Status akun: 0001=Aktif 0002=Ditutup 0004=Akun baru 0006=Terbatas 0007=Dibekukan |
Contoh Response
{
"responseCode": "2001100",
"responseMessage": "Successful",
"referenceNo": "BLC0000003",
"partnerReferenceNo": "6YUwldTHgKr362EkL1oWMMYjrMuUHqyNMTQT",
"accountNo": "2536265359300003",
"name": "Celline Septiana",
"accountInfo": [
{
"balanceType": "Balance",
"activeBalance": {
"value": "888000.00",
"currency": "IDR"
},
"freezeBalance": {
"value": "0.00",
"currency": "IDR"
},
"holdBalance": {
"value": "180000.00",
"currency": "IDR"
},
"status": "0001"
}
]
}
Kode dan Pesan Response
| No | Response Kode | Response Pesan | Keterangan |
|---|
| 1 | 2001100 | Successful | Request telah berhasil diproses tanpa ada masalah |
| 2 | 4001101 | Invalid Field Format | Panjang informasi tidak boleh melebihi 150 karakter |
| 3 | 4001102 | Invalid Wajib Field | Kolom atau field yang wajib diisi tidak lengkap atau formatnya tidak sesuai dengan yang diharapkan |
| 4 | 4011100 | Unauthorized. [reason] | Kesalahan umum yang terjadi ketika pengguna atau sistem tidak memiliki izin untuk mengakse tindakan tertentu |
| 5 | 4011101 | Invalid Token (B2B) | Token akses yang digunakan untuk otentikasi tidak sah atau sudah kedaluwarsa |
| 6 | 4091100 | Conflict | X-EXTERNAL-ID tidak dapat digunakan lebih dari sekali dalam satu hari yang sama |
| 7 | 4091101 | Duplicate partnerReferenceNo | Nomor referensi mitra (partnerReferenceNo, trxId) yang digunakan sudah terdaftar atau digunakan sebelumnya dalam sistem |
| 8 | 5001102 | Backend system failure | Kesalahan yang terjadi di server saat mencoba memproses request |
