POST
/inquiry.json۶. جستجوی تراکنش‌ها (Inquiry)
جستجو و صفحه‌بندی فهرست تراکنش‌های درگاه
فهرست تراکنش‌های متعلق به درگاه را بر اساس فیلترهای ارسالی بازمی‌گرداند. حداقل یک فیلتر از میان dateFrom، dateTo، payerCardNumber، payerEmail یا invoiceNumber الزامی است.
پارامترهای ورودی
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
apiKey | string | required | کلید وب‌سرویس |
dateFrom | string | optional | تاریخ شروع — قالب YYYY-MM-DD |
dateTo | string | optional | تاریخ پایان — قالب YYYY-MM-DD |
invoiceNumber | string | optional | شماره فاکتور |
payerCardNumber | string | optional | شماره کارت پرداخت‌کننده |
payerEmail | string | optional | ایمیل پرداخت‌کننده |
state | string | optional | کد وضعیت تراکنش — به‌تنهایی فیلتر جستجوی الزامی محسوب نمی‌شود |
page | integer | optional | شماره صفحه — پیش‌فرض: ۱ — حداقل: ۱ |
limit | integer | optional | اندازه صفحه — پیش‌فرض: ۲۰ — حداقل: ۱ — حداکثر: ۱۰۰ |
فیلدهای پاسخ
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
status | boolean | required | نتیجه درخواست |
message | string | optional | پیام خطا در صورت عدم موفقیت |
items | object[] | required | فهرست تراکنش‌ها با فیلدهای snake_case (از جمله payment_number، amount، invoice_number، state، created، gate) |
page | integer | required | صفحه جاری |
limit | integer | required | اندازه صفحه |
totalPages | integer | required | تعداد کل صفحات |
خطاهای احتمالی
| کد | پیام | راه‌حل |
|---|---|---|
| 400 | invalid_params | پارامترهای جستجو نامعتبر است |
| 400 | invalid_api_key | کلید وب سرویس معتبر نیست |
| 400 | missing_filter | حداقل یک فیلتر جستجو الزامی است |
| 400 | date_range_exceeded | حداکثر بازه زمانی 31 روز است |
صفحات مرتبط
آیا این صفحه مفید بود؟