###GET /oak/v2/clients/{clientId}/deposits/{deposit}/balance * **شرح: ** مانده یک حساب. لازم به توضیح است که برای بانک کشاورزی عمر توکن پانزده دقیقه می باشد و پس از آن منقضی می شود و نیاز است که توکن رفرش شود. * **اسکوپ: ** ```oak:balance:get``` * **رویکرد: ** ```Authorization_Code``` * **رویکرد بانک کشاورزی: ** ```Client_Credential``` ```````````````` {address}/oak/v2/clients/{clientId}/deposits/{deposit}/balance?trackId={trackId} ```````````````` <div class="sandboxaddress sandbox" id="sandbox" style="float:right" style="display: none" > https://sandboxapi.finnotech.ir<b><span class="finnotech-sandbox-address-text"> :address </span></b> </div> <div class="production-address production" style="float:right" style="display: block"> https://apibeta.finnotech.ir <b> :address </b> </div> #### Headers مقادیر زیر باید در هدر قرار بگیرد ```````````````` Authorization : Bearer {Token} ```````````````` * برای فراخوانی این سرویس لازم است پس از دریافت اجازه ی دسترسی از کاربر، با توکن Authorization Code سرویس را فراخوانی نمایید. #### URI Parameters * **clientId:** شناسه کلاینت * **deposit :** شماره حساب معتبر، همان حسابی است که کاربر به آن اجازه داده و در پاسخ دریافت توکن به کلاینت برگردانده شده است. اگر حساب شما در بانکهای همکار شامل کاراکتر اضافه مانند خط تیره میباشد با همان فرمت در پارامتر استفاده کنید * example: ```1051-802-5434656-1``` #### Query Parameters * **trackId:** &#x202b; کد پیگیری، رشته ای اختیاری با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. در صورت ارسال trackId، فراخوانی سرویس خود را با همین مقدار استعلام و پیگیری کنید.(در گزارش فراخوانی سرویس ها با همین رشته نتیجه را ببینید). در صورتیکه که این فیلد را ارسال نکنید یک رشته UUID برای این فراخوانی در نظر گرفته میشود و در پاسخ فراخوانی برگردانده میشود. * example: ```get-balance-9601031200-01``` ####Results Format ##### Successful result format (status code 200) ```````````````` { "result": { , "currentBalance": 55419128 , "availableBalance": 55419128 , "effectiveBalance": 55419128 , "number": "030280000000000" } , "status": "DONE" , "trackId": "get-balance-9707031200-01" } ```````````````` * **result:** آبجکتی از پاسخ سرویس شامل: * **currentBalance: **‌ مانده واقعی حساب * **availableBalance: **‌ مانده قابل برداشت * **effectiveBalance: **‌ مانده * **number: **‌ شماره حساب * **trackId: **‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود * **status** وضغیت پاسخ سرویس #### UnSuccessful result format ```````````````` { "error": { , "code": "UNAUTHORIZED" , "message": "خطای دریافتی از سرور احراز هویت: توکن ارسالي نامعتبر است" } , "status": "FAILED" , "trackId": "ecba750e-690f-4cbd-b7c0-664352996dcf" } ```````````````` * **error** آبجکتی از خطای سرویس (در صورت بروز خطا): * **code: **‌ کد خطا * **message: **‌ پیغام خطا * **trackId: **‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود * **status** وضغیت پاسخ سرویس در اینجا میتوانید لیست خطاهای سرویس ها را مشاهده کنید [لیست خطاها](/v2/generic-errors.html)