پرش به مطلب اصلی

موجودی و وضعیت حساب

دو endpoint زیر موجودی حساب و وضعیت مسدودی آن را برمی‌گردانند. هر دو با کلید API یا Bearer قابل استفاده‌اند.

دریافت موجودی​

GET /sms/api/Balance

این endpoint پارامتر ندارد.

curl -X GET "https://api.payavasms.com/sms/api/Balance" \
-H "X-Api-Key: YOUR_API_KEY"
{
"status": 0,
"message": "عملیات با موفقیت انجام شد.",
"data": 1250000
}
فیلد پاسخنوعتوضیح
statusعدد0 یعنی موفق
messageرشتهتوضیح نتیجه
dataعددموجودی حساب به ریال

وضعیت مسدودی حساب​

GET /sms/api/BlockAccount/State

curl -X GET "https://api.payavasms.com/sms/api/BlockAccount/State" \
-H "X-Api-Key: YOUR_API_KEY"
false

پاسخ یک مقدار بولی است: true یعنی حساب مسدود است و ارسال انجام نمی‌شود (خطای 4001)، و false یعنی مسدود نیست.