Settlements

The following section will explain the settlement entity and their associated API.

Settlement Entity#

id string
The unique Id of the settlement. Example: "setl_7IZKKI4Pnt2kEe",
entity settlement
The name of the entity.
amount integer
The settlement amount, example 50000.
status string
The status of the settlement. This can these values, processed,
fees integer
The amount charged for processing, example 203.
tax integer
The tax amount charged.
utr string
Unique Transaction Reference number "RZRP173069230703",
created_at timestamp
enoch/integer
created_at integer
epoch timestamp

Fetch Settlements#

The following endpoint is used for getting all settlements:

/settlements
from timestamp
The timestamp in seconds after which the settlements were created.
to timestamp
The timestamp in seconds before which the settlements were created.
count int (0)
The number of the settlements to fetch. Maximum is 100.
skip int (0)
The number of settlements to be skipped.

Fetch Settlement using ID#

The following endpoint is used retrieve settlements made using settlement id.

/settlements/:id
id string
The id of the settlement to be retrieved
Curl