Biller Product

Check Balance

Check Balance merupakan layanan yang dapat digunakan untuk memeriksa jumlah saldo yang tersedia. Layanan ini hanya berlaku bagi merchant yang menggunakan mekanisme Deposit, karena transaksi diproses melalui pemotongan saldo secara langsung. Bagi merchant yang menggunakan mekanisme Invoicing, layanan ini tidak diperlukan, karena pembayaran dilakukan melalui sistem penagihan (invoice), bukan berdasarkan saldo.

Flow

Kirimkan parameter yang diperlukan dalam permintaan Anda, dan Espay Biller Product akan memberikan respons dalam format JSON.

API URL

Environment URL
Sandbox
https://sandbox-api.espay.id/rest/billertools/getbalance
Production
https://api.espay.id/rest/billertools/getbalance

Authorization

Setiap permintaan yang Anda kirim, harus menyertakan header Authorization menggunakan Basic Auth. Pelajari lebih lanjut Basic Auth.

Authorization: Basic {base64(username:password)}
Key Value
Method
POST
HTTP Version
HTTP/1.1
Accept
*/*
Content-Length
<dynamic>
Content-Type
application/x-www-form-urlencoded
Authorization
Basic base64(username:password)

Parameter Permintaan

Parameter Tipe Mandatory Keterangan
rq_uuid
String (255)
Y
Request identifier. ID unik yang digunakan untuk mengidentifikasi pesan.

Format:
Sender_id + Unik ID

Contoh:
SENDERID123ABC-DEF456
rq_datetime
String (19)
Y
Tanggal dan waktu transaksi yang dikirim dari server merchant.

Format:
YYYY-MM-DD HH:MM:SS

Contoh:
2024-12-17 12:30:45
sender_id
String (32)
Y
Kode identitas merchant yang diberikan oleh tim Espay.
password
String (32)
Y
Kata sandi yang diberikan oleh tim Espay.
Y: Yes, O: Optional, C: Conditional

Parameter Respons

Parameter Tipe Mandatory Keterangan
rq_uuid
String (255)
Y
Request identifier. ID unik yang digunakan untuk mengidentifikasi pesan.

Format:
Sender_id + Unik ID

Contoh:
SENDERID123ABC-DEF456
rq_datetime
String (19)
Y
Tanggal dan waktu transaksi yang dikirim dari server merchant.

Format:
YYYY-MM-DD HH:MM:SS

Contoh:
2024-12-17 12:30:45
error_code
String (4)
Y
Kode respons.

Format:
  • Sukses: 0000
  • Gagal: xxxx
error_desc
String (128)
Y
Deskripsi respons.
balance
...
...
Total saldo deposit.
Y: Yes, O: Optional, C: Conditional












































Sample Permintaan

POST /rest/billertools/getbalance HTTP/1.1
Host: sandbox-api.espay.id
Content-Length: 176
Content-Type: application/x-www-form-urlencoded
Authorization: Basic RU5TRVZBTDprVXVYUjVNUkRtcHZrY1lk
    
rq_uuid=getbalance018&
rq_datetime=2018-01-15 10:33:43&
sender_id=SENDERID&
password=p45w0rd&
signature=db420be770fef07ebdc23378456a1c6b7c6b3cd9aadef39cb2784f0bb48bf869
               

















Sample Respons Positif

{
   "rq_uuid":"getbalance09",
   "rq_datetime":"2018-01-15 10:45:50",
   "error_code":"getbalance09",
   "error_desc":"2018-01-15 10:45:50",
   "balance":"16127451.00"
}
                


Sample Respons Negatif

{
   "rq_uuid":"getbalance018",
   "rs_datetime":"2025-10-14 13:25:10",
   "error_code":"EX",
   "error_desc":"Cannot map server service. Record not found"
}
                    


HTTP

POST /rest/billertools/getbalance HTTP/1.1
Host: sandbox-api.espay.id
Content-Type: application/x-www-form-urlencoded
Authorization: Basic ZXNwYXktdGVzdDp0ZXN0
Content-Length: 170

rq_uuid=getbalance018&rq_datetime=2018-01-15%2010%3A33%3A43&sender_id=SENDERID&password=p45w0rd&signature=db420be770fef07ebdc23378456a1c6b7c6b3cd9aadef39cb2784f0bb48bf869
               


CURL

curl --location 'https://sandbox-api.espay.id/rest/billertools/gettransactioninfo' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic ZXNwYXktdGVzdDp0ZXN0' \
--data-urlencode 'rq_uuid=ESPAY123ABC-456DEF' \
--data-urlencode 'rq_datetime=2017-12-17 12:22:32' \
--data-urlencode 'sender_id=ESPAY' \
--data-urlencode 'password=espaypass' \
--data-urlencode 'signature=c26a2a9901941a2eefd9c529c38822fabbd470c2693d40465616fa3fd58a0b26' \
--data-urlencode 'ref_id=TX1712171209991FA'
               
Scroll to Top