مستندات فنی «استعلام کارت»

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

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

Scope: card:information:get

Grant type: client_credentials

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

معرفی استعلام کارت

سرویس «استعلام کارت» در دسته استعلام و تبدیل داده بانکی (شبا، کارت، حساب). ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد 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}/depositInfo