COcopper-co
clearloop

Get ClearLoop Settlement by ID

get/clearloop/settlements/{settlementId}

Request

Path parameters

settlementIdstring required

Response

OK

completedAtstring

Unix timestamp (in milliseconds) of the date and time when the settlement was fully completed

createdAtstring

Unix timestamp (in milliseconds) of the date and time when the settlement started

custodianstring

Custodian associated to settlement

cycleEndTimestampstring

Unix timestamp (in milliseconds) of the date and time when the settlement cycle has ended

cycleStartTimestampstring required

Unix timestamp (in milliseconds) of the date and time when the settlement cycle has started

deadlinestring

Unix timestamp (in milliseconds) of the settlement deadline

exchangestring required

Exchange name

exchangeIdstring required

Exchange identifier

failureReasonstring
settlementIdstring required

Unique Copper settlement identifier

settlementStatus'new' | 'pending-exchange-confirmation' | 'in-progress' | 'post-pnl-fetch' | 'completed' | 'failed' | 'skipped' | 'cancelled' | 'partially-completed' | 'ignored' | 'pre-pnl-fetch' | 'trading-account-order-execution-completed' | 'on-chain-orders-in-progress' | 'pre-termination' | 'under-review' | 'pending-settlements-check' | 'excluded' required
settlementSubStatus'started' | 'in-progress' | 'completed' | 'failed' | 'exchange-api-failure' | 'waiting-exchange-calculation' | 'insufficient-collateral' | 'negative-balances' | 'client-loss-greater-than-delegated' | 'pending-previous-settlement' | 'copper-order-flow-failed' | 'pending-order-processing' | 'pending-order-creation' | 'pending-delegations' | 'pending-exchange-notification' | 'paused' | 'waiting-funds' | 'settlement-not-complete-within-cycle-time' | 'manual-resolving' | 'partially-completed' | 'all-portfolios-excluded' required
triggerOriginstring

Origin of settlement execution trigger (e.g. scheduled, manual, big-bang-exclusion)

Changes

No recorded changes to this operation across all 1 revision of this API.