مستندات فیکپال
راهنمای استفاده از API فیکپال برای شبیهسازی و تست فرآیند های پرداخت
راهنمای اتصال به درگاه پرداخت و استفاده
فیکپال یک درگاه پرداخت پیشفرض و
همیشه فعال در اختیار همه توسعهدهندگان قرار میدهد؛ بنابراین نیازی به ثبتنام،
ورود یا ساخت درگاه ندارید. کافی است مقدار merchant_id زیر را در درخواستهای
خود قرار دهید.
مقدار merchant_id را برابر با
قرار دهید. در
حال حاضر تنها همین شناسه معتبر است و ارسال هر مقدار دیگری با خطای
404 Gateway not found پاسخ داده میشود.
پیش از یکپارچهسازی APIها در پروژه خود، به منظور انجام آزمایشهای اولیه، میتوانید از ابزارهای تخصصی مانند Postman، HTTPie و سایر نرمافزارهای مشابه بهره ببرید. این رویکرد به شما کمک میکند تا عملکرد APIها را به طور مستقل ارزیابی کرده و مشکلات احتمالی را زودتر شناسایی نمایید.
JSON می باشد. ارسال اطلاعات
در مرحله اول پذیرندگان باید پارامترهای موجود در جدول زیر را،
با توجه به نوع دادهها و نام فیلد، با متد POST به آدرس مشخص شده ارسال
نمایند.
POST
undefined/payment/requestنام | نوع | الزام | توضیحات |
|---|---|---|---|
merchant_id | String | بله | كد ۳۶ كاراكتری اختصاصی پذیرنده |
amount | Integer | بله | مبلغ تراكنش |
description | String | بله | توضیحات مربوط به تراکنش |
callback_url | String | بله | صفحه بازگشت مشتری، پس از انجام عمل پرداخت |
currency | String | خیر | واحد پولی ریال (IRR) یا تومان (IRT) |
درخواست:
{
"merchant_id": "undefined",
"amount": 1020000,
"description": "Transaction Description",
"callback_url": "http://localhost:5173/verify"
}
پاسخ:
در صورت موفقیت، پاسخ با کد وضعیت 201 Created و ساختار زیر بازگردانده میشود. مقدار fee معادل ۱۰ درصد مبلغ تراکنش است و authority را برای مرحله بعد نگه دارید.
{
"data": {
"code": 100,
"message": "Success",
"authority": "A0000000000000000000000000000xkt1ns2",
"fee_type": "Merchant",
"fee": 102000
},
"errors": []
}
خطاها:
کد وضعیت | توضیحات |
|---|---|
400 | خطای اعتبارسنجی؛ پاسخ شامل |
404 | درگاهی با |