💳Ledger View

Use this endpoint to view a ledger for a given merchant account. Date filters must be provided as timestamps in epoch miliseconds.

get

This endpoint retrieves the transaction ledger for an authenticated user. The request requires an API token in the header and supports optional filters such as date range, pagination, and user/wallet selection.

Query parameters

startstringOptional

Start datetime for filtering transactions (datetime)

Example: {"value":"2025-05-15T14:10:00"}

endstringOptional

End datetime for filtering transactions (datetime)

Example: {"value":"2025-05-15T15:10:00"}

pageintegerOptional

Page number for pagination (default: 0)

Example: {"value":1}

limitinteger · min: 1 · max: 10Optional

Number of records per page (default: 10, min: 1, max: 10)

Example: {"value":10}

Header parameters

AuthorizationstringRequired

API token for authentication

Example: {"value":"Token your-token-here"}

Responses

200

Ledger transactions retrieved successfully

application/json

400

Invalid request parameters

application/json

404

No ledger data found

application/json

500

Internal server error

application/json

get

/api/v1/merchant/ledger

HTTPcURLJavaScriptPython

GET /api/v1/merchant/ledger HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Accept: */*

{
  "count": 9,
  "status": "OK",
  "transactions": [
    {
      "amount": 100,
      "txn_id": "some-id-string",
      "txn_time": "2025-05-15T14:25:00+02:00",
      "txn_type": "DEBIT"
    }
  ]
}