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

وضعیت کیف پول سازمانی کارمند (Get)

مقدار باقی مانده کیف پول هر کارمند را نشان میدهد در صورتی که محدودیتی هم برای کارمند تعریف شده باشد آن را نشان میدهد.


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

  • آدرس: /api/v3/wallet/status
  • متد: POST
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

پارامترهای درخواست

فیلدنوع دادهضروریتوضیحات
PassengerIDintegerبلهشناسه مسافر
RidePriceintegerبلهمبلغ کرایه سفر به ریال

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

curl --location 'https://corporate.snapp.site/api/v3/wallet/status' \
-H 'Authorization: <your_authorization_token>' \
-H 'Content-Type: application/json' \
--data '{
"PassengerID": 1234,
"RidePrice": 1234
}'

پاسخ موفق

{
"data": {
"balance_status": 1,
"has_budget_restriction": true,
"remaining_balance": 0
},
"message": "string",
"status": 0
}
فیلدنوع دادهتوضیحات
dataobjectشامل وضعیت کیف پول
balance_statusintegerوضعیت موجودی کیف پول (۰: ناکافی، ۱: کافی)
has_budget_restrictionbooleanآیا محدودیت بودجه وجود دارد یا خیر
remaining_balanceintegerمانده حساب مسافر به ریال
messagestringپیام موفقیت یا خطا
statusintegerکد وضعیت پاسخ

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

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