مستندات

جست‌وجو در مستندات

نام اندپوینت، موضوع یا کلیدواژه را بنویسید

موجودی اعتبار

موجودی قابل خرج کیف پول دفترتان را بخوانید.

POST/Common/CreditBalance

دسترسی نیازمند مجوز credit_balance

موجودی برگشتی، از قبل بدون مبالغ بلوکه‌شده برای رزروهای باز محاسبه شده است؛ یعنی همان مبلغی است که همین حالا واقعاً می‌توانید خرج کنید.

پارامترهای مسیر#

ندارد.

پارامترهای کوئری#

ندارد.

پارامترهای بدنه#

نامنوعالزامیتوضیح
SessionIdstringالزامیشناسهٔ نشست شما.

درخواست#

curl -X POST https://api.simorghapi.com/api/Common/CreditBalance \
  -H "Content-Type: application/json" \
  -d '{ "SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f" }'
const res = await fetch("https://api.simorghapi.com/api/Common/CreditBalance", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ SessionId: "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f" })
});

const balance = await res.json();
import requests

res = requests.post(
    "https://api.simorghapi.com/api/Common/CreditBalance",
    json={"SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f"},
)

print(res.json())

پاسخ#

فیلدنوعتوضیح
Successbooleanدر صورت موفقیت true.
Balancenumberموجودی قابل خرج، پس از کسر مبالغ بلوکه‌شده.
Currencystringواحد پول کیف پول.
Errorobjectدر صورت موفقیت null.
{
  "Success": true,
  "Balance": 4820.50,
  "Currency": "USD",
  "Error": null
}
ویرایش این صفحه در گیت‌هابمشکلی دیدید؟ از پنل ← پشتیبانی خبرمان کنید.