GET
/
clearloop
/
settlements
/
{settlementId}

Path Parameters

settlementId
string
required

Response

200 - application/json
cycleEndTimestamp
string
required

Unix timestamp at millisecond precision specific to when the settlement cycle ends

cycleStartTimestamp
string
required

Unix timestamp at millisecond precision specific to when the settlement cycle has started

deadline
string
required

Unix timestamp at millisecond precision specific to the settlement deadline

exchange
string
required

Exchange name

exchangeId
string
required

Exchange id

settlementId
string
required

Unique Copper settlement identifier

settlementStatus
enum<string>
required

Status describing the settlement. See details

Available options:
new,
pending-exchange-confirmation,
in-progress,
completed,
failed,
cancelled,
partially-completed
settlementSubStatus
enum<string>
required

SubStatus describing the settlement

completedAt
string

Unix timestamp at millisecond precision specific to when the settlement was fully completed

createdAt
string

Unix timestamp at millisecond precision specific to when the settlement started

failureReason
string
settlementDetails
object[]

Settlement details for every client that is part of the settlement.