سرویسهاي مرتبط با پرداخت قبض همراه اول و قبوض خدماتی

امکان استعلام مبلغ قبض همراه اول، شناسه قبض و شناسه پرداخت را برای کاربرانتان فراهم کنید,

معرفی REST API

همان طور که شاید تا به حال شنیده باشید API مخفف عبارت Application Programming Interface می‌باشد که به برنامه نویسان امکان رد و بدل کردن اطلاعات مابین پلتفرم های مختلف را از طریق ارسال یک درخواست HTTP(S) ساده و فراخوانی متد های مورد نظر می‌دهد

در واقع REST یک روش ساده و انعطاف پذیری برای استفاده از API است و البته محبوب ترین و پر کاربرد ترین که می‌توان توسط این ساختار از هر کلاینت و پلتفرمی ‌درخواست ساده HTTP(S) را ارسال و پاسخ آن را دریافت نمود. حال فرض کنید در خواست مورد نظر اطلاعات مربوط به ارسال یک پیامک باشد و جواب آن نتیجه و وضعیت پیامک ارسالی باشد.

وب سرویس ارسال پیامک کاوه نگار شماره گیرنده ، متن پیامک و شماره فرستنده را از طریق پارامتر های ورودی در متد GET یا POST دریافت می‌کند و خروجی را در قالب فرمت های XML و JSON برگشت می‌دهد. نکته : اگر با JSON آشنائی ندارید می‌توانید با مراجعه به سایت json.org هم از ساختار فرمت آن مطلع شوید و هم درایور مربوط به زبان برنامه نویسی مورد نظر خود را دریافت نمائید.


پرداخت قبض تنها براي اپراتور ایرانسل کاربرد دارد و در دو مرحله انجام می شود:

  • .1 مرحله چک کردن امکان پرداخت قبض و اطلاعات ارسالی، مثل چک کردن موجودي یا اعتبارسنجی درخواست از نظر بیزنسی (بهعنوان مثال، امکان پرداخت قبض همراه اول وجود ندارد).
  • .2 مرحله تأیید پرداخت که پرداخت در همین مرحله انجام می شود.

توجه داشته باشید برای احراز هویت در تمامی وب سرویس ها میبایست پارامتر "token" را به صورت های GET,POST,HEADER ارسال نمایید در صورتی که توکن خود را دریافت نکردید از داخل پنل کاربری قسمت پروفایل اقدام به گرفتن توکن نمایید (جهت گرفتن توکن کیلیک کنید)

استعلام قبض

براي استعلام قبض مورد نظر لازم است تا API زیر فراخوانی گردد:

آدرس URL

(POST)  https://abrfa.net/webservice/v1/mci/bill/inquiry

مقادیر ارسالی

پارامتر موجودیت نوع توضیح
type_bill اجباری String این فیلد به صورت رشته و اجباریست، مقدار آن یکی از موارد ذیل است: برق : ELECTRICITY-BILL • گاز : GAS-BILL • ثابت تلفن : LAND-LINE-BILL • • BILL-MCI : همراه اول
id_bill اختیاری\اجباری String این فیلد مختص استعلام قبض برق است
number_mobile اختیاری\اجباری String این فیلد براي استعلام قبض هاي برق و همراه اول اجباریست
number_phone اختیاری\اجباری String این فیلد براي استعلام قبض تلفن ثابت اجباریست
code_area اختیاری\اجباری String این فیلد براي استعلام قبض تلفن ثابت اجباریست
code_subscription اختیاری\اجباری String این فیلد براي استعلام قبض گاز اجباریست

خروجی

خروجی ”id_bill ”و ”id_pay ”و ” amount ”به عنوان ورودي باید در API بعدي که چک کردن امکان پرداخت قبض است، وارد گردد.

چک کردن امکان پرداخت قبض

براي چک کردن امکان پرداخت قبض لازم است تا API زیر فراخوانی گردد:

آدرس URL

(POST)   https://abrfa.net/webservice/v1/mtn/check

مقادیر ارسالی

پارامتر موجودیت نوع توضیح
id_bill اجباری String این شناسه از طریق متد استعلام قبض قابل بازیابی است.
id_pay اجباری String این شناسه از طریق متد استعلام قبض قابل بازیابی است.
amount اجباری String این مبلغ به ریال و از طریق متد استعلام قبض قابل بازیابی است.

خروجی

خروجی ”id_provider ”بهعنوان ورودي باید در API بعدي که تأیید پرداخت قبض است، وارد گردد.

تأیید پرداخت قبض

همان طور که پیش تر گفته شد، این مرحله پس از دریافت ”id_provider ”از API قبلی باید انجام شود.

آدرس URL

(POST)   https://abrfa.net/webservice/v1/mtn/confirm

مقادیر ارسالی

پارامتر موجودیت نوع توضیح
provider_id اجباری String کدپیگیری که در مرحله قبل دریافت کردید

درصورتی که تأیید با موفقیت انجام شود، فیلد ”done ”مقدار 1 خواهد داشت.

دریافت وضعیت یک تراکنش خاص

با فراخوانی API زیر می توان وضعیت یک تراکنش مشخص شده با ”id_provider ”را بدست آورد.

آدرس URL

(POST)   https://abrfa.net/webservice/v1/mci/getStatus

مقادیر ارسالی

پارامتر موجودیت نوع توضیح
provider_id اجباری String توکنی که هنگام تایید تراکنش دریافت کردید