clearloop
Get ClearLoop Settlement by ID
GET
/
clearloop
/
settlements
/
{settlementId}
Path Parameters
settlementId
string
requiredResponse
200 - application/json
cycleEndTimestamp
string
requiredUnix timestamp at millisecond precision specific to when the settlement cycle ends
cycleStartTimestamp
string
requiredUnix timestamp at millisecond precision specific to when the settlement cycle has started
deadline
string
requiredUnix timestamp at millisecond precision specific to the settlement deadline
exchange
string
requiredExchange name
exchangeId
string
requiredExchange id
settlementId
string
requiredUnique Copper settlement identifier
settlementStatus
enum<string>
requiredStatus describing the settlement. See details
Available options:
new
, pending-exchange-confirmation
, in-progress
, completed
, failed
, cancelled
, partially-completed
settlementSubStatus
enum<string>
requiredSubStatus 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.