مستندات فیک‌پال

راهنمای استفاده از API فیک‌پال برای شبیه‌سازی و تست فرآیند های پرداخت

شبیه‌ساز درگاه پرداخت فیک‌پال

این مستند چگونگی شبیه‌سازی فرآیند پرداخت الکترونیک در محیط توسعه و تست پروژه‌های نرم‌افزاری را با استفاده از فیک‌پال شرح می‌دهد. این سرویس به‌صورت رایگان ارائه شده و از روش استاندارد web service بر روی پروتکل امن HTTPS استفاده می‌کند تا توسعه‌دهندگان بتوانند رفتار درگاه پرداخت را بدون محدودیت و به‌صورت کاملاً ایمن شبیه‌سازی نمایند. هدف از ارائه این سند، معرفی سرویس‌های به‌هم‌پیوسته‌ای است که مجموعه قابلیت‌های شبیه‌ساز درگاه پرداخت فیک‌پال را برای توسعه‌دهندگان و تست‌کنندگان تشکیل می‌دهند. محدوده این سند، شرح کلی عملیات لازم برای شبیه‌سازی پرداخت درخواستی در محیط تستی است و تمامی متدهای مرتبط با این عملیات به‌طور کامل توضیح داده شده‌اند. این سند شامل شرح کلی موارد موردنیاز برای درخواست عملیات شبیه‌سازی پرداخت در فیک‌پال است؛ همچنین تمامی متدهای مربوط به این عملیات نیز به تفصیل تشریح شده‌اند.

ما در فیک‌پال تا حد امکان ساختار و عملکرد را مشابه درگاه پرداخت زرین‌پال طراحی کرده‌ایم تا توسعه‌دهندگان هنگام مهاجرت به درگاه واقعی، با حداقل تغییرات و کمترین صرف زمان مواجه شوند. برای جزئیات بیشتر می‌توانید صفحه راهنمای مهاجرت به زرین‌پال را مطالعه کنید.

واژگان کلیدی

  • پذیرنده: توسعه‌دهنده، سازمان یا شرکتی که در حال ساخت یا تست فروشگاه اینترنتی یا سامانه پرداخت است.
  • خریدار: کاربر شبیه‌سازی‌شده یا تستری که در محیط توسعه، عملیات پرداخت را آزمایش می‌کند.
  • تراکنش: یک عملیات مالی شبیه‌سازی‌شده که در این مستند، مصداق آن یک خرید تستی در محیط توسعه می‌باشد.

اطلاعات فنی

  • merchant_id: شناسه منحصربه‌فرد ۳۶ کاراکتری درگاه پرداخت. فیک‌پال یک درگاه پیش‌فرض و همیشه فعال دارد و همه پذیرندگان از همین شناسه استفاده می‌کنند.
  • authority: شناسه منحصربه‌فرد ۳۶ کاراکتری که پس از ارسال درخواست پرداخت، بازگشت داده می‌شود و همواره با حرف A آغاز می‌گردد.
  • ref_id: شماره تراکنش منحصربه‌فرد که پس از تکمیل موفقیت‌آمیز تراکنش شبیه‌سازی‌شده صادر می‌شود.
  • callback_url: آدرس بازگشتی که پس از پایان عملیات در فیک‌پال فراخوانی می‌شود.
  • description: متن خلاصه‌ای که توسط پذیرنده برای معرفی کالا یا خدمات مورد فروش نوشته می‌شود.
  • currency: واحد پولی تراکنش؛ IRR (ریال) یا IRT (تومان). مقدار پیش‌فرض IRR است.

چرخه پرداخت

  • ۱. ایجاد درخواست: ارسال درخواست با متد POST به /payment/request و دریافت authority.
  • ۲. انتقال خریدار: هدایت خریدار به صفحه پرداخت فیک‌پال روی مسیر /payment/{Authority}.
  • ۳. بازگشت: بازگشت خریدار به callback_url همراه با پارامترهای Authority و Status.
  • ۴. اعتبارسنجی: تأیید نهایی تراکنش با متد POST به /payment/verify.

در فیک‌پال، پارامترهای اختیاری و غیرضروری مانند mobile، email و موارد مشابه، به منظور ساده‌سازی و تمرکز بیشتر حذف شده‌اند. همچنین برای استفاده از این سرویس نیازی به ثبت‌نام، ورود یا ساخت درگاه پرداخت نیست.