Settlement

Get a settlement batch by date

Changed on

Returns the settlement record for a specific calendar date (ISO-8601 format: YYYY-MM-DD).

get/v1/settlement/date/{date}

Request

Path parameters

datestring date required

Settlement date in ISO-8601 format (e.g. 2025-03-03)

Response

Settlement record found

successboolean
messagestring
errorCodestring
errorsstring[]
timestampstring date-time

Example response

{
  "data": {
    "settlementDate": "2025-03-03",
    "currency": "NGN",
    "totalCredited": 250000,
    "totalDebited": 250000,
    "entries": [
      {
        "applicationName": "WalletApp",
        "currency": "NGN",
        "totalCredited": 150000,
        "totalDebited": 100000,
        "netAmount": 50000
      }
    ]
  }
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status