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

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

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

Scope: billing:cc-inquiry:get

Grant type: client_credentials

دسته‌بندی OpenAPI: استعلام قبض. شناسه عملیات: billingInquiryCcGet.

معرفی استعلام قبض

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

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

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

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

فیلدهای مهم پاسخ: مقدار، شناسه قبض، شناسه پرداخت، تاریخ معامله انجام شده.

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

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

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

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

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

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

عملیات مرتبط با استعلام قبض

• استعلام تاریخچه قبض — GET /billing/v2/clients/{clientId}/billHistoryInquiry
• استعلام تاریخچه قبض — GET /billing/v2/clients/{clientId}/billHistoryInquiry
• استعلام قبوض با جزئیات — GET /billing/v2/clients/{clientId}/detailBillingInquiry
• استعلام قبوض با جزئیات — GET /billing/v2/clients/{clientId}/detailBillingInquiry
• استعلام قبض ناهمگام (مرحله ۱) — ثبت درخواست — POST /billing/v2/clients/{clientId}/billingInquiryRequest