استعلام وضعیت پرداخت (Inquiry)
این متد فقط وضعیت تراکنش مورد نظر شما را اعلام میکند و هیچ تغییری روی تراکنش اعمال نمیکند.
از این متد به هیچ عنوان برای تایید و وریفای کردن تراکنش استفاده نکنید.
این متد تنها وضعیت یک تراکنش را برای شما برمیگرداند. برای تایید نهایی حتماً از متد
verify استفاده کنید.
آدرس وبسرویس
در مرحله اول پذیرندگان باید پارامترهای زیر را، با توجه به نوع دادهها و نام فیلد، با متد POST به آدرس مشخصشده ارسال نمایند.
POST
https://payment.finopal.ir/api/v1/payment/inquiryاطلاعات ورودی
| نام | نوع | الزام | توضیحات |
|---|---|---|---|
| merchant_id | String | بله | کد اختصاصی پذیرنده (درگاه) |
| authority | String | بله | شناسه یکتای تراکنش مورد استعلام |
نمونه درخواست (curl)
Bash
curl -X POST \
https://payment.finopal.ir/api/v1/payment/inquiry \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"merchant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"authority": "FP_636E4A5CBBCE0F222B46829BD74AB4A9"
}'پاسخ برگشتی
| نام | نوع | توضیحات |
|---|---|---|
| status | String | وضعیت تراکنش که ممکن است یکی از این حالات باشد
pending : در انتظار پرداخت successful : موفق failed : ناموفق cancelled : لغو شده refunded : برگشت خورده, callback : بازگشت از درگاه (کالبک) |
| message | String | پیام موفقیتآمیز بودن درخواست |
| errors | Array / Object | در صورت وجود خطا، کد خطا و پیام آن را برمیگرداند |
مقادیر ممکن status
| مقدار | توضیح |
|---|---|
| pending | در انتظار پرداخت |
| successful | موفق |
| failed | ناموفق |
| cancelled | لغو شده |
| refunded | برگشت خورده |
| callback | بازگشت از درگاه (کالبک) |
نمونه پاسخ موفق
JSON
{
"success": true,
"status": "successful",
"message": "استعلام وضعیت تراکنش با موفقیت انجام شد",
"errors": []
}نمونه خطا
JSON
{
"success": false,
"message": "تراکنش یافت نشد",
"errors": {
"code": -11,
"message": "تراکنش یافت نشد"
}
}