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

تنظیم مبلغ یادآور (Post)

برای تعیین سقف کیف پول به منظور ارسال هشدار استفاده می‌شود.

اطلاعات عمومی​

  • آدرس: /api/v3/profile/balance-threshold
  • متد: POST
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

بدنه درخواست​

درخواست باید شامل داده‌های زیر در بدنه (body) باشد:

فیلدنوع دادهضروریتوضیحات
balance_thresholdintegerبلهحداقل موجودی موردنظر بر حسب ریال

نمونه درخواست​

curl --location 'https://corporate.snapp.site/api/v3/profile/balance-threshold' \
  -X 'POST' \
  -H 'Authorization:  <your_authorization_token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"balance_threshold": 40000000}'

پاسخ موفق​

{
    "message": "Balance threshold data has been updated successfully",
    "data": "",
    "status": 200
}
فیلدنوع دادهتوضیحات
messagestringپیام موفقیت‌آمیز بودن درخواست
dataobjectمقدار "" در این پاسخ
statusintegerکد وضعیت پاسخ (200 برای موفقیت)

کدهای وضعیت و خطاها​

کد وضعیتتوضیحات
200درخواست موفق بود
400درخواست نامعتبر
401نیاز به احراز هویت
403دسترسی غیرمجاز
500خطای داخلی سرور