سرویس های قبض

استعلام قبض ناهمگام (مرحله ۱) — ثبت درخواست

<!--seo-open-->

سرویس «استعلام قبض ناهمگام (مرحله ۱) — ثبت درخواست» در دسته استعلام قبض فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

<!--/seo-open-->

در این مرحله اطلاعات قبض وارد می‌شود و شناسه درخواست (requestId) به عنوان پاسخ برگردانده می‌شود. از این شناسه در مرحله دریافت نتیجه استفاده می‌شود.

Scope: billing:billing-inquiry-request:post<br />

Grant type: client_credentials

مراحل فراخوانی

  1. ثبت درخواست استعلام قبض (این سرویس)
  2. مشاهده نتیجه استعلام (مرحله ۲)

پوشش آب، برق و گاز سراسری است.

post/billing/v2/clients/{clientId}/billingInquiryRequest

Request

  • Base URL: https://api.finnotech.ir
  • URL: https://api.finnotech.ir/billing/v2/clients/{clientId}/billingInquiryRequest
  • Auth: HTTP bearer

Path parameters

clientIdstring required

Query parameters

trackIdstring required

Correlation ID (max 40 alphanumeric characters). UUID recommended.

Request body

type'Water' | 'Electricity' | 'Electricity-standard' | 'Gas' | 'GasByBillId' | 'Tel' | 'TelNow' | 'Mobile' | 'MobileNow' required

Bill type.

typeDescription (نوع قبض)
WaterWater bill (آب)
ElectricityElectricity bill (برق)
Electricity-standardElectricity bill — fallback provider (برق پشتیبان)
GasGas bill by subscription number (گاز)
GasByBillIdGas bill by bill ID (گاز با شماره قبض)
TelLandline — end of period (تلفن ثابت، پایان دوره)
TelNowLandline — current (تلفن ثابت، بروز)
MobileMobile — end of period (تلفن همراه، پایان دوره)
MobileNowMobile — current (تلفن همراه، بروز)
parameterstring required

Value to inquire, depending on type:

  • Water, Electricity, Electricity-standard: bill ID (شناسه قبض)
  • Gas: subscription number (شماره اشتراک)
  • GasByBillId: bill number (شماره قبض)
  • Tel, TelNow: landline number with area code (شماره تلفن به همراه کد)
  • Mobile, MobileNow: mobile number (شماره تلفن همراه)
secondParameter'MCI' | 'MTN' | 'RIGHTEL'

Mobile operator when the number was ported to another carrier. Required for Irancell (MTN) and Rightel (RIGHTEL) mobile bills.

ValueOperator (اپراتور)
MCIHamrah-e Aval / MCI (همراه اول)
MTNIrancell (ایرانسل)
RIGHTELRightel (رایتل)

Example request

{
  "type": "Mobile",
  "parameter": "09222223344",
  "secondParameter": "MCI"
}

Response

درخواست استعلام ثبت شد

responseCodestring

Response code returned by the service

trackIdstring

Correlation ID — echoed from the request or auto-generated

status'DONE' | 'FAILED'

Overall API call status (وضعیت فراخوانی سرویس)

Changes

No recorded changes to this operation across all 1 revision of this API.