Skip to main content
POST
Retrieve settlements

Body

application/json
settlementRequestIds
string[]
fromDate
string<yyyy-MM-dd>

Starting from date of request

toDate
string<yyyy-MM-dd>

Up until date of request

statuses
enum<string>[]

Status of settlement request

Available options:
SETTLEMENT_RECEIVED,
SETTLEMENT_INITIATED,
SETTLEMENT_AWAITING_FUNDS,
SETTLEMENT_PAY_IN,
SETTLEMENT_PAY_OUT,
SETTLEMENT_COMPLETE,
SETTLEMENT_REJECTED,
SETTLEMENT_FAILED
paginationLimit
number

Number of items in response (default is 10)

paginationOffset
number

Response

OK

items
object[]
required
total
integer
required

total count of matching records