Cek Saldo

Jika Anda perlu mengetahui saldo yang tersedia pada akun EngageLab SMS Anda secara real-time, Anda dapat memanggil endpoint ini. Endpoint ini akan mengembalikan saldo reguler, saldo bonus, serta total saldo akun Anda.

Alamat Panggilan

GET https://smsapi.engagelab.com/v1/balance

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

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

Request Body

Tidak ada

Parameter Request

Tidak ada

Parameter Response

Response Sukses

HTTP status code adalah 200, response body berisi field-field berikut:

Field	Tipe	Opsi	Deskripsi
balance10000	Integer	Wajib	Saldo reguler, nilai integer setelah dikalikan 10000
gift_balance10000	Integer	Wajib	Saldo bonus, nilai integer setelah dikalikan 10000
balance	Number	Wajib	Saldo reguler, tipe float
gift_balance	Number	Wajib	Saldo bonus, tipe float
total_balance10000	Integer	Wajib	Total saldo, sama dengan jumlah saldo reguler dan saldo bonus, nilai integer setelah dikalikan 10000
total_balance	Number	Wajib	Total saldo, sama dengan jumlah saldo reguler dan saldo bonus, tipe float

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

Tampilkan blok kode ini di jendela mengambang

Saran Pengembangan Disarankan agar pemanggil memprioritaskan penggunaan field balance10000, gift_balance10000, dan total_balance10000 untuk memformat saldo sendiri, guna menghindari masalah presisi float.

Response Gagal

HTTP status code adalah 4xx atau 5xx, response body berisi field-field berikut:

Field	Tipe	Opsi	Deskripsi
code	Integer	Wajib	Kode error, lihat penjelasan kode error
message	String	Wajib	Detail error

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

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

Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Error	http code	Penjelasan
1000	500	Error internal, silakan coba lagi nanti
2001	401	Autentikasi gagal, tidak menyertakan token yang benar, atau merchant terkait token tidak ada
2002	401	Autentikasi gagal, token sudah kedaluwarsa atau telah dinonaktifkan
2002	403	Merchant telah dihapus