افزونه های ماپرا

همه ی API ها بر بستر REST فراهم آورده شده است . برای استفاده از تمام ای پی آی ها باید فراخوانی به صورت REST و ارسال اطلاعات با متد POST و به صورت JSON انجام گیرد . base domain همه ی API ها نیز به صورت زیر است :

https://mupra.ir/restapi/api/ipg/

برای تمامی API ها لازم است که APIKEY خود را بدانید که در پنل قابل مشاهده است .

خروجی API ها نیز به صورت JSON ارسال میشود که از 3 بخش زیر تشکیل شده است :

  1. code
  2. message
  3. result

اگر استاتوس کد 200 و کد 0 و message خروجی به صورت "عملیات با موفقیت انجام شد" باشد به این معنی است که شرایط استفاده از API به درستی رعایت شده است و عملیات انجام شده است در غیر این صورت شما با استاتوس کد غیر از 200 مواجه خواهید شد که به این معنی است که یکی از شرایط را رعایت نکرده اید که پیام خطا برای رفع آن در فیلد message مشاهده خواهید کرد.

دانلود کالکشن پستمن
دریافت موجودی /getBalance

با استفاده از این ای پی آی می توانید از مبلغی که تا الان ماپرا با پذیرنده شما تسویه کرده است آگاه شوید .مبالغی که با استفاده از API پایا جابه جا می کنید از این مبلغ کسر خواهد شد .

نام فیلد
api_key
اجباری
نوع فیلد
string
توضیحات
-
درخواست لینک پرداخت /send/json

با استفاده از این ای پی آی میتوانید برای هر مبلغی که میخواهید لینک پرداخت ایجاد کنید و پس از پرداخت آن را در گزارش مالی خود مشاهده کنید :

نام فیلد
api_key
amount
callback_url
mobile_number
factorNumber
description
اجباری
نوع فیلد
string
string
string
string
string
string
توضیحات
-
مبلغ
لینک بازگشت
شماره همراه
شماره فاکتور(منحصربه فرد)
توضیحات

نمونه خروجی درست:

https://mupra.ir/directIpg/_GEtHMgFeL6RdBlsTvZMvWRTOoqWQ-3sNiQkuU8hz7Z4h85C5FGp1zOOL2MikYei

نمونه خروجی خطا:

{ "code": 100, "message": "duplicate factor number" }

اعتبار سنجی پرداخت /verify/json

با استفاده از این API میتوانید بعد از پرداخت بفهمید که پرداخت با موفقیت انجام شده یا خیر :

نام فیلد
api_key
token
اجباری
نوع فیلد
string
string
توضیحات
-
Token دریافتی از API درخواست لینک پرداخت

نمونه خروجی درست:

{ "result": { "maskedPan": "603799****3579","transId": "11111111","paid": false, "status": 0 }, "code": 0, "message": "عملیات با موفقیت انجام شد" }

لیست تراکنش ها /trx/json

لیست تراکنش های یک پذیرنده را مشاهده کنیم برای این کار کافی است سه فیلد api_key و page و pageSize را ارسال کنیم مقدار پیش فرض فیلد های page و pageSize به ترتیب 0 و 10 می باشد و در صورت ارسال نکردن این مقادیر جایگزین خواهد شد.

نام فیلد
api_key
page
pageSize
اجباری
نوع فیلد
string
string
string
توضیحات
-
-
-

نمونه خروجی درست:

{"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"}]}

انتقال پایا /transfer/paya

ا استفاده از این ای پی آی از حساب متصل خود به ماپرا میتوانید به هر حسابی که میخواهید مبلغی را انتقال دهید :

نام فیلد
api_key
amount
iban
cif
description
اجباری
نوع فیلد
string
string
string
string
string
توضیحات
-
مبلغ
شماره شبای مقصد
کدی که باید از بانک بگیرید برای انتقال
توضیحات

نمونه خروجی خطا:

{ "code": 100, "message": "ApiKey_Not_Found" }

دانلود پلاگین ها