IIMMPACT

Digital Marketplace API serves as a service interface for Partner to access to IIMMPACT's transactional hub system that offers mobile airtime recharge, bill payments, gift vouchers and etc.

Digital Marketplace API process recharge request 24/7 and transaction is processed in real-time. The API also compliment with an online portal solution that offer real time transactional report and analytic report to partner.

## API Endpoint

| Environment | URL |
| --- | --- |
| Production | [https://api.iimmpact.com/](https://api.iimmpact.com/) |
| Staging | [https://staging.iimmpact.com/v2/](https://staging.iimmpact.com/v2/) |

## Authentication

An `IdToken` is required to be sent as part of every request to the Digital Marketplace API, in the form of an `Authorization` of type `Bearer Token` in the request header.

An `IdToken` tells our API server that the request it received came from you. Everything that you have access to in Digital Marketplace is accessible with the `IdToken` generated by you.

## IP Restriction

For `topup` request, it can only be performed with an IP address coming from Singapore or Malaysia. IP address outside this two region will need to be whitelisted. Contact IIMMPACT for you IP address to be whitelisted.

For further security, IIMMPACT can also allow only certain IP addresses to perform topup. Email [support@iimmpact.com](https://mailto:support@iimmpact.com) for this feature.

## Transport Layer Security

IIMMPACT API is using TLS 1.2 security policy. The TLS protocol addresses network security problems such as tampering and eavesdropping between a client and a server.

When a client establishes a TLS handshake to IIMMPACT, our security policy will enforce your chosen TLS version and cipher suite options available to the client

## Request Rate Limits

### API Request

Maximum `30,000` API request per five-minute interval per ip address. Your ip address will be blocked for 240 minutes upon exceeding the limit with http error 403 - Forbidden.

### Token Request

Maximum `20` request per second

### Integration Timeout

Maximum `29` seconds integration timeout. Upon timeout API would return http error 504 - Timeout

Introduction

This folder contains APIs that are responsible for authentication.

Authenticate

Balance

Topup

Beta

Reconciliation

Import POSTMAN Collection

Production

Staging

<p class="slate-p" placeholder="Type / for widgets">IIMMPACT API is organized around <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer" target="_blank">REST</a>. Our API has predictable resource-oriented URLs, accepts <a href="https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms" target="_blank">form-encoded</a> request bodies, returns <a href="http://www.json.org/" target="_blank">JSON-encoded</a> responses, and uses standard HTTP response codes, authentication, and verbs.</p><p class="slate-p" placeholder="Type / for widgets">You can use the IIMMPACT API in staging mode, which doesn&apos;t affect live transaction. This staging environment is setup to test on the flow. </p><p class="slate-p" placeholder="Type / for widgets">IIMMPACT API doesn&apos;t support bulk updates. You can work on only one object per request.</p><p class="slate-p" placeholder="Type / for widgets">To optimize performance and reliability, IIMMPACT has established rate limits and allocations for API endpoints.
</p><p class="slate-p" placeholder="Type / for widgets"></p>

. Our API has predictable resource-oriented URLs, accepts 

 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.


<p>Our API uses Bearer Token to authenticate requests. You can create your account to generate token through our <a href="https://dashboard.iimmpact.com/" target="_blank">Dashboard</a>. For staging please use this <a href="https://dashboard-staging.iimmpact.com/" target="_blank">LINK </a>to create your account.</p><div><div></div></div>

Our API uses Bearer Token to authenticate requests. You can create your account to generate token through our 

<p>The Balance API allows you to retrieve the current balance of your IIMMPACT account. </p><p>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. </p><p>Keep in mind that the balance returned b</p>

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 

Please note that authentication is required to access the Balance API endpoint. You will need to include your 

in the request header to authenticate and authorize the request.

<p>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.</p><p></p><div><div></div></div>

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 :

Authorization

The phone number/ account number of the product.

account

The product code of the product. Refer to product listing.

product

data

<p class="slate-p" placeholder="Type / for widgets">The reconciliation API&apos;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. </p><p class="slate-p" placeholder="Type / for widgets"></p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">To access the report , login to <a href="https://dashboard.iimmpact.com/reports/balance-statements" target="_self">Dashboard </a>and navigate to Statement Of Account and select Transaction Summary.</p></div></div><p class="slate-p" placeholder="Type / for widgets">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. </p><div style="text-align:undefined"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1698030591195.jpg" alt=""/></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

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. 

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. 

<p class="slate-p" placeholder="Type / for widgets">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.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">By using this report, you can obtain a comprehensive view of the account&apos;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.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">To access the report , login to <a href="https://dashboard.iimmpact.com/reports/balance-statements" target="_self">Dashboard </a>and navigate to Report. Under Report select Balance Statement.</p></div></div><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">
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.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><div style="text-align:undefined"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697613576005.jpg" alt=""/></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

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.


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.

Balance Statement

date

amount

remark

The current balance when the transaction was made

balance

type

<p class="slate-p" placeholder="Type / for widgets">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. </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

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. 

Invoice

A query parameter that allows filtering invoices based on their date. Use the format 'YYYY-MM-DD' to specify the desired date.

Contains the actual data of the invoice response.

<p class="slate-p" placeholder="Type / for widgets">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.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3">View the report through Dashboard </h3><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">To access the report , login to <a href="https://dashboard.iimmpact.com/reports/balance-statements" target="_self">Dashboard </a>and navigate to Reports and select Transaction.</p></div></div><p class="slate-p" placeholder="Type / for widgets">From the filter section , you can search by type of product , account , referenceid , and statuses. </p><div style="text-align:undefined"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1698030867389.jpg" alt=""/></div><p class="slate-p" placeholder="Type / for widgets"></p>

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.

From the filter section , you can search by type of product , account , referenceid , and statuses. 

Transaction history

The limit parameter allows you to specify the maximum number of transactions to retrieve in a single API call. The default value is 10.

limit

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".

status

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.

offset

The data associated with the transaction.

Additional metadata associated with the transaction.