Introduction
IIMMPACT API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
You can use the IIMMPACT API in staging mode, which doesn't affect live transaction. This staging environment is setup to test on the flow.
IIMMPACT API doesn't support bulk updates. You can work on only one object per request.
To optimize performance and reliability, IIMMPACT has established rate limits and allocations for API endpoints.
What made this section unhelpful for you?
Base URL
Production:
https://api.iimmpact.com/v2
Staging:
https://staging.iimmpact.com/v2
Authenticate
Our API uses Bearer Token to authenticate requests. You can create your account to generate token through our Dashboard. For staging please use this LINK to create your account.
Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Balance
The Balance API allows you to retrieve the current balance of your IIMMPACT account.
When making a request to the Balance API endpoint, you will receive a response containing the current balance information. This response includes details such as the account id , account name and total balance.
Keep in mind that the balance returned by this API endpoint include pending transactions. If you need to retrieve a more detailed view, login to Dashboard and go to Report to view Transaction History and Balance Statement.
Please note that authentication is required to access the Balance API endpoint. You will need to include your idToken in the request header to authenticate and authorize the request.
Topup
The topup API endpoint allows you to perform topup or check transaction related to top-up. This endpoint provides access to details such as the amount, date, and status of each top-up transaction. The information returned by this API can be used to track and monitor top-up activity within the system.
The diagram below illustrate the standard flow in using the topup API :
Beta
Bill Presentment List
Name | Product Code | Customer Name | Outstanding | Due Date |
Air Selangor | SYABAS | Yes | Yes | Yes |
Air Kelantan | ASKB | Yes | Yes | Yes |
Astro | ASB | Yes | No | No |
Indah Water Konsortium | IW | No | Yes | No |
Pengiran Air Pahang | PAIP | Yes | Yes | No |
Perak Water Board | PWB | No | No | No |
Kuching Water Board | KWB | No | No | No |
Ranhill SAJ | SAJ | No | No | No |
Syarikat Air Darul | SADA | No | No | No |
Syarikat Air Negeri Sembilan | SAINS | No | No | No |
Sabah Eletic | SESB | Yes | Yes | Yes |
Tenaga Nasional Berhad | TNB | No | Yes | Yes |
Celcom Postpaid | CB | No | Yes | No |
Redone Postpaid | RB | Yes | Yes | No |
Maxis Postpaid | MB | No | No | No |
XOX Postpaid | XB | Yes | Yes | Yes |
Digi Postpiad | DB | No | No | No |
Maxis Prepaid | M | No | No | No |
Redone Prepaid | RO | Yes | No | No |
Celcom Prepaid | C | No | No | No |
Digi Prepiad | D | No | No | No |
Majilist Daerah Kuala Langat | MDKL | Yes | Yes | Yes |
Majlis Perbandaran Sepang | MPSS | Yes | Yes | Yes |
Majlis Perbandaran Subang Jaya | MPSJ | Yes | Yes | Yes |
Header Parameters
ID Token From Authrorization
Query Parameters
The phone number/ account number of the product.
The product code of the product. Refer to product listing.
Responses
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"data": {
"message": "Account no is valid",
"CustomerName": "",
"Outstanding": "0",
"Balance": "",
"Data": "",
"Address": "",
"E-Bill": "",
"CustomField": "",
"DueDate": "25/10/2023",
"metadata": {
"status_code": "200",
"product_code": "TNB",
"last_updated": "22-10-2023 12:34:07"
},
"transaction_validity": "false",
"transaction_message": "TNB Maximum count per acc/month exceeded"
}
}Reconciliation
The reconciliation API's endpoint allows you to retrieve specific reports related to your data which can be sync to your ERP system. This API and Dashboard feature section provides functionalities to access various reports based on your requirements. The Reports API endpoint offers a straightforward way to retrieve detailed information and insights about your data.
To access the report , login to Dashboard and navigate to Statement Of Account and select Transaction Summary.
The Invoice statement is generated by month. You filter the result based on the date range. To extract the report, Click on the download button.
What made this section unhelpful for you?
Balance Statement
The balance statement allows you to retrieve the balance history for a specific account. It provides a detailed breakdown of the account balance over a given time period.
By using this report, you can obtain a comprehensive view of the account's financial activity, including incoming and outgoing transactions, fees, adjustments, and any other relevant changes to the balance. This information can be filtered by date, enabling you to focus on specific time ranges.
To access the report , login to Dashboard and navigate to Report. Under Report select Balance Statement.
You can use this filter feature to search for transaction . In the example below, we filter the search by using the start/end date and all types.
Header Parameters
Query Parameters
Date range of the transactions
Responses
Response Attributes
The unique id of the transaction
The date of the transaction
The transaction amount
Remark of the transaction
The current balance when the transaction was made
The type of the transaction.
What made this section unhelpful for you?
Response
{
"id": "70014756",
"date": "2023-09-26 14:59:02.747",
"amount": "-2.979",
"remark": "Trx #59221563 DI.01136096947",
"balance": "-757.1387",
"type": "T"
}Invoice
The Invoice API section provides functionality for retrieving invoice information. With this API, you can retrieve detailed information about invoices in the IIMMPACT system. This includes data such as product name , quantity , amount and total amount based on the range.
Header Parameters
ID Token From Authrorization
Query Parameters
A query parameter that allows filtering invoices based on their date. Use the format 'YYYY-MM-DD' to specify the desired date.
Responses
Response Attributes
Contains the actual data of the invoice response.
Show child attributes
What made this section unhelpful for you?
Response
{
"data": [
{
"product_name": "Celcom Prepaid",
"count": "1",
"total_amount": 0.965
},
{
"product_name": "Celcom Postpaid",
"count": "4",
"total_amount": 4
},
{
"product_name": "Digi Postpaid",
"count": "1",
"total_amount": 1
},
{
"product_name": "Fave Fees",
"count": "675",
"total_amount": 5942.8448
},
{
"product_name": "DNQR Fees",
"count": "5",
"total_amount": 1.5609
},
{
"product_name": "LAZADA",
"count": "13",
"total_amount": 2802.5
},
{
"product_name": "PTPTN/SSPN",
"count": "245",
"total_amount": 242867
},
{
"product_name": "Syarikat Air Melaka Berhad",
"count": "7",
"total_amount": 240.4
},
{
"product_name": "Air Selangor",
"count": "1",
"total_amount": 0.7
},
{
"product_name": "Tenaga Nasional Berhad",
"count": "22",
"total_amount": 7321.5
},
{
"product_name": "Touch n Go",
"count": "24",
"total_amount": 2697.3
},
{
"product_name": "Umobile Postpaid",
"count": "2",
"total_amount": 102
},
{
"product_name": "Unifi",
"count": "11",
"total_amount": 1429.6
}
]
}Transaction history
This functionality allows you to retrieve detailed information about all previous transactions. By specifying the desired date range, you can filter the results to obtain specific transaction records. This API endpoint is essential for gaining insights into the past activities and financial transactions.
View the report through Dashboard
To access the report , login to Dashboard and navigate to Reports and select Transaction.
From the filter section , you can search by type of product , account , referenceid , and statuses.
Header Parameters
ID Token From Authrorization
Query Parameters
The limit parameter allows you to specify the maximum number of transactions to retrieve in a single API call. The default value is 10.
The date parameter allows you to specify a specific date to retrieve transaction history. The format should be in YYYY-MM-DD.
The status parameter allows you to filter the transaction history based on the transaction status. Possible values include "success", "pending", and "failed".
The account parameter allows you to specify the account associated with the transaction.
The offset parameter allows you to specify the number of transactions to skip before retrieving the results.
Responses
Response Attributes
The data associated with the transaction.
Show child attributes
Additional metadata associated with the transaction.
Show child attributes
What made this section unhelpful for you?
Response
{
"data": [
{
"trxid": "20579078",
"date": "2021-11-25 17:06:51.780",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.2300",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-25 17:06:55.493",
"price": "1.2177",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "v3lRKbMOWoEUWZE",
"voucherlink": {}
},
{
"trxid": "20503062",
"date": "2021-11-23 04:20:58.727",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.2300",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-23 09:14:43.657",
"price": "1.2177",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "LUo2HzPYsX0kTqH",
"voucherlink": {}
},
{
"trxid": "20502565",
"date": "2021-11-22 23:57:47.687",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 23:57:59.050",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "hwVSChJ1DxPkgbP",
"voucherlink": {}
},
{
"trxid": "20502560",
"date": "2021-11-22 23:57:21.337",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 23:57:36.850",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "xnNC4uckiTQAzQW",
"voucherlink": {}
},
{
"trxid": "20502370",
"date": "2021-11-22 23:36:49.680",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 23:37:10.180",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "VeKJWfrepelJ6d4",
"voucherlink": {}
},
{
"trxid": "20501879",
"date": "2021-11-22 23:00:44.110",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 23:00:59.823",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "6GCI4chaqizCCIi",
"voucherlink": {}
},
{
"trxid": "20501738",
"date": "2021-11-22 22:47:51.620",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 22:48:11.537",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "8sKNKIqd7SevYWh",
"voucherlink": {}
},
{
"trxid": "20500936",
"date": "2021-11-22 21:59:36.867",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 21:59:50.107",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "C48k7PywP5cOZRb",
"voucherlink": {}
},
{
"trxid": "20500717",
"date": "2021-11-22 21:49:43.820",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 21:49:56.827",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "KTkHOqyjdxsMyjh",
"voucherlink": {}
},
{
"trxid": "20500707",
"date": "2021-11-22 21:49:16.337",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 21:49:27.437",
"price": "1.3068",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "V5gvK0NJghv7CZh",
"voucherlink": {}
},
{
"trxid": "20500322",
"date": "2021-11-22 21:33:59.640",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.3200",
"account": "0164440980",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-11-22 21:34:12.880",
"price": "1.3068",
"sn": "8KM304FERD",
"pin": {},
"expiry": {},
"remarks": {},
"refid": "sZOZ_ree7DkIwH9",
"voucherlink": {}
},
{
"trxid": "20500192",
"date": "2021-11-22 21:28:52.423",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.0100",
"account": "0164440980",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-11-22 21:29:12.477",
"price": ".9999",
"sn": "8KM704FEOF",
"pin": {},
"expiry": {},
"remarks": {},
"refid": "uIoZHkTnY0hZMO7",
"voucherlink": {}
},
{
"trxid": "20500141",
"date": "2021-11-22 21:26:49.727",
"product_code": "CB",
"product_name": "Celcom Postpaid",
"amount": "1.0100",
"account": "01120161038",
"sender": "202.184.216.221",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-22 21:27:06.763",
"price": ".9999",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "OWkYdhIqfC9oaxX",
"voucherlink": {}
},
{
"trxid": "20396595",
"date": "2021-11-19 12:40:36.100",
"product_code": "D",
"product_name": "Digi Prepaid",
"amount": "5.0000",
"account": "0163090040",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-11-19 12:40:40.170",
"price": "4.8550",
"sn": "1092884182755716",
"pin": {},
"expiry": {},
"remarks": {},
"refid": {},
"voucherlink": {}
},
{
"trxid": "20395077",
"date": "2021-11-19 11:19:43.423",
"product_code": "D",
"product_name": "Digi Prepaid",
"amount": "5.0000",
"account": "0164440980",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-19 12:41:09.997",
"price": "4.8550",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": {},
"voucherlink": {}
},
{
"trxid": "20143909",
"date": "2021-11-09 15:52:40.080",
"product_code": "ASB",
"product_name": "Astro",
"amount": "1.0000",
"account": "00000000000",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-09 15:52:40.700",
"price": ".9950",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": {},
"voucherlink": {}
},
{
"trxid": "20143863",
"date": "2021-11-09 15:49:56.913",
"product_code": "ASB",
"product_name": "Astro",
"amount": "1.0000",
"account": "000000000000",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-11-09 15:49:58.857",
"price": ".9950",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "System Error",
"refid": {},
"voucherlink": {}
},
{
"trxid": "19058718",
"date": "2021-10-06 11:27:59.177",
"product_code": "DB",
"product_name": "Digi Postpaid",
"amount": "5.0000",
"account": "0164440980",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-10-06 11:45:58.347",
"price": "4.9500",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": {},
"voucherlink": {}
},
{
"trxid": "18877839",
"date": "2021-10-01 16:44:52.703",
"product_code": "MPSS",
"product_name": "Majlis Perbandaran Sepang (Tax)",
"amount": "1.0000",
"account": "60146477935",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-10-01 16:44:56.110",
"price": ".7000",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "System Error",
"refid": {},
"voucherlink": {}
},
{
"trxid": "18515451",
"date": "2021-09-21 12:44:51.297",
"product_code": "MB",
"product_name": "Maxis Postpaid",
"amount": "10.0000",
"account": "0177992241",
"sender": "+60100000000",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-09-21 12:44:53.210",
"price": "9.7000",
"sn": "01880515",
"pin": {},
"expiry": {},
"remarks": {},
"refid": {},
"voucherlink": {}
},
{
"trxid": "18375135",
"date": "2021-09-17 16:00:19.610",
"product_code": "CEL",
"product_name": "Celcom Internet",
"amount": "3.0000",
"account": "0123071060",
"sender": "202.186.191.9",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-09-17 16:00:29.160",
"price": "2.8650",
"sn": "8IH101HPUD",
"pin": {},
"expiry": {},
"remarks": "test",
"refid": "SnY6zqW2Q8VcHfX",
"voucherlink": {}
},
{
"trxid": "18042572",
"date": "2021-09-10 13:06:40.430",
"product_code": "NAN",
"product_name": "Nando's",
"amount": "25.0000",
"account": "0100000000",
"sender": "202.186.191.9",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-09-10 13:13:21.480",
"price": "22.5000",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Out of stock",
"refid": "W5fJKrv9322YVWNRBKC1",
"voucherlink": {}
},
{
"trxid": "17817474",
"date": "2021-09-06 10:33:27.380",
"product_code": "M",
"product_name": "Maxis Prepaid",
"amount": "60.0000",
"account": "0122245396",
"sender": "58.96.236.192",
"member_id": "00000",
"status_code": "40",
"status_name": "Failed",
"response_date": "2021-09-06 10:33:41.050",
"price": "57.7800",
"sn": {},
"pin": {},
"expiry": {},
"remarks": "Invalid Account No",
"refid": "76HAK1TH2E1z66uScDb3",
"voucherlink": {}
},
{
"trxid": "16703566",
"date": "2021-08-13 11:25:22.593",
"product_code": "YESP",
"product_name": "Yes Pin",
"amount": "5.0000",
"account": "0100000000",
"sender": "202.186.113.221",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-08-13 11:25:23.500",
"price": "4.8500",
"sn": "SE0-0000163288",
"pin": "3200000510845610",
"expiry": "20231231",
"remarks": "S",
"refid": "iU2u5IlBlqX5X_k",
"voucherlink": {}
},
{
"trxid": "15614532",
"date": "2021-07-21 16:45:14.947",
"product_code": "YESP",
"product_name": "Yes Pin",
"amount": "5.0000",
"account": "0164440980",
"sender": "202.184.62.31",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-07-21 16:45:15.843",
"price": "4.8500",
"sn": "SE0-0000154776",
"pin": "2900000563531307",
"expiry": "20231231",
"remarks": {},
"refid": "lJkt6kGr0FK67KjZAM2y",
"voucherlink": {}
},
{
"trxid": "15614374",
"date": "2021-07-21 16:37:43.667",
"product_code": "YESP",
"product_name": "Yes Pin",
"amount": "5.0000",
"account": "0164440980",
"sender": "202.184.62.31",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-07-21 16:37:44.517",
"price": "4.8500",
"sn": "SE0-0000154772",
"pin": "2900000573584684",
"expiry": "20231231",
"remarks": {},
"refid": "qd3sgULnGE09tctvVYeb",
"voucherlink": {}
},
{
"trxid": "15614203",
"date": "2021-07-21 16:28:49.550",
"product_code": "YESP",
"product_name": "Yes Pin",
"amount": "5.0000",
"account": "0164440980",
"sender": "202.184.62.31",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-07-21 16:28:50.440",
"price": "4.8500",
"sn": "SE0-0000154767",
"pin": "2900000592769474",
"expiry": "20231231",
"remarks": {},
"refid": "HZZ1mpk65o53LndoMY6t",
"voucherlink": {}
},
{
"trxid": "15614094",
"date": "2021-07-21 16:23:31.533",
"product_code": "NJP",
"product_name": "Njoi Pin",
"amount": "10.0000",
"account": "0164440980",
"sender": "202.184.62.31",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-07-21 16:23:32.373",
"price": "9.7000",
"sn": "142050010080",
"pin": "1420500100802605",
"expiry": "20221231",
"remarks": {},
"refid": "nIdlbxnKSaPBQTk7K1NR",
"voucherlink": {}
},
{
"trxid": "12197151",
"date": "2021-04-13 21:45:19.283",
"product_code": "FEE",
"product_name": "Fave Fees",
"amount": "100.0000",
"account": "60123456789",
"sender": "+60123456789",
"member_id": "00000",
"status_code": "20",
"status_name": "Successful",
"response_date": "2021-04-13 21:45:19.360",
"price": "2.5500",
"sn": {},
"pin": {},
"expiry": {},
"remarks": {},
"refid": {},
"voucherlink": {}
}
],
"meta": {
"transaction_count": "29",
"total_amount": "262.3600",
"total_price": "158.0414"
}
}Import POSTMAN Collection
The following link contains all IIMMPACT API.
Click this LINK to import the our API collection into Postman.