وب سرویس‌های پی‌پینگ بر پایه استاندارد محبوب REST پیاده‌سازی شده است. برای راحتی برنامه‌نویسان با استفاده از استاندارد OpenAPI3.0 تمام متدها پیاده‌سازی شده است و ابزارهایی را جهت مستند و تست آنها برای شما آماده کرده‌ایم.

مستندات وب‌سرویس‌های پی‌پینگ
Swagger : آموزش استفاده از swagger را Swagger ببینید
Postman : آموزش استفاده از postman را Postman ببینید

ذخیره شناسه لاگ پی‌پینگ برای پشتیبانی بهتر

در هر درخواست REST که به پی‌پینگ ارسال می‌کنید در پاسخ هر کدام هدری با نام X-PayPingRequest-ID وجود دارد که در صورت ذخیره کردن این شناسه در دیتابیس خود می‌توانید در صورت وجود مشکل با دادن این شناسه به پشتیبانی بهتر فنی کمک می‌کنید. نمونه آن در عکس زیر در POSTMAN نشان داده شده است.


Authentication

bearerAuth

در پی‌پینگ برای احراز هویت می بایست authorization هدر را بصورت زیر بر روی درخواست‌هایتان ست کنید :

Authorization : Bearer TOKEN

برای دریافت توکن اختصاصی‌تان می‌توانید از نحوه دریافت توکن اختصاصی استفاده کنید.

openId

استاندارد openId oAuth2 می‌تواند برای کسب‌وکارهایی که نیاز به دریافت دسترسی از کاربران ‌پی‌پینگ دارند کاربرد مهمی داشته باشد. با اتصال سرویس‌تان به پی‌پینگ می‌توانید کل فرآیند ثبت‌نام کاربرانتان را بر روی پی‌پینگ پیاده‌سازی کنید و احراز هویت کاربرانتان را به ما بسپارید، برای آنها پرداخت بسازید و از گزارش‌های پرداخت آنها در سرویس هایتان استفاده کنید.

نمونه‌هایی که از سرویس هایی که با این استاندارد به پی‌پینگ متصل شده‌اند را در بخش همکاران ما می‌توانید ببینید.

برای آشنایی با این روش می توانید از نحوه دریافت توکن اپلیکیشن (oAuth2) استفاده کنید.

کدهای دریافتی از هر سرویس

بعد از ارسال هر درخواست به سمت سرور، از سمت ما طبق قواعد وب‌سرویس‌های RESTful یک کدی به شما بازگرداننده می‌شود. هر کد معنایی دارد که در جدول زیر توضیحات مربوطه را می‌بینید

200 عملیات با موفقیت انجام شد
400 مشکلی در ارسال درخواست وجود دارد
500 مشکلی در سرور رخ داده است
503 سرور در حال حاضر قادر به پاسخگویی نمی‌باشد
401 عدم دسترسی
403 دسترسی غیر مجاز
404 آیتم درخواستی مورد نظر موجود نمی‌باشد

بدنه خطاهای کد ۴۰۰ همواره به فرمت زیر و همراه با متن خطا دریافت می‌شود.

{
"کد خطا یا نام پارامتر دارای مشکل" : "متن خطا"
}


در فرایند های پرداخت بعلت اینکه ممکن است با توجه به هرنوع خطا کاربر عملیات خاصی را برنامه‌ریزی کرده باشد، به هر خطا کدی اختصاص داده شده است که در جدول زیر مشخص گردیده :

1 تراكنش توسط شما لغو شد
2 رمز کارت اشتباه است.
3 cvv2 یا تاریخ انقضای کارت وارد نشده است
4 موجودی کارت کافی نیست.
5 تاریخ انقضای کارت گذشته است و یا اشتباه وارد شده.
6 کارت شما مسدود شده است
7 تراکنش مورد نظر توسط درگاه یافت نشد
8 بانک صادر کننده کارت شما مجوز انجام تراکنش را صادر نکرده است
9 مبلغ تراکنش مشکل دارد
10 شماره کارت اشتباه است.
11 ارتباط با درگاه برقرار نشد، مجددا تلاش کنید
12 خطای داخلی بانک رخ داده است
15 این تراکنش قبلا تایید شده است
16 درخواست تایید دیگری از سوی شما در انتظار تایید است
17 درخواست ارسال به درگاه تکراری می باشد
18 کاربر پذیرنده تایید نشده است
19 هویت پذیرنده کامل نشده است و نمی تواند در مجموع بیشتر از ۵۰ هزار تومان دریافتی داشته باشد
25 سرویس موقتا از دسترس خارج است، لطفا بعدا مجددا تلاش نمایید
26 کد پرداخت پیدا نشد
27 پذیرنده مجاز به تراکنش با این مبلغ نمی باشد
28 لطفا از قطع بودن فیلتر شکن خود مطمئن شوید
29 ارتباط با درگاه برقرار نشد
31 امکان تایید پرداخت قبل از ورود به درگاه بانک وجود ندارد
38 آدرس سایت پذیرنده نا معتبر است
39 پرداخت ناموفق، مبلغ به حساب پرداخت کننده برگشت داده خواهد شد
44 RefId نامعتبر است
46 توکن ساخت پرداخت با توکن تایید پرداخت مغایرت دارد
47 مبلغ تراکنش مغایرت دارد
48 پرداخت از سمت شاپرک تایید نهایی نشده است
49 ترمینال فعال یافت نشد، لطفا مجددا تلاش کنید
این مقاله مفید بود؟
لغو
خیلی ممنون!