مستندات فنی «استعلام حساب»

اندپوینت و دسترسی استعلام حساب

این صفحه مستندات فنی فراخوانی GET /facility/v2/clients/{clientId}/depositInfo است.

Scope: facility:deposit-information:get

Grant type: client_credentials

دسته‌بندی OpenAPI: استعلام و تبدیل بانکی. شناسه عملیات: facilityDepositInfoGet.

معرفی استعلام حساب

سرویس «استعلام حساب» در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

ورودی و خروجی استعلام حساب

ورودی‌های اصلی: شناسه کلاینت، شماره حساب.

پارامترهای اختیاری متداول: کد پیگیری.

فیلدهای مهم پاسخ: نام بانک، نام کامل.

جزئیات نوع داده، الزامی بودن و نمونه JSON در مشخصات Elements همین صفحه آمده است.

کاربرد فنی استعلام حساب

سرویس «استعلام حساب» در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

پس از دریافت توکن مناسب (مطابق Grant type)، درخواست را به مسیر بالا بفرستید و پاسخ را بر اساس اسکیمای اعلام‌شده پردازش کنید. راهنمای گرفتن توکن در راهنمای شروع آمده است.

در صورت خطای احراز هویت یا Scope ناکافی، ابتدا اعتبار توکن و سطح دسترسی کلاینت را بررسی کنید؛ سپس پارامترهای الزامی مسیر و بدنه را با اسکیمای همین صفحه تطبیق دهید.

برای توضیح کسب‌وکاری، موارد استفاده و پیش‌نیازها به صفحه سرویس «استعلام حساب» مراجعه کنید.

عملیات مرتبط با استعلام حساب

• تبدیل شماره کارت به شماره حساب — GET /facility/v2/clients/{clientId}/cardToDeposit
• تبدیل شماره کارت به شماره حساب — GET /facility/v2/clients/{clientId}/cardToDeposit
• تبدیل کارت به شبا — GET /facility/v2/clients/{clientId}/cardToIban
• تبدیل کارت به شبا — GET /facility/v2/clients/{clientId}/cardToIban
• تبدیل حساب به شبا — GET /facility/v2/clients/{clientId}/depositToIban