مستندات و نمونه کدهای اتصال به وب سرویس

راهنمای فراخوانی درگاه پرداخت اینترنی (IPG) پرداخت یاری CanPay

دریافت راهنما به صورت pdf
Chrome
<
  • مقدمه

    تمامی سرویسها با base_url https://canpay.ir/api/ipg/ فراخوانی خواهند شد

    سرویس بر مبنای Rest Api ایجاد شده است و تمامی پارامترها در قسمت body به صورت Json ارسال شود.

    ساختار برگشت خطا:

                                        
       {
       "status": false,
       "error": error
       "code": xxx,
       "message": "Error description",
       "description": ""
       }
    
                                        
                                        

    در صورت دریافت موفق :

                                        
      {
      "status": true,
        "data": {
          …
        }
      }
    
                                        
                                        

تعاریف

کد پذیرندگی (merchant) کدی است که توسط پرداخت یار به پذیرنده اعطا می شود و برای تشخیص پذیرنده مورد استفاده قرار میگیرد.
مبلغ ((amount) مبلغ قابل پرداخت به ریال
شماره تلفن همراه (mobile) شماره تلفن همراه پرداخت کننده در صورت ارسال توسط پذیرنده درگاه پرداخت شماره کارتهای ثبت شده کاربر در سامانه پیوند را نمایش می دهد.همچنین با ارسال این فیلد کاربر میتواند شماره کارت و تاریخ انقضای کارت خود را جهت سهولت در مراجعات بعدی در درگاه پرداخت ذخیره کند.
آدرس بازگشت (callback_url) ادرس بازگشت به سایت پذیرنده بعد از پرداخت
شماره فاکتور ( invoice_id) شماره سفارش که برای هر تراکنش باید به صورت یکتا ارسال شود.

** سرویس فقط از ip های معرفی شده توسط شما در ثبت پذیرندگی قابل اجرا خواهد بود.

** در زمان ارسال کاربر به درگاه کاربر از دامنه ای که در زمان ثبت پذیرندگی معرفی کرده اید باید ارسال شود.

مراحل کلی فرایند پرداخت اینترنتی

  1. ورود مشتری به سایت پذیرنده و آماده سازی سبد خرید
  2. فراخوانی متد token و دریافت لینک درگاه
  3. ارسال مشتری به درگاه پرداخت با توجه به لینک درگاه
  4. تکمیل اطلاعات کارت توسط مشتری و انجام پرداخت اینترنتی
  5. هدایت مشتری به سایت پذیرنده پس از انجام عملیات پرداخت
  6. تایید تراکنش پرداخت توسط پذیرنده با متد verify درصورت عدم تایید تراکنش توسط پذیرنده مبلغ پرداختی بعد از مدت زمان 15دقیقه به حساب مشتری برگشت خواهد خورد.

دریافت توکن

لینک ورودی : https://canpay.ir/api/ipg/token

متد ارسالی: post

نام توضیحات
merchant کد پذیرندگی (اجباری)
amount مبلغ قابل پرداخت int (اجباری)
callback_url ادرس برگشت به سایت (اجباری)
invoice_id شماره فاکتور یکتا به صورت string (اجباری)
mobile شماره موبایل کاربر به صورت 09123456789 (اختیاری)

نمونه ورودی:

                                    
{
    "merchant": "xxx-xxx-xxx-xxx",
    "amount": 10000,
    "callback_url":"https://site.com/verify",
    "invoice_id":"47"
}


                                    
                                    

نمونه موفق خروجی:

                                    
{
  "status":true,
  "data":{
  "url":"https://canpay.ir/ipg/SNHQA1TYFGSFARZUM5A03YXJWOAOHJ",
  "token":"SNHQA1TYFGSFARZUM5A03YXJWOAOHJ"
  }
}



                                    
                                    

** بعد از دریافت لینک توکن را نزد خود ذخیره کرده و کاربر را به لینک مربوطه ارسال بفرمایید.

تایید تراکنش

بعد از ارسال کاربر به سایت پذیرنده پارامترهای success , token,amount,invoice_id به صورت post به callback_url ارسالی شماارسال می شود. در صورتی که success برای 1 باشد تراکنش موفق بوده است در غیر این صورت تراکنش ناموفق بوده است. باید token دریافتی را به همراه merchant خود به تابع verify ارسال نمایید تا تراکنش تایید شود. دقت بفرمایید که در هربار ارسال اطلاعات درگاه پاسخ موفق و شماره رهگیری را ارسال می کند. مسئولیت ارسال چندین باره یک توکن بر عهده پذیرنده است.

لینک ورودی: https://canpay.ir/api/ipg/verify

متد ارسالی: post

پارامترهای ورودی

پارامتر توضیحات
merchant کد پذیرندگی
amount توکن دریافتی

نمونه ورودی:

                                    
{
    "merchant": "xxx-xxx-xxx-xxx",
	"token":"5S6GQO1PDNWHQSWPZRZRHZXUCAPECS"
}



                                    
                                    

نمونه خروجی:

                                    
{
"status":true,
"data":{
"card":"5022-29**-****-7122",
"reference":"141167552421"
}
}