متد CurrentBalance

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

API Endpoint
https://{SupplierWebsiteUrl}/api/Partners/Generic/CurrentBalance/V1 post
Request Parameters

نمونه کلاس Request به زبان سی شارپ در پروژه Partners.Contracts (دانلود) در پوشه زیر موجود است:

\Generic\CurrentBalance\V1\RequestModel

Username

string

required

نام کاربری

Password

string

required

رمز عبور به صورت MD5 شده

Sample Request 
{
  "Username": "your username",
  "Password": "your MD5 of password"
}
Response Data

نمونه کلاس Response به زبان سی شارپ در پروژه Partners.Contracts (دانلود) در پوشه زیر موجود است:

\Generic\CurrentBalance\V1\ResponseModel

RemainedCredit

number

مقدار اعتبار باقی مانده

CurrencyCode

string

این فیلد مشخص می کند که نرخ های برگشتی بر اساس چه ارزی می باشد.
مقدار آن بستگی به این دارد که ارز کاربر شما در سایت تامین کننده چه چیزی تعیین شده باشد. مثلا اگر کاربر شما به صورت ریالی باشد مقدار آن IRR و اگر دلاری باشد مقدار آن USD خواهد بود.

PaymentDueMinutes

nullable number

مهلت پرداخت باقی مانده به دقیقه

Sample Response - مهلت پرداخت نامحدود 
{
  "RemainedCredit": 99949957210,
  "CurrencyCode": "IRR",
  "PaymentDueMinutes": null
}
Sample Response - دارای مهلت پرداخت 
{
  "RemainedCredit": 100000000000,
  "CurrencyCode": "IRR",
  "PaymentDueMinutes": 10080
}