Skip to main content
GET
/
clearloop
/
settlements
Get ClearLoop Settlements
curl --request GET \
  --url https://api.copper.co/platform/clearloop/settlements
{
  "pagination": {
    "limit": "<string>",
    "page": "<string>",
    "pages": "<string>",
    "totalItems": "<string>"
  },
  "settlements": [
    {
      "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"
    }
  ]
}

Query Parameters

portfolioId
string
clientAccountId
string
exchangeSettlementId
string
createdAfter
string
createdBefore
string
cycleStartTimestamp
string
cycles
string
clearLoopSettlementStatuses
enum<string>[]
clearLoopSettlementStatusesNotIn
enum<string>[]
limit
string
default:1000
sortDirection
string
default:asc
offset
string

Response

settlements
object[]
required
pagination
object