مستندات پلتفرم پرداخت در محل زیبال
مقدمه
به راهنمای سرویس پرداخت در محل زیبال خوش آمدید. این مستندات جهت آسانی استفاده شما از سرویسهای زیبال جمع آوری شدهاند. در صورت بروز هر گونه سوال با تیم فنی زیبال تماس بگیرید. وظیفه همکاران ما پاسخ به پیامهای شما در اسرع وقت میباشد.
لطفا قبل از پیادهسازی به نکات زیر توجه نمایید:
- API های زیبال RESTful میباشند و درخواستها و پاسخها به صورت JSON رد و بدل میشوند.
- زیبال تنها به درخواستهایی که تحت دامنه https ارسال میشوند پاسخ خواهد داد.
- تمامی آدرسها در این سند تحت دامنهhttps://sandbox-api.zibal.irهستند. محیط سندباکس جهت تست صحت کار سرویسها، شبیهسازی عملکرد دستگاه کارتخوان و پیادهسازی اولیه در اختیار شما قرار گرفتهاست.
- در صورتی که آماده استفاده از زیبال هستید و دستگاه کارتخوان خود را دریافت نمودهاید این آدرس را بهhttps://api.zibal.irتغییر دهید.
- در صورت دریافت هر گونه خطا از جانب زیبال، پس از بررسی مقادیر ارسالی خود، این خطا را به همراه مقادیر ارسالی و مقادیر پاسخ دریافتی را برای ما ارسال کنید. از امکان بروز خطا توسط زیبال باخبریم و به سرعت در راستای حل مشکل قدم برخواهیم داشت!
احراز هویت
زیبال از پارامترهایmerchantIdوsecretKeyجهت احراز هویت مشتریان خود استفاده میکند. این اطلاعات پس از بررسی اطلاعات شما در هنگام ثبتنام از طریق پست الکترونیکی این آدرس ایمیل توسط spambots حفاظت می شود. برای دیدن شما نیاز به جاوا اسکریپت دارید برای شما ارسال شده اند.
در صورتی که نیاز به ابطال این اطلاعات دارید و یا این اطلاعات را از دست دادهاید، با ما تماس بگیرید.
تمامی درخواستهای ارسالی به زیبال بایستی حاوی اطلاعات احراز هویت باشند :
{
"merchantId": "Your Merchant ID",
"secretKey": "Your Secret Key",
// OTHER FIELDS
}
سفارش (Order)
ثبت سفارش (Add Order)
از این پایانه جهت ارسال اطلاعات سفارش و ثبت آن در سیستم زیبال استفاده کنید.
اطلاعات درخواست
https://sandbox-api.zibal.ir/merchant/addOrderPOSTبدنه درخواست
بدنه پاسخ
جدول result
استعلام سفارش (Read Order)
از این پایانه جهت استعلام اطلاعات سفارش و وضعیت آن در سیستم زیبال استفاده کنید.
اطلاعات درخواست
https://sandbox-api.zibal.ir/merchant/readOrderPOST
بدنه درخواست
بدنه پاسخ
جدول Status Code
جدول result
لغو سفارش (Cancel Order)
از این پایانه جهت لغو یک سفارش در سیستم زیبال استفاده کنید.
اطلاعات درخواست
https://sandbox-api.zibal.ir/merchant/cancelOrderPOST
بدنه درخواست
ویرایش سفارش (Edit Order)
از این پایانه جهت ویرایش اطلاعات سفارش در سیستم زیبال استفاده کنید.
اطلاعات درخواست
https://sandbox-api.zibal.ir/merchant/editOrderPOST
بدنه درخواست
بدنه پاسخ
جدولresult
ذینفعها
با توجه به ارائه خدمت تسهیم توسط زیبال و امکان تقسیم مبالغ پرداختی روی دستگاه کارتخوان بین چندین حساب (با اعلام شماره شبای ذینفعها به زیبال) و جهت رعایت امنیت در این درخواستها، این مبالغ تنها بین ذینفعهای ثبتشده و تاییدشده توسط زیبال تقسیم خواهد شد.
در صورت توجه در پایانهی ثبت سفارش شماره شبای ذینفع برای زیبال ارسال نشده بلکه یکidبه همراه مبلغ سهم در قالب یک شیء JSON در آرایهmultiplexingInfosارسال شدهاست.
با استفاده از پایانهی تعریف ذینفع و یا داخل پنل کاربری زیبال شما میتوانید با ارسال شماره شبای آنها اینidرا از زیبال دریافت کرده و پس از تایید آنها از سرویس تسهیم برای آن حسابها استفاده نمایید.
تعریف ذینفع
از این پایانه جهت تعریف ذینفع و ثبت آن در سیستم زیبال جهت استفاده در سفارشهای دارای تسهیم استفاده کنید.
اطلاعات درخواست
https://sandbox-api.zibal.ir/merchant/addSubMerchantPOSTبدنه درخواست
بدنه پاسخ
جدول result
بدنه Callback
در صورتی که در بدنهی پایانهی تعریف ذینفع callbackUrlصحیح وارد کرده باشید، زیبال تغییر وضعیت ذینفع را از طریق ارسال اطلاعات به آن آدرس به اطلاع شما میرساند.
Callback
زیبال پس از موفقیتآمیز بودن پرداخت سفارش بر روی کارتخوان، اطلاعات پرداخت آن تراکنش را بهcallbackUrlثبتشده در پایانه ثبت سفارش ارسال مینماید.
اطلاعات ارسالی توسط زیبال در جدول زیر قابل مشاهده میباشد.
- در دسترس بودن سرویس اجرا شده شما بر رویcallbackUrlارسالی شما برای زیبال مهم میباشد. از این رو در جواب این اطلاعات سرویس شما میبایست JSON زیر را در جواب به زیبال بازگرداند.
- در صورت بروز مشکلات و عدم امکان انجام این کار، زیبال این اطلاعات را در سیکلهای مشخص مجددا برای شما ارسال میکند تا از دریافت این اطلاعات اطمینان حاصل نماید.
بارکد
شناسه زیبال مورد استفاده در سیستم زیبال راه ارتباط دستگاههای کارتخوان با اطلاعات پرداخت میباشند و با ورود آنها یا اسکن بارکد میتوانیم اقدام به پرداخت سریع و آسان کنیم.
اطلاعات درخواست
https://api.zibal.ir/merchant/generateBarcode?zibalId={{zibalId}}GETاین پایانه بارکد مربوط بهzibalIdارسالی شما را در قالب عکس jpg بازمیگرداند.
از آنجایی که روش کار این پایانهGETمیباشد، با قراردادن این URL در src تگ img نیز میتوانید به آسانی به آن دسترسی داشته باشید.
مثال
<img src='https://api.zibal.ir/merchant/generateBarcode?zibalId=727'>
منبع : https://zibal.ir