Inquiry
API to inquiry PDAM.
Path
Method | Path |
---|---|
POST | api/v1/bill/check |
Test Case
Code | Number | Response |
---|---|---|
PDAMKOTA.SURABAYA | 10200000 | Success - 1 bill |
PDAMKOTA.MEDAN | 10200999 | Success - 4 bills |
AETRA | 10200001 | Inquiry - Invoice Has Been Paid |
AETRA | 10200014 | Inquiry - Incorrect Destination Number |
AETRA | 10200103 | Inquiry - Time Out |
PDAMKOTA.MEDAN | 10201037 | Payment - Payment Failed |
PDAMKOTA.MEDAN | 10201039 | Payment - Pending / transaction in process |
PDAMKOTA.MEDAN | 10201105 | Payment - MISC Error / Biller System Error |
PDAMKOTA.MEDAN | 1020XXXX | Test other response scenarios in the test case menu. |
Request Body
Attributes | Type | Description | Mandatory |
---|---|---|---|
commands | String | Value: inq-pasca | Yes |
username | String | Your registered phone number | Yes |
code | String | Product Code. You can get list of product code in pricelist api or from pricelist here | Yes |
hp | String | PDAM customer number | Yes |
ref_id | String | Your order number / reference ID ( must unique ) | Yes |
sign | String | Signature. Value: md5(username+api_key+ref_id) | Yes |
{
"commands" : "inq-pasca",
"username" : "123123123",
"code" : "PDAMKOTA.SURABAYA",
"hp" : "10200000",
"ref_id" : "0912837465",
"sign" : "ebb8b87be79243370bd29bfb8894e8d7"
}
Response
Attributes | Type | Description | Mandatory |
---|---|---|---|
tr_id | Integer | IAK inquiry ID | Yes |
code | String | Product code | Yes |
hp | String | PDAM customer number | Yes |
tr_name | String | Bill account name | Yes |
period | String | Bill period | Yes |
nominal | Double | Bill nominal | Yes |
admin | Double | Admin fee | Yes |
ref_id | String | Your order number / reference ID ( must unique ) | Yes |
response_code | String | Response code. See response code list | Yes |
message | String | Message | Yes |
price | Double | Total price that must be paid (nominal + admin fee) | Yes |
selling_price | Double | Deducted balance (price - commission) | Yes |
desc | Object | Product description | Yes |
desc.bill_quantity | Integer | Bill quantity | Yes |
desc.address | String | Invoice Address | Yes |
desc.biller_admin | String | Admin fee | Yes |
desc.pdam_name | String | PDAM name | Yes |
desc.stamp_duty | String | Stamp duty fee | Yes |
desc.due_date | String | Due date (only for PDAMKOTA.SURABAYA) | No |
desc.kode_tarif | String | Fare code (only for PDAMKOTA.SURABAYA) | No |
desc.bill | Object | Bill details | Yes |
desc.bill.detail | Array | Bill details | Yes |
desc.bill.detail.period | String | Bill period of detailed month | Yes |
desc.bill.detail.first_meter | Integer | Initial meter of detailed month | Yes |
desc.bill.detail.last_meter | Integer | Final meter of detailed month | Yes |
desc.bill.detail.penalty | Double | Penalty fee of detailed month | Yes |
desc.bill.detail.bill_amount | Double | Bill amount of detailed month | Yes |
desc.bill.detail.misc_amount | Double | Others fee of detailed month | Yes |
desc.bill.detail.stand | String | Current PDAM stand of detailed month (only for PDAMKOTA.SURABAYA) | No |
There are 2 types of PDAM response :
- Separated desc.bill.detail for each period
For example when there is PDAM bill 2 periods, then the desc.bill.detail will be 2 index array that contain detail for each period.
- Unified desc.bill.detail for all period
For example when there is PDAM bill 2 periods, then the desc.bill.detail just 1 index array that contain detail for all period. Below table is a list of PDAM products for unified detail for all period:
- | - | - |
---|---|---|
PDAMKAB.ACEHBESAR | PDAMKAB.ACEHTAMIANG | PDAMKAB.ACEHUTARA |
PDAMKAB.AGAM | PDAMKAB.BANDUNGB | PDAMKAB.BANGGAI |
PDAMKAB.BANGKABARAT | PDAMKAB.BANTUL | PDAMKAB.BANYUASIN |
PDAMKAB.BATANGHARI | PDAMKAB.BEKASI | PDAMKAB.BELITUNGTIMUR |
PDAMKAB.BENGKAYANG | PDAMKAB.BONE | PDAMKAB.BONEBOLANGO |
PDAMKAB.BULUNGANTANJUNGSELOR | PDAMKAB.BUTON | PDAMKAB.CILACAPNONREGULER |
PDAMKAB.DOMPU | PDAMKAB.ENREKANG | PDAMKAB.GIANYAR |
PDAMKAB.GIANYARNONAIR | PDAMKAB.GORONTALO | PDAMKAB.GORONTALOLIMBOTO |
PDAMKAB.GOWA | PDAMKAB.GUNUNGKIDUL | PDAMKAB.HALMAHERAUTARA |
PDAMKAB.HULUSUNGAIUTARAAMUNTAI | PDAMKAB.JEMBRANA | PDAMKAB.KAPUASHULU |
PDAMKAB.KARAWANGB | PDAMKAB.KEDIRI | PDAMKAB.KERINCI |
PDAMKAB.KETAPANG | PDAMKAB.KOLAKA | PDAMKAB.KOLAKAUTARA |
PDAMKAB.KOTABARUPULAULAUT | PDAMKAB.KUDUS | PDAMKAB.KUPANG |
PDAMKAB.KUTAIBARAT | PDAMKAB.KUTAIKERTANEGARA | PDAMKAB.LAMANDAU |
PDAMKAB.LAMONGAN | PDAMKAB.LAMPUNGSELATAN | PDAMKAB.LEBAK |
PDAMKAB.LIMAPULUHKOTA | PDAMKAB.LOMBOKTIMUR | PDAMKAB.LUWU |
PDAMKAB.LUWUTIMUR | PDAMKAB.LUWUUTARA | PDAMKAB.MAGELANG |
PDAMKAB.MAGETAN | PDAMKAB.MAJALENGKA | PDAMKAB.MALINAU |
PDAMKAB.MALUKUTENGGARA | PDAMKAB.MANGGARAI | PDAMKAB.MAROS |
PDAMKAB.MEMPAWAH | PDAMKAB.MERANGIN | PDAMKAB.MINAHASAUTARA |
PDAMKAB.MUARABUNGO | PDAMKAB.MUARAENIM | PDAMKAB.MUAROJAMBI |
PDAMKAB.MUSIBANYUASIN | PDAMKAB.NGAWI | PDAMKAB.OGANILIR |
PDAMKAB.OKUBATURAJA | PDAMKAB.OKUSELATAN | PDAMKAB.PACITAN |
PDAMKAB.PADANGPARIAMAN | PDAMKAB.PAMEKASAN | PDAMKAB.PANDEGLANG |
PDAMKAB.PESSEL | PDAMKAB.POLMAN | PDAMKAB.PRABUMULIH |
PDAMKAB.PURWAKARTA | PDAMKAB.SANGGAU | PDAMKAB.SAROLANGUN |
PDAMKAB.SERANG | PDAMKAB.SERDANG | PDAMKAB.SERUYAN |
PDAMKAB.SIDRAP | PDAMKAB.SIJUNJUNG | PDAMKAB.SIKKA |
PDAMKAB.SINJAI | PDAMKAB.SOLOK | PDAMKAB.SRAGEN |
PDAMKAB.SUMBAWA | PDAMKAB.SUMENEP | PDAMKAB.TABALONG |
PDAMKAB.TANAHBUMBU | PDAMKAB.TANAHDATAR | PDAMKAB.TANGERANG |
PDAMKAB.TANJUNGJABUNGBARAT | PDAMKAB.TEBO | PDAMKAB.TIMORTENGAHUTARA |
PDAMKAB.TRENGGALEK | PDAMKAB.TUBAN | PDAMKAB.TULUNGAGUNG |
PDAMKAB.WAJO | PDAMKOTA.BIMA | PDAMKOTA.BLITAR |
PDAMKOTA.BONEWATAMPONE | PDAMKOTA.BONTANG | PDAMKOTA.BUKITTINGGI |
PDAMKOTA.CILEGON | PDAMKOTA.DAROY | PDAMKOTA.DKIPALYJA |
PDAMKOTA.GORONTALO | PDAMKOTA.JAMBI | PDAMKOTA.KANDANGAN |
PDAMKOTA.KENDARI | PDAMKOTA.KUTAITIMUR | PDAMKOTA.LANGSA |
PDAMKOTA.LUBUKLINGGAU | PDAMKOTA.MAGELANG | PDAMKOTA.MOJOKERTO |
PDAMKOTA.PALOPO | PDAMKOTA.PALU | PDAMKOTA.PANGKALPINANG |
PDAMKOTA.PAREPARE | PDAMKOTA.PARIAMAN | PDAMKOTA.PEKANBARU |
PDAMKOTA.PEMATANGSIANTAR | PDAMKOTA.RANTAUPRAPAT | PDAMKOTA.SABANG |
PDAMKOTA.SAMPIT | PDAMKOTA.SINGKAWANG | PDAMKOTA.TANJUNGBALAI |
PDAMKOTA.TANJUNGPINANG | PDAMKOTA.TARAKAN | PDAMKOTA.TARUTUNG |
PDAMKOTA.TASIKMALAYA | PDAMKOTA.TEBINGTINGGI | PDAMKOTA.TEMBILAHAN |
PDAMKOTA.TERNATE | PDAMKOTA.TOMOHON | PDAMKOTA.WISATABATU |
PDAMKOTA.YOGYAKARTA | - | - |
Other than above table is separated detail
Separated Detail Response
{
"data": {
"tr_id": 9732791,
"code": "PDAMKOTA.SURABAYA",
"hp": "10200000",
"tr_name": "DADANG SOEKARDI",
"period": "201412",
"nominal": 35490,
"admin": 2000,
"ref_id": "0912837465",
"response_code": "00",
"message": "INQUIRY SUCCESS",
"price": 37490,
"selling_price": 36790,
"desc": {
"bill_quantity": 1,
"address": "WONOKROMO S.S BARU 2 8",
"biller_admin": "",
"pdam_name": "PDAM SURABAYA",
"stamp_duty": "",
"due_date": "1-15 DES 2014",
"kode_tarif": "3A",
"bill": {
"detail": [
{
"period": "201412",
"first_meter": 4589,
"last_meter": 4613,
"penalty": 7500,
"bill_amount": 27240,
"misc_amount": 750,
"stand": ""
}
]
}
}
},
"meta": []
}
Unified Detail Response
{
"data": {
"tr_id": 9732791,
"code": "PDAMKOTA.YOGYAKARTA",
"hp": "10200000",
"tr_name": "DADANG SOEKARDI",
"period": "201803,201804",
"nominal": 35490,
"admin": 2000,
"ref_id": "0912837465",
"response_code": "00",
"message": "INQUIRY SUCCESS",
"price": 37490,
"selling_price": 36790,
"desc": {
"bill_quantity": 1,
"address": "WONOKROMO S.S BARU 2 8",
"biller_admin": "",
"pdam_name": "PDAM KOTA YOGYAKARTA",
"stamp_duty": "",
"kode_tarif": "",
"bill": {
"detail": [
{
"period": "201803,201804",
"first_meter": 4589,
"last_meter": 4613,
"penalty": 7500,
"bill_amount": 27240,
"misc_amount": 750
}
]
}
}
},
"meta": []
}
Live Testing
Request URL
https://testpostpaid.mobilepulsa.net/api/v1/bill/check
Request Method
Request Header
Content-Type: application/json
Body
Result
Tutorial Video
You can see this video for inquiry code explanation using Laravel.
Or you can see this video for inquiry code explanation using PHP.