List Settlement Ledger Transactions | Shimi API

{
  "status": "success",
  "data": {
    "data": [
      {
        "amount": 50000,
        "type": "debit",
        "status": true,
        "reference": "cmgb3n7q20007lp4x9s1t6e8d",
        "previous_balance": 2500800.5,
        "current_balance": 2450750.5,
        "fee": 50,
        "source": "API",
        "narration": "Vendor payment",
        "createdAt": "2026-10-04T11:02:18.330Z",
        "currency": {
          "name": "NGN"
        },
        "customer": null
      },
      {
        "amount": 5000,
        "type": "CREDIT",
        "status": true,
        "reference": "cmgd2j6k50003mn8z4q7r1s9t",
        "previous_balance": 2495850.5,
        "current_balance": 2500800.5,
        "fee": 50,
        "source": "VIRTUAL_ACCOUNT",
        "narration": "Credit from virtual account ADEBAYO TUNDE 0123456780",
        "createdAt": "2026-10-04T10:41:55.812Z",
        "currency": {
          "name": "NGN"
        },
        "customer": null
      }
    ],
    "meta": {
      "page": 1,
      "pageSize": 50,
      "totalItems": 2,
      "totalPages": 1,
      "hasNextPage": false,
      "hasPrevPage": false,
      "nextPage": null,
      "prevPage": null,
      "from": 1,
      "to": 2
    }
  }
}

List the full debit/credit ledger across your settlement accounts (payouts, VTU purchases, collections, etc.).

Query parameters

Field	Type	Required	Notes
`page`	integer	no	Default 1
`pageSize`	integer	no	Default 50, max 100

Behaviour notes

Newest first. The list is at data.data, with pagination in data.meta.
status is a boolean: true = settled/confirmed, false = pending, failed or reversed.
type casing is inconsistent: payouts are debit and virtual-account credits are CREDIT.
source is e.g. API or VIRTUAL_ACCOUNT.
For payouts, reference is the payout reference (verify_id).

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Query parameters

pagestringOptional

pageSizestringOptional

Response

statusstringOptional

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error