v1
latestOpenAPI 3.1.02026-07-2656258207.2 KBSettlement
List settlement
get/settlements
Query parameters
pageinteger
The page of the data to retrieve. The most recent data entry is on page 1.
sizeinteger
Length of data returned. Defaults to 10.
tostring date-time
The end date and time for a period. This parameter is used in conjunction with the 'from' parameter to define a time range. The value should be in ISO 8601 format.
fromstring date-time
The start date and time for a period. This parameter is used in conjunction with the 'to' parameter to define a time range. The value should be in ISO 8601 format.
Headers
X-Trace-Idstring
A unique identifier to track this operation. It must be between 12 and 255 characters in length.
Response
OK
Example response
{
"data": [
{
"id": "stm_JJo3vjtffW",
"net_amount": 12.34,
"gross_amount": 12.34,
"currency": "NGN",
"status": "completed",
"due_datetime": "2025-02-07T12:00:00.022Z",
"transaction_datetime": "2025-02-06T12:00:00.022Z",
"settlement_account": "0690000031",
"fees": [
{
"type": "stamp_duty",
"amount": 1.4
}
],
"destination": "wallet",
"charge_count": "2",
"created_datetime": "2025-02-07T12:00:00.022Z"
}
]
}