همه ی API ها بر بستر REST فراهم آورده شده است . برای استفاده از تمام ای پی آی ها باید فراخوانی به صورت REST و ارسال اطلاعات با متد POST و به صورت JSON انجام گیرد . base domain همه ی API ها نیز به صورت زیر است :
https://mupra.ir/restapi/api/ipg/
برای تمامی API ها لازم است که APIKEY خود را بدانید که در پنل قابل مشاهده است .
خروجی API ها نیز به صورت JSON ارسال میشود که از 3 بخش زیر تشکیل شده است :
اگر استاتوس کد 200 و کد 0 و message خروجی به صورت "عملیات با موفقیت انجام شد" باشد به این معنی است که شرایط استفاده از API به درستی رعایت شده است و عملیات انجام شده است در غیر این صورت شما با استاتوس کد غیر از 200 مواجه خواهید شد که به این معنی است که یکی از شرایط را رعایت نکرده اید که پیام خطا برای رفع آن در فیلد message مشاهده خواهید کرد.
با استفاده از این ای پی آی می توانید از مبلغی که تا الان ماپرا با پذیرنده شما تسویه کرده است آگاه شوید .مبالغی که با استفاده از API پایا جابه جا می کنید از این مبلغ کسر خواهد شد .
با استفاده از این ای پی آی میتوانید برای هر مبلغی که میخواهید لینک پرداخت ایجاد کنید و پس از پرداخت آن را در گزارش مالی خود مشاهده کنید :
نمونه خروجی درست:
https://mupra.ir/directIpg/_GEtHMgFeL6RdBlsTvZMvWRTOoqWQ-3sNiQkuU8hz7Z4h85C5FGp1zOOL2MikYei
نمونه خروجی خطا:
{ "code": 100, "message": "duplicate factor number" }
با استفاده از این API میتوانید بعد از پرداخت بفهمید که پرداخت با موفقیت انجام شده یا خیر :
نمونه خروجی درست:
{ "result": { "maskedPan": "603799****3579", "transId": "11111111", "paid": false, "status": 0 }, "code": 0, "message": "عملیات با موفقیت انجام شد" }
لیست تراکنش های یک پذیرنده را مشاهده کنیم برای این کار کافی است سه فیلد api_key و page و pageSize را ارسال کنیم مقدار پیش فرض فیلد های page و pageSize به ترتیب 0 و 10 می باشد و در صورت ارسال نکردن این مقادیر جایگزین خواهد شد.
نمونه خروجی درست:
{ "startPage": 0, "resultCount": 270, "totalPage": 27, "endPage": 26, "selectedPageSize": 0, "resultList": [ { "amount": 1000.00, "maskedPan": "603799****3579", "transId": "11111111", "factorNumber": "98", "paid": true, "description": "توضیحات جدید", "verify": true, "callbackUrl": "https://google.com/", "mobileNo": "09100000000" }] }
ا استفاده از این ای پی آی از حساب متصل خود به ماپرا میتوانید به هر حسابی که میخواهید مبلغی را انتقال دهید :
نمونه خروجی خطا:
{ "code": 100, "message": "ApiKey_Not_Found" }