--- title: "Get ClearLoop Settlement by ID" method: GET path: "/clearloop/settlements/{settlementId}" tags: ["clearloop"] --- # Get ClearLoop Settlement by ID `GET /clearloop/settlements/{settlementId}` ## Request - Base URL: `https://api.copper.co/platform` - URL: `https://api.copper.co/platform/clearloop/settlements/{settlementId}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `settlementId` string, required ## Response `200` OK - ClearLoopSettlementV2 - `completedAt` string: Unix timestamp (in milliseconds) of the date and time when the settlement was fully completed - `createdAt` string: Unix timestamp (in milliseconds) of the date and time when the settlement started - `custodian` string: Custodian associated to settlement - `cycleEndTimestamp` string: Unix timestamp (in milliseconds) of the date and time when the settlement cycle has ended - `cycleStartTimestamp` string, required: Unix timestamp (in milliseconds) of the date and time when the settlement cycle has started - `deadline` string: Unix timestamp (in milliseconds) of the settlement deadline - `exchange` string, required: Exchange name - `exchangeId` string, required: Exchange identifier - `failureReason` string - `settlementDetails` ClearLoopSettlementDetails[]: Array of settlement detail records for each client account linked to a given settlement ID - `clientAccountId` string, required: Unique exchange account identifier - `exchangeSettlementId` string, required: Unique identifier assigned by the exchange for the settlement - `exclusionDetails` ClearLoopSettlementExclusionDetails - `exclusionReason` string, required: Settlement exclusion reason. Possible values: "Delegation or undelegation in progress", "Trading vault signature required on previous settlement", "Pending other client trading vault signature", "Irrecoverable API error returned by exchange", "Settlement amount exceeds delegated amount", "Retry threshold surpassed", "Organization set to atomic settlement", "Balance fetching error", "Exchange has failed to compute balance", "Portfolio is frozen", "Previous Settlement Exclusion is in progress", "Settlement for this portfolio has been paused by exchange", "Settlement for this portfolio has been already settled for the same cycle", "Portfolio moved to separate settlement" - `exclusionSettlementId` string: Exclusion settlement identifier, if the client has been excluded from a settlement cycle. - `organizationId` string: Unique identifier for the client organisation tied to a settlement record - `pnlAttributionEndTimestamp` string: Unix timestamp (in milliseconds) of the end of the period used to attribute profit and loss (PnL) for the settlement - `pnlAttributionStartTimestamp` string: Unix timestamp (in milliseconds) of the start of the period used to attribute profit and loss (PnL) for the settlement - `portfolioId` string, required: Unique Copper account identifier - `settlementInstructions` ClearLoopSettlementInstruction[], required: Array of settlement instruction records, grouped by settlement currency and client account, linked to a given settlement ID - `balance` string: Client's delegated balance in Copper, fetched at the time of settlement - `currency` string, required: Settlement currency - `orderId` string: Identifier of the order linked to the settlement for the specified client account and currency - `orderStatus` 'new' | 'waiting-funds' | 'reserving' | 'reserved' | 'queued' | 'validating-funds' | 'working' | 'waiting-approve' | 'co-sign-require' | 'approved' | 'processing' | 'executed' | 'canceled' | 'rejecting' | 'rejected' | 'declining' | 'declined' | 'suspending' | 'suspended' | 'blocked' | 'action-required' | 'accepting' | 'accepted' | 'require-initializer-approve' | 'waiting-counterparty-approve' | 'require-counterparty-approve' | 'ready-for-settlement' | 'settled' | 'part-signed-tx-added' | 'full-signed-tx-added' | 'rejected-part-signed-tx-added' | 'rejected-full-signed-tx-added' | 'accepted-part-signed-tx-added' | 'accepted-full-signed-tx-added' | 'awaiting-settlement' | 'master-password-required' | 'manual-resolving' | 'error' | 'pending-atomic-settlement-confirmation' | 'atomic-settlement-reservation-completed' | 'require-finalize' | 'waiting-accept-deposit' | 'waiting-reject-deposit' - `settlementAmount` string, required: Aggregate amount to be settled across main and subaccounts within the exchange - `settlementAmountUSD` string: USD equivalent of the `settlementAmount` - `settlementInstructionId` string: Unique identifier for the settlement instruction (per client account and currency per cycle) - `status` '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' - `status` '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' - `settlementId` string, 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 - `triggerOrigin` string: Origin of settlement execution trigger (e.g. scheduled, manual, big-bang-exclusion) ## Other responses - `400`: Bad Request - `403`: Forbidden - `409`: Conflict --- [API](https://skmtc.dev/copper-co/apis/copper-platform-api.md) - [All operations](https://skmtc.dev/copper-co/apis/copper-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/copper-co/apis/copper-platform-api/revisions/44296120fc7d?raw)