API INQUIRY SALDO

Permintaan

API Inquiry Saldo memungkinkan pedagang untuk mengambil informasi saldo akun waktu nyata.

Jalur Permintaan:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-balance
production: https://gateway.smilepayz.com/v2.0/inquiry-balance

Parameter Header

Field	Required	Type	Description
Content-Type	M	String	Spesifikasi tipe konten HTTP Nilai tetap: application/json Diperlukan untuk parsing permintaan yang tepat
X-TIMESTAMP	M	String	Format datetime ISO 8601 dengan offset timezone Format: yyyy-MM-ddTHH:mm:ss±HH:mm Contoh: 2020-12-17T10:55:00+07:00 Catatan: Harus waktu server saat ini dalam ±5 menit
X-SIGNATURE	M	String	Tanda tangan digital untuk autentikasi permintaan. Lihat Pembuatan Tanda Tangan
X-PARTNER-ID	M	String	Pengidentifikasi pedagang unik yang ditugaskan oleh platform Format: String alfanumerik Digunakan untuk autentikasi pedagang dan routing transaksi Silakan masukkan merchantID

Parameter Body

Field	Required	Type	Description
accountNo	M	String(128)	Pengidentifikasi akun pedagang untuk inquiry saldo Format: String alfanumerik Panjang maksimum: 128 karakter Digunakan untuk mengidentifikasi akun tertentu untuk pengambilan saldo
balanceTypes	M	List(String)	Spesifikasi tipe saldo untuk diambil Format: Array dari kode tipe saldo yang telah ditentukan Default: ["BALANCE"] Contoh: BALANCE, AVAILABLE

Catatan Penting

1. Lingkungan Sandbox: accountNo menggunakan nilai string yang dibuat secara acak untuk tujuan pengujian
2. Lingkungan Production: accountNo dapat diambil dari sistem backend pedagang.
Lihat Cara Mendapatkan Nomor Akun Production
3. Akun Pay-In: Digunakan untuk mengumpulkan dana dari semua transaksi pembayaran masuk
4. Akun Pay-Out: Digunakan untuk memproses transaksi pencairan dan penarikan
5. Transfer Akun: Saldo dapat ditransfer antara tipe akun yang berbeda.
Lihat Panduan Transfer Akun

Contoh Header – Permintaan Inquiry Saldo:

POST {Base URL}/v2.0/inquiry-balance HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
  "accountNo": "21020030202403071031",
  "balanceTypes": [
    "BALANCE"
  ]
}

Respons

Permintaan HTTP

Field	Required	Type	Description
Content-Type	M	String	Spesifikasi tipe konten respons HTTP Nilai tetap: application/json Menunjukkan format respons JSON
X-TIMESTAMP	M	String	Format datetime ISO 8601 dengan offset timezone Format: yyyy-MM-ddTHH:mm:ss±HH:mm Contoh: 2020-12-17T10:55:00+07:00

Respons Body

Field	Required	Type	Description
code	M	String	Kode status respons API yang menunjukkan hasil operasi Format: String dua digit Sukses: "00", Error: Kode lainnya Digunakan untuk penanganan respons programatik
message	M	String	Deskripsi status respons yang dapat dibaca manusia Format: String yang dikodekan UTF-8 Memberikan informasi terperinci tentang hasil operasi
accountInfos	M	BalanceAccounts	Kontainer informasi saldo akun Berisi tipe saldo, jumlah, dan detail saldo tersedia Lihat Model BalanceAccounts
accountNo	O	String	Pengidentifikasi akun asli untuk referensi Format: Sama dengan accountNo permintaan Digunakan untuk verifikasi dan pelacakan akun
balanceTypes	O	List	Tipe saldo yang diminta yang diproses Format: Array dari kode tipe saldo Berisi tipe saldo yang berhasil diambil
name	O	String	Nama pemegang akun untuk tujuan tampilan Format: String yang dikodekan UTF-8 Ditampilkan dalam hasil inquiry saldo
additionalInfo	O	JsonString	Informasi akun tambahan dan metadata Format: Objek JSON Berisi detail akun tambahan ketika tersedia

Contoh Body – Respons Inquiry Saldo:

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
  "code": "00",
  "message": "Successful",
  "accountNo": "21020030202403071031",
  "name": "Sandbox Test",
  "balanceTypes": [
    "balance"
  ],
  "accountInfos": {
    "balanceType": "BALANCE",
    "amount": {
      "currency": "IDR",
      "value": "250000"
    },
    "availableBalance": {
      "currency": "IDR",
      "value": "250000"
    }
  }
}