Cek Saldo Merchant

Mengecek saldo deposit merchant saat ini.

URL: POST /api/v1/balance/merchant

Autentikasi

Endpoint ini menggunakan API Key via header X-API-Key. Signature Validation tidak diterapkan pada endpoint ini.

Request

Headers

Header	Wajib	Keterangan
`X-API-Key`	Ya	API Key merchant
`Content-Type`	Ya	`application/json`

Body

Request body bersifat opsional. Request kosong ({}) atau tanpa body juga diterima.

Field	Tipe	Wajib	Keterangan
`req_id`	String	Tidak	ID request untuk tracing
`ref_id`	String	Tidak	ID referensi untuk tracing
`product_id`	String	Tidak	Kode produk untuk konteks
`cust_id`	String	Tidak	ID customer untuk konteks

Contoh Request (minimal)

curl -s -X POST "https://api-sandbox.alfakios.com/api/v1/balance/merchant" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: apk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{}'

Contoh Request (dengan tracing)

curl -s -X POST "https://api-sandbox.alfakios.com/api/v1/balance/merchant" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: apk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{
    "req_id": "BAL-CHECK-001"
  }'

Response

Spesifikasi

Field	Tipe	Keterangan
`req_id`	String	`req_id` yang dikirim (kosong jika tidak dikirim)
`ref_id`	String	`ref_id` yang dikirim (kosong jika tidak dikirim)
`product_id`	String	`product_id` yang dikirim
`cust_id`	String	`cust_id` yang dikirim
`status`	String	`SUCCESS` atau `FAILED`
`rc`	String	Kode respon
`description`	String	Keterangan RC
`message`	String	Pesan detail
`unit_price`	String	Kosong untuk balance check
`balance_used`	String	Kosong untuk balance check
`balance`	String	Saldo deposit merchant saat ini (dalam IDR)
`serial_no`	String	Bernilai `"balance"` untuk endpoint ini
`data`	Any	Data tambahan (biasanya `null`)

Contoh Response

{
  "success": true,
  "message": "Balance retrieved successfully",
  "rc": "000",
  "data": {
    "req_id": "",
    "ref_id": "",
    "product_id": "",
    "cust_id": "",
    "status": "SUCCESS",
    "rc": "000",
    "description": "",
    "message": "balance retrieved",
    "unit_price": "",
    "balance_used": "",
    "balance": "4493500",
    "serial_no": "balance",
    "data": null
  }
}

Nilai balance adalah Rp 4.493.500 dalam contoh di atas.

Kapan Menggunakannya

Sebelum melakukan transaksi besar, untuk memastikan saldo mencukupi.
Setelah menerima response disbursement dengan rc: "021" (PENDING) — field balance pada response /disbursement/status bisa kosong, gunakan endpoint ini untuk saldo terbaru.
Untuk menampilkan saldo di dashboard aplikasi merchant.

Keyboard shortcuts

Relay Merchant API