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.
Import POSTMAN Collection
The following link contains all IIMMPACT API.
Click this LINK to import the our API collection into Postman.