GET
/
clearloop
/
settlements

Query Parameters

portfolioId
string

Copper portfolio unique identifier for which records can be retrieved

clientAccountId
string

Exchange account unique identifier for which records can be retrieved

createdAfter
string

Unix timestamp in milliseconds to filter settlements created after this time

createdBefore
string

Unix timestamp in milliseconds to filter settlements created before this time

cycleStartTimestamp
string

Unix timestamp down to the millisecond granularity that can be used to retrieve records for this cycle timestamp

cycles
string

Last number of cycles that you want to retrieve for every exchange. For example for 1 cycle, it would mean to bring back the last settlement for every exchange

clearLoopSettlementStatuses
enum<string>[]

Comma separated list with statuses to be included. See details

Available options:
new,
pending-exchange-confirmation,
in-progress,
completed,
failed,
cancelled,
partially-completed
clearLoopSettlementStatusesNotIn
enum<string>[]

Comma separated list with statuses not to be included. See details

Available options:
new,
pending-exchange-confirmation,
in-progress,
completed,
failed,
cancelled,
partially-completed
limit
string
default: 1000

Limit for pagination

sortDirection
string
default: asc

Parameter to sort data in 'asc' ascending or 'desc' descending order according to 'created_at'

offset
string

Offset for pagination

Response

200 - application/json
settlements
object[]
required
pagination
object
Get ClearLoop Exchange by IDGet ClearLoop Settlement by ID