Settlements

GET Settlement

get

Retrieve a settlement by its settlementId.

Authorizations
Path parameters
settlementIdstring · uuidRequired

The settlementId of the settlement

Responses
200
Successful response
application/json
Responseone of
or
get
GET /api/v1/settlements/{settlementId} HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "settlementId": "bf89babc-b0ee-4234-8afe-47a88416a23b",
  "valueDate": "2025-07-03",
  "settlementStatus": "INITIATED",
  "settlementType": "TRADES",
  "tradeDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_trade_detail.json",
  "customerSettlementDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_customer_settlement_detail.json",
  "totalTrades": "3",
  "totalSells": "2",
  "totalBuys": "1",
  "assets": [
    {
      "currency": "BTC",
      "trades": "3",
      "sells": "2",
      "buys": "1",
      "totalQuantity": "9.11679943",
      "quantityBuys": "4.53816155",
      "quantitySells": "4.57863788",
      "clientSends": "0.04047633",
      "clientReceives": "0"
    }
  ]
}

GET Settlements

get

Retrieve a list of settlements with optional filtering and pagination.

Authorizations
Query parameters
settlementStatusstring · enumOptional

Filter settlements by status

Possible values:
valueDateStartstring · date-timeOptional

Filter settlements by settlement value date lower bound, exclusive

valueDateEndstring · date-timeOptional

Filter settlements by settlement value date upper bound, inclusive

afterstringOptional

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integerOptional

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortFieldstringOptional

Will sort the returned data using the specified field.

sortDirectionstring · enumOptional

Specifies the sort direction for the sortField.

Possible values:
Responses
200
Successful response
application/json
get
GET /api/v1/settlements HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "settlementId": "bf89babc-b0ee-4234-8afe-47a88416a23b",
      "valueDate": "2025-07-03",
      "settlementStatus": "INITIATED",
      "settlementType": "TRADES",
      "tradeDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_trade_detail.json",
      "customerSettlementDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_customer_settlement_detail.json",
      "totalTrades": "3",
      "totalSells": "2",
      "totalBuys": "1",
      "assets": [
        {
          "currency": "BTC",
          "trades": "3",
          "sells": "2",
          "buys": "1",
          "totalQuantity": "9.11679943",
          "quantityBuys": "4.53816155",
          "quantitySells": "4.57863788",
          "clientSends": "0.04047633",
          "clientReceives": "0"
        }
      ]
    }
  ]
}
PreviousExecutionsNextTransactions

Last updated