v1
latestOpenAPI 3.1.02026-07-2656258207.2 KBSettlement
Retrieve a settlement
Retrieve a settlement
get/settlements/{id}
Path parameters
idstring required
ID of the settlement
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.
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",
"charges": [
{
"id": "chg_zam88NgLb7",
"charged_amount": 100,
"customer_id": "cus_X0yJv3ZMpL",
"settlement_amount": 98.6,
"payment_method_id": "pmd_wlVhaYmkl2",
"currency": "NGN",
"charge_date": "2024-06-26"
}
],
"created_datetime": "2025-02-07T12:00:00.022Z"
}
}