Skip to main content
GET
/
clearloop
/
settlements
/
{settlementId}
Get ClearLoop Settlement by ID
curl --request GET \
  --url https://api.copper.co/platform/clearloop/settlements/{settlementId}
{
  "completedAt": "<string>",
  "createdAt": "<string>",
  "custodian": "<string>",
  "cycleEndTimestamp": "<string>",
  "cycleStartTimestamp": "<string>",
  "deadline": "<string>",
  "exchange": "<string>",
  "exchangeId": "<string>",
  "failureReason": "<string>",
  "settlementDetails": [
    {
      "clientAccountId": "<string>",
      "exchangeSettlementId": "<string>",
      "organizationId": "<string>",
      "pnlAttributionEndTimestamp": "<string>",
      "pnlAttributionStartTimestamp": "<string>",
      "portfolioId": "<string>",
      "settlementInstructions": [
        {
          "balance": "<string>",
          "blockchainTransactionId": "<string>",
          "currency": "<string>",
          "orderId": "<string>",
          "orderStatus": "new",
          "settlementAmount": "<string>",
          "settlementAmountUSD": "<string>",
          "settlementInstructionId": "<string>",
          "status": "new"
        }
      ]
    }
  ],
  "settlementId": "<string>",
  "settlementStatus": "new"
}

Path Parameters

​
settlementId
string
required

Response

OK

​
cycleStartTimestamp
string
required

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

​
exchange
string
required

Exchange name

​
exchangeId
string
required

Exchange identifier

​
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,
on-chain-orders-in-progress
​
settlementSubStatus
enum<string>
required

Sub-status providing additional context to the status of the settlement

​
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

​
deadline
string

Unix timestamp (in milliseconds) of the settlement deadline

​
failureReason
string
​
settlementDetails
object[]

Array of settlement detail records for each client account linked to a given settlement ID