درگاه پرداخت زیبال
مقدمه
به راهنمای سرویس درگاه پرداختی اینترنتی (IPG) زیبال خوش آمدید. این مستندات جهت آسانی استفاده شما از سرویس‌های زیبال جمع آوری شده‌اند. در صورت بروز هر گونه سوال با تیم فنی زیبال تماس بگیرید. وظیفه همکاران ما پاسخ به پیام‌های شما در اسرع وقت می‌باشد.
لطفا قبل از پیاده‌سازی به نکات زیر توجه نمایید:
- API های زیبال RESTful می‌باشند و درخواست‌ها و پاسخ‌ها به صورت JSON رد و بدل می‌شوند.
- زیبال تنها به درخواست‌هایی که تحت دامنه https ارسال می‌شوند پاسخ خواهد داد.
- در صورت دریافت هر گونه خطا از جانب زیبال، پس از بررسی مقادیر ارسالی خود، این خطا را به همراه مقادیر ارسالی و مقادیر پاسخ دریافتی را برای ما ارسال کنید. از امکان بروز خطا توسط زیبال باخبریم و به سرعت در راستای حل مشکل قدم برخواهیم داشت!
- یک حساب کاربری جهت تست تمام قابلیت‌ها و سرویس‌ها تهیه شده‌است. با قراردادنmerchant : zibalمی‌توانید از این حساب استفاده کنید.
مراحل راه‌اندازی
استفاده و راه‌اندازی سرویس درگاه پرداخت اینترنتی زیبال پیچیده نیست. تنها کافیست سه مرحله زیر را به‌درستی پیاده کنید!
1. درخواست پرداخت - Request
برای راه‌اندازی درگاه شما، زیبال نیاز به اطلاعات سفارش شما دارد که ارسال آن‌ها از طریق این پایانه ممکن می‌باشد.
در جواب این پایانهtrackIdرا به‌عنوان شناسه پیگیری پرداخت دریافت خواهید کرد.
2. شروع پرداخت - Start
با ارسالtrackIdبه این پایانه صفحه‌ی پرداخت برای شما نمایان می‌شود و شما آماده‌ی پرداخت هستید.
3. تایید پرداخت - Verify
زیبال وضعیت پرداخت هر سفارش را به آدرسcallbackUrlای که برای آن سفارش ثبت کرده‌اید ارسال می‌کند.
پس از آن نیاز است که شما متد تایید تراکنش را فراخوانی کنید.
تایید موفقیت‌آمیز بودن پرداخت از طریق این پایانه میسر است.
4. استعلام پرداخت - Inquiry
در صورتی که در هر کدام از مراحل پرداخت نیاز به دریافت اطلاعات و وضعیت تراکنش وجود داشته باشد، با فراخوانی این سامانه وضعیت کامل تراکنش موردنظر را دریافت خواهید کرد.
با طی شدن مسیر ذکر شده روند پرداخت یک سفارش پایان می‌یابد. مبلغ واریزی از طریق درگاه پرداخت اینترنتی بسته به تنظیمات حساب کاربری شما به حساب(های) تعیین‌شده یا کیف‌پول زیبال شما واریز می‌گردد.
اعتبارسنجی
زیبال از پارامترmerchantجهت اعتبارسنجی درگاه‌های موجود استفاده می‌کند.
این اطلاعات پس از ایجاد هر درگاه جدید در پنل کاربری زیبال موجود می‌باشند.
این امکان وجود دارد که درگاه خود را به IP (های) مشخصی محدود کنید.
در صورتی که نیاز به ابطال این اطلاعات دارید و یا این اطلاعات را از دست داده‌اید، با ما تماس بگیرید.
تمامی درخواست‌های ارسالی به زیبال بایستی حاوی اطلاعات احراز هویت باشند :
{
"merchant": "zibal",
// OTHER FIELDS
}درخواست پرداخت - Request
از این پایانه جهت ارسال اطلاعات سفارش و ثبت آن در سیستم زیبال استفاده کنید.
اطلاعات درخواست
https://gateway.zibal.ir/v1/request POSTبدنه درخواست
آیتم تسهیم (MultiplexingInfo)
تنها ارسال یکی از پارامترهایbankAccount,subMerchantId,walletIDدر هر آیتم تسهیم اجباری است.
بدنه پاسخ
جدول result
شروع به پرداخت - Start
از این پایانه جهت نمایان شدن صفحه‌ی پرداخت و شروع به پرداخت استفاده کنید.
اطلاعات درخواست
https://gateway.zibal.ir/start/{{trackId}} GETبدنه درخواست
با ارسالtrackIdبه آدرس بالا و باز کردن این صفحه در مرورگر، بسته به تنظیمات حساب کاربری خود به صفحه‌ی پرداخت در درگاه و یا صفحه میانی زیبال منتقل خواهید شد.
درگاه پرداخت مستقیم - زیبال‌دایرکت
جهت فعال‌سازی این قابلیت، از طریق بخش پشتیبانی موجود در پنل کاربری، تیکت بزنید و یا با ما تماس بگیرید.
Callback
زیبال اطلاعات پرداخت یک سفارش را در زمان تغییر وضعیت بهcallbackUrlثبت‌شده برای آن سفارش ارسال می‌کند.
این اطلاعات به صورت Query String و از طریق متدGETبرایcallbackUrlارسال می‌شوند.
برای پایان دادن به جلسه پرداخت یک سفارش در صورت موفقیت‌آمیز بودن پرداخت، حتما از طریق پایانه‌ی تایید پرداخت اقدام به تایید اطلاعات دریافتی نمایید.بدنه Callback
مثال
https://yourcallbackurl.com/callback?trackId=9900&success=1&status=2&orderId=1تایید پرداخت - Verify
از این پایانه جهت تایید موفقیت‌آمیز بودن پرداخت و پایان دادن به یک جلسه‌ی پرداخت استفاده نمایید.
اطلاعات درخواست
https://gateway.zibal.ir/v1/verify POSTبدنه درخواست
بدنه پاسخ
جدول result
استعلام پرداخت - Inquiry
از این پایانه جهت استعلام پرداخت و دریافت گزارش یک جلسه‌ی پرداخت استفاده نمایید.
اطلاعات درخواست
https://gateway.zibal.ir/v1/inquiry POSTبدنه درخواست
بدنه پاسخ
جدول result
متد وریفای سمت پذیرنده - متد Lazy
شروع پرداخت - متد Lazy
از این پایانه جهت ارسال اطلاعات سفارش و ثبت آن در سیستم زیبال استفاده کنید.
اطلاعات درخواست
https://gateway.zibal.ir/request/lazy POSTبدنه درخواست
آیتم تسهیم (MultiplexingInfo)
تنها ارسال یکی از پارامترهایbankAccount,subMerchantId,walletIDدر هر آیتم تسهیم اجباری است.
بدنه پاسخ
جدول result
شروع به پرداخت - متد lazy
ارجاع شود به شروع به پرداخت (روش عادی)
Callback - Lazy
زیبال اطلاعات پرداخت یک سفارش را در زمان تغییر وضعیت بهcallbackUrlثبت‌شده برای آن سفارش ارسال می‌کند.
در روش lazy این اطلاعات به صورت JSON و از طریق متدPOSTبرایcallbackUrlارسال می‌شوند.
برای پایان دادن به جلسه پرداخت یک سفارش در صورت موفقیت‌آمیز بودن پرداخت، حتما از طریق پایانه‌ی تایید پرداخت اقدام به تایید اطلاعات دریافتی نمایید.بدنه Callback
تایید تراکنش - متد Lazy
از این پایانه جهت تایید موفقیت‌آمیز بودن پرداخت و پایان دادن به یک جلسه‌ی پرداخت استفاده نمایید.
اطلاعات درخواست
https://gateway.zibal.ir/verify POSTبدنه درخواست
بدنه پاسخ
جدول result
جدول وضعیت‌ها
نشان اعتماد زیبال
با توجه به لزوم جلب اعتماد مشتریان جهت انجام پرداختی امن و سریع، می‌توانید با قراردادن کد زیر را در قسمتی از وبسایت خود که برای کاربران قابل مشاهده باشد (مانند فوتر وبسایت) قرار دهید تا مشتریان شما از پردازش پرداخت‌ها توسط زیبال مطلع شوند.
<script src="https://zibal.ir/trust/scripts/1.js" type="text/j-avascript"></script>پس از قراردادن این تکه کد، نشان اعتماد زیبال به شکل زیر در وبسایت شما نمایش داده خواهد شد.
اعلان تراکنش‌ها
شما می‌توانید جهت اطلاع از تراکنش‌های موفقیت‌آمیز از ربات تلگرامی زیبال استفاده کنید.
تنها کافی‌است وارد ZibalBot شوید و ربات را به حساب کاربری خود متصل نمایید تا تمامی تراکنش‌های تمامی درگاه‌های پرداخت شما، در لحظه به اطلاع شما برسند.
راهنمای مهاجرت
جهت مهاجرت به سرویس جدید، مراحل زیر را دنبال نمایید:
- آدرس پایانه request را بهhttps://gateway.zibal.ir/v1/requestتغییر دهید.
- آدرس پایانه verify را بهhttps://gateway.zibal.ir/v1/verifyتغییر دهید.
- اطلاعات ارسالی به آدرسcallbackUrlرا با استفاده از متدGETبخوانید.
- شما به سرویس جدید منتقل شدید! :)
منبع : https://zibal.ir