مستندات درگاه

مرحله اول : ارسال دیتا

در مرحله اول شما می بایست پارامترهای موجود در جدول زیر رو با متد POST به آدرسی که مشخص شده ارسال کنید. به نوع داده ها و نام فیلد توجه کنید.

در صورتی که برای فیلد شماره موبایل، شماره موبایل کاربر را به درگاه ارسال نمایید، بصورت اتوماتیک درگاه موبایلی نمایش داده می شود

نکته : تمامی داده های برگشتی از CheckPay.ir به صورت json می باشد

post

https://checkpay.ir/payment/send/

پارامتر

فیلد نوع توضیحات
api String API Key دریافتی از پنل کاربری شما که بعد از تایید درخواست درگاه صادر میشه
amount Integer مبلغ تراکنش به صورت ریالی و بزرگتر یا مساوی 1000
redirect String آدرس بازگشتی به صورت urlencode ، که باید با آدرس درگاه پرداخت تایید شده در CheckPay.ir بر روی یک دامنه باشد
mobile String شماره موبایل ( جهت نمایش کارت های خریدار به ایشان و نمایش درگاه موبایلی )
factorNumber String شماره فاکتور شما (اختیاری)
description String توضیحات (اختیاری ، حداکثر 255 کاراکتر)
HTTP/1.1 200 OK
{
  "status" : 1,
  "transId" : شماره تراکنش
}
HTTP/1.1 422 Error
{
  "status" : 0,
  "errorCode" : کد خطا,
  "errorMessage" : متن پیام خطا
}
HTTP/1.1 422 Error
{
  "-1" : ارسال api الزامی می باشد,
  "-2" : ارسال مبلغ الزامی می باشد,
  "-3" : مبلغ باید به صورت عددی باشد,
  "-4" : مبلغ نباید کمتر از 1000 باشد,
  "-5" : ارسال آدرس بازگشتی الزامی می باشد,
  "-6" : درگاه پرداختی با api ارسالی یافت نشد و یا غیر فعال می باشد,
  "-7" : فروشنده غیر فعال می باشد,
  "-8" : آدرس بازگشتی با آدرس درگاه پرداخت ثبت شده همخوانی ندارد,
  "-12" : طول فیلد description بیشتر از 255 کاراکتر می باشد,
  "failed" : تراکنش با خطا مواجه شد,
}

مرحله دوم : انتقال کاربر به صفحه پرداخت

در صورتی که در مرحله ارسال دیتا ، اطلاعات ارسالی صحیح باشه و دو مقدار status و transId رو دریافت کرده باشید باید کاربر رو به شیوه زیر به درگاه ریدایرکت کنید.

برای اینکار باید عددی که در مرحله اول در متغییر {transId} دریافت کردید رو در اخر ادرس قرار بدید و کاربر رو به URL ایجاد شده ریدایرکت کنید تا بلافاصله کاربر به درگاه پرداخت هدایت بشه و سپس مرحله سوم رو انجام بدید.

GET

https://checkpay.ir/payment/gateway/{transId}

مرحله سوم : بازگشت به سایت پذیرنده

مرحله سوم زمانی انجام میشه که کاربر از درگاه پرداخت بر میگرده. در این مرحله با توجه به نتیجه تراکنش و وضعیت اون، ما فیلد های موجود در جدول زیر رو به ادرس کالبک شما که در مرحله اول با پارامتر redirect ارسال کرده بودید POST میکنیم

اگر مقدار پارامتر status برابر 1 بود یعنی تراکنش موفقه و باید مرحله چهارم رو حتما انجام بدید.

شما بر حسب نیاز تون می تونید تمام یا هرکدوم از فیلدهای مورد نیازتون رو در بانک اطلاعاتی خودتون ذخیره کنید. ما هم یک نسخه از این اطلاعات رو ذخیره و در جزئیات تراکنش ها در پنل کاربری تون نمایش میدیم.

post

http://Your-CallBack-URL

پارامتر

فیلد نوع توضیحات
status Integer وضعیت تراکنش : مقدار 1 موفق و مقدار 0 ناموفق
transId Integer شماره تراکنش
factorNumber String شماره فاکتور ارسالی توسط شما در مرحله اول
mobile String شماره موبایل ارسالی توسط شما در مرحله اول
description String توضیحات ارسالی توسط شما در مرحله اول
cardNumber String شماره کارتی که تراکنش با آن انجام شده است (در صورت موفق بودن تراکنش)
traceNumber String کد رهگیری بانکی (در صورت موفق بودن تراکنش)
message String متن پیام

مرحله چهارم : وریفای تراکنش

در صورتی که مقدار فیلد status دریافت شده در مرحله قبل عدد 1 باشه برای وریفای تراکنش باید کارهای زیر رو انجام بدید. توجه : درصورت عدم وریفای تراکنش وجه پرداختی به حساب پرداخت کننده بعد از 30 دقیقه برگشت داده خواهد شد

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

post

https://checkpay.ir/payment/verify/

پارامتر

فیلد نوع توضیحات
api String کد api دریافتی از سایت CheckPay.ir
transId Integer transId دریافتی از مرحله callback
HTTP/1.1 200 OK
{
  "status" : 1,
  "amount" : مبلغ تراکنش
}
HTTP/1.1 422 Error
		{
		  "status" : 0,
		  "errorCode" : کد خطا,
		  "errorMessage" : متن پیام خطا
		}
© ۱۳۹۰–۱۳۹۸ | کلیه حقوق این وب سایت متعلق به درگاه واسط چک پی می‌باشد.
© 2011–2019 All rights reserved by CheckPay.ir