Cek Saldo

Digunakan untuk menanyakan saldo tersedia dari aplikasi yang dimiliki oleh API Key saat ini. Aplikasi yang ditanyakan ditentukan oleh API Key, dan tidak perlu mengirimkan ID aplikasi dalam permintaan.

URL Permintaan

GET https://otp.api.engagelab.cc/v1/balance

Otentikasi

Silakan merujuk ke Otentikasi untuk mempelajari cara melakukan otentikasi API.

Contoh Permintaan

Header Permintaan

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Tidak ada parameter permintaan.

Parameter Respons

Respons Berhasil

Bidang	Tipe	Opsi	Deskripsi
currency	String	Wajib	Mata uang penyelesaian, saat ini ditetapkan ke `USD` (Dolar AS)
balance	String	Wajib	Saldo normal (diperoleh melalui isi ulang)
gift_balance	String	Wajib	Saldo hadiah (diperoleh melalui aktivitas / hadiah, mungkin memiliki tanggal kedaluwarsa, tidak dihitung setelah kedaluwarsa)
total_balance	String	Wajib	Total saldo, sama dengan `balance` + `gift_balance`

{ "currency": "USD", "balance": "123.4500", "gift_balance": "1.0000", "total_balance": "124.4500" }

              
              {
    "currency": "USD",
    "balance": "123.4500",
    "gift_balance": "1.0000",
    "total_balance": "124.4500"
}

Tampilkan blok kode ini di jendela mengambang

Deskripsi Bidang

Semua jumlah adalah desimal string, mempertahankan 4 tempat desimal. Desain ini untuk menghindari kesalahan presisi selama transmisi dan parsing angka floating-point. Harap gunakan tipe desimal presisi tinggi (seperti BigDecimal / Decimal dalam berbagai bahasa) untuk parsing, dan jangan menghitung langsung sebagai angka floating-point.
Mata Uang: Saat ini, semua aplikasi diselesaikan dalam Dolar AS (USD).
Saldo mungkin negatif: Untuk aplikasi yang telah mengaktifkan kuota cerukan, balance / total_balance mungkin mengembalikan nilai negatif (seperti "-12.3400") setelah cerukan, yang menunjukkan bahwa ada tunggakan. Harap isi ulang tepat waktu.
total_balance dihitung secara konsisten oleh server pada saat yang sama dan dapat langsung digunakan untuk tampilan dan rekonsiliasi.

Respons Gagal

Kode status HTTP adalah 4xx atau 5xx, dan badan respons berisi bidang berikut:

Bidang	Tipe	Opsi	Deskripsi
code	int	Wajib	Kode kesalahan, silakan merujuk ke deskripsi kode kesalahan untuk detailnya
message	String	Wajib	Detail kesalahan

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

Tampilkan blok kode ini di jendela mengambang

Kode Kesalahan

Kode Kesalahan	http code	Deskripsi
1000	500	Kesalahan internal, silakan coba lagi nanti
2001	401	Otentikasi gagal, token tidak valid
2002	401	Otentikasi gagal, token telah kedaluwarsa atau dinonaktifkan
2002	403	Aplikasi tidak tersedia (dihapus atau dinonaktifkan)