Balance Statement

Retrieve the balance history for your account. Provides a detailed breakdown of the running balance over a given time period, including deposits, transactions, refunds, and commissions. The data can be filtered by date, enabling you to focus on specific time ranges.

TIP

You can also view and download balance statements from the Dashboard.

API Endpoint

GET https://api.iimmpact.com/v2/balance-statement

Request Headers

Header	Description	Required
X-Api-Key	Your API key	Yes
X-Timestamp	Unix timestamp in seconds	Yes
X-Nonce	Unique request identifier	Yes
X-Signature	HMAC-SHA256 signature (v1=...)	Yes

See API Key Authentication for how to sign your requests.

Query Parameters

Parameter	Type	Required	Description
date	string	Yes	Single date or date range. Format: yyyy-MM-dd for a single date, yyyy-MM-dd - yyyy-MM-dd for a range (note: space-dash-space separator). Examples: 2025-05-01 or 2025-05-01 - 2025-05-31
type	string	No	Filters entries by type. Leave blank to return all types. Possible values: DEPOSIT, TRANSACTION, REFUND, COMMISSION
page	string	No	Pagination
limit	string	No	Specifies the maximum number of transaction records to return

Response 200

Field	Type	Description
data	array	List of balance entries
data[].id	number	Unique identifier for the balance entry
data[].date	string	Timestamp of when the balance entry was recorded (GMT+8)
data[].amount	number	The amount by which the balance changed (can be positive or negative)
data[].balance	number	The account balance after this entry was applied
data[].remarks	string	Description of the transaction
data[].type	string	The type of balance entry
links	object	Pagination links
links.first	string	URL to the first page
links.last	string	URL to the last page
links.prev	string	URL to the previous page (null if on first page)
links.next	string	URL to the next page (null if on last page)
meta	object	Pagination metadata
meta.current_page	number	The current page number
meta.from	number	Starting record index on this page
meta.last_page	number	The total number of pages
meta.path	string	Base API path
meta.per_page	number	Number of records per page
meta.to	number	Ending record index on this page
meta.total	number	The total number of balance entries
summary	object	Aggregate totals for the queried period
summary.total_transactions	object	Transaction totals: { amount: number, count: number }
summary.total_deposit	object	Deposit totals: { amount: number, count: number }
summary.total_refund	object	Refund totals: { amount: number, count: number }

Example Response:

{
  "data": [
    {
      "id": 133382527,
      "date": "2025-05-19 13:06:50.523",
      "amount": -628.7,
      "balance": 139985.697,
      "remarks": "Trx #106609887 TNB.220000000000",
      "type": "T"
    }
  ],
  "links": {
    "first": "/balance-statement?page=1",
    "last": "/balance-statement?page=85526",
    "prev": null,
    "next": "/balance-statement?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 85526,
    "path": "/balance-statement",
    "per_page": 2,
    "to": 2,
    "total": 171052
  },
  "summary": {
    "total_transactions": { "amount": -1212026.24, "count": 43846 },
    "total_deposit": { "amount": 1500000.00, "count": 52 },
    "total_refund": { "amount": 25960.54, "count": 318 }
  }
}