Skip to main content
GET
/
api
/
v1
/
balance
Check Balance
curl --request GET \
  --url https://app.sosmednext.com/api/v1/balance
Langkah pertama dalam integrasi biasanya adalah mengecek fungsionalitas dan saldo akun Anda. Endpoint ini mengembalikan sisa saldo (balance) Anda secara rinci, dan mata uang (currency) sistem yang sedang digunakan yaitu IDR.
Tips Pengembangan: Sebaiknya integrasikan request endpoint balance sewaktu pengguna Anda masuk halaman Dashboard, namun hindari memanggil endpoint ini terlalu sering (misalnya setiap beberapa detik sekali/looping brutal) menggunakan cron job. Gunakan endpoint ini di panel admin Anda sebagai laporan saldo Provider.

​
Query Parameters

Anda hanya perlu mengirimkan API Key di Header atau sebagai query parameter. Tidak ada form parameters lain yang diperlukan.
​
api_key
string
required
Kunci API Anda (Jika Anda tidak menginginkan menggunakan custom Header X-Api-Key).

​
Contoh Request

Request (cURL)
curl -X GET -H "X-Api-Key: YOUR_API_KEY_HERE" "https://app.sosmednext.com/api/v1/balance"

​
Response Data Format

Response Berhasil (200 OK)
{
  "balance": 150000.50,
  "currency": "IDR"
}

​
Penjelasan Detil Field:

FieldTipe DataKeterangan
balanceNumberJumlah saldo / balance akun Anda saat ini.
currencyStringMata uang provider sistem kami, secara default akan selalu menampilkan format IDR.