وب سرویسهای پیپینگ بر پایه استاندارد محبوب REST پیادهسازی شده است. برای راحتی برنامهنویسان با استفاده از استاندارد OpenAPI3.0 تمام متدها پیادهسازی شده است و ابزارهایی را جهت مستند و تست آنها برای شما آماده کردهایم.
* [مستندات وبسرویسهای پیپینگ]
* Swagger: آموزش استفاده از swagger را Swagger ببینید.
* Postman: آموزش استفاده از postman را Postman ببینید.
ذخیره شناسه لاگ پیپینگ برای پشتیبانی بهتر
در هر درخواست REST که به پیپینگ ارسال میکنید در پاسخ هر کدام هدری با نام X-PayPingRequest-ID وجود دارد که در صورت ذخیره کردن این شناسه در دیتابیس خود میتوانید در صورت وجود مشکل با دادن این شناسه به پشتیبانی بهتر فنی کمک میکنید. نمونه آن در عکس زیر در POSTMAN نشان داده شده است.
Authentication
1. bearerAuth
در پیپینگ برای احراز هویت می بایست authorization هدر را بصورت زیر بر روی درخواستهایتان ست کنید :
Authorization : Bearer TOKEN
برای دریافت توکن اختصاصیتان میتوانید از [نحوه دریافت توکن اختصاصی] استفاده کنید.
2. 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` خطای داخلی بانک رخ داده است
* `14` خطای داخلی بانک رخ داده است
* `15` این تراکنش قبلا تایید شده است
* `16` درخواست تایید دیگری از سوی شما در انتظار تایید است
* `17` درخواست ارسال به درگاه تکراری می باشد
* `18` کاربر پذیرنده تایید نشده است
* `19` هویت پذیرنده کامل نشده است و نمی تواند در مجموع بیشتر از ۵۰ هزار تومان دریافتی داشته باشد
* `25` سرویس موقتا از دسترس خارج است، لطفا بعدا مجددا تلاش نمایید
* `26` کد پرداخت پیدا نشد
* `27` پذیرنده مجاز به تراکنش با این مبلغ نمی باشد
* `28` لطفا از قطع بودن فیلتر شکن خود مطمئن شوید
* `29` ارتباط با درگاه برقرار نشد
* `31` امکان تایید پرداخت قبل از ورود به درگاه بانک وجود ندارد
* `38` آدرس سایت پذیرنده نا معتبر است
* `39` پرداخت ناموفق، مبلغ به حساب پرداخت کننده برگشت داده خواهد شد
* `44` RefId نامعتبر است
* `46` توکن ساخت پرداخت با توکن تایید پرداخت مغایرت دارد
* `47` مبلغ تراکنش مغایرت دارد
* `48` پرداخت از سمت شاپرک تایید نهایی نشده است
* `49` ترمینال فعال یافت نشد، لطفا مجددا تلاش کنید
* `51` ترمینال فعال برای کاربر وجود ندارد
لیست خطاهای سرویس تسویه نیز به شرح زیر میباشد:
* `70` عملیات به علت خطای داخلی متوقف شد
* `71` مبلغ تسویه نمیتواند کمتر از 1000 تومان باشد
* `72` لطفا اطلاعات محلی خود را تکمیل کنید
* `73` مغایرتی در وضعیت کاربر به منظور ثبت تسویه وجود دارد
* `74` این سرویس برای شما غیر فعال میباشد
* `75` حداکثر میزان درخواست تسویه در هر بار 50 میلیون تومان میباشد
* `76` شماره شبای معتبری برای شما ثبت نشده است
* `77` شماره شبا، با شبا ثبت شده توسط کاربر مغایرت دارد
* `78` شماره شبا مورد نظر تایید نشده است. لطفا با واحد پشتیبانی تماس حاصل فرمایید
* `79` لیست تسویه در هر ارسال نمیتواند بیش از 50 درخواست باشد
* `80` کد تایید نامعتبر است
* `81` مبلغ تسویه نمیتواند کمتر از 1000 تومان باشد. یکی از تسویهها کمتر از 1000 تومن میباشد
* `82` فایل نامعتبر است
* `83` شناسه پرداخت نامعتبر است
* `84` این پرداخت هنوز تایید نشده است و ابتدا باید تایید گردد
* `85` این پرداخت قبلا تسویه شده است و امکان برگشت آن وجود ندارد
* `86` استرداد وجه تنها برای پرداختهای بلاک شده امکان پذیر میباشد
* `87` این پرداخت قبلا برگشت خورده است
* `88` مبلغ تسویه بیشتر از موجودی شما میباشد
* `89` A تومان از موجودی غیرقابل برداشت میباشد، مبلغ قابل برداشت B تومان میباشد
* `90` موجودی قابل تسویه A تومان میباشد
* `91` توکن کاربر غیرفعال میباشد
* `92` این سرویس برای ترمینال فعال شما در دسترس نمیباشد
در صورت داشتن هرگونه سوال و نیاز به راهنمایی ، با پشتیبانی آنلاین سایت پیپینگ در ارتباط باشید.
به روز شده در: 1400/11/09