---
title: "List Client Settlements"
method: GET
path: "/api/network/v1/enterprises/{enterpriseId}/clients/settlements"
tags: ["Client Settlements & Transfers"]
---

# List Client Settlements

`GET /api/network/v1/enterprises/{enterpriseId}/clients/settlements`

This API call allows clients to get a list of settlements that involve their accounts and their metadata.
Results can be filtered by various parameters and are paginated.

Error scenarios:
- 400: Invalid Request Error
- Occurs when the request parameters are invalid or malformed.
- Examples: Invalid UUID format, invalid pagination parameters.

- 401: Authentication Error
- Occurs when the request is not authorized.
- Examples: Caller is not a member of the enterprise.

- 403: Permission Denied Error
- Occurs when the authenticated client doesn't have necessary permissions.
- Examples: Enterprise does not have OES license.

- 404: Not Found Error
- Occurs when the specified enterprise cannot be found.
- Examples: Enterprise ID doesn't exist.

- 500: Internal Server Error
- Occurs when there's an unexpected server error processing the request.
- Examples: Database connection issues, query errors.

**Requires access token scope:** `settlement_network_read`

## Path parameters

- `enterpriseId` string, required

## Query parameters

- `pageNumber` string, integer
- `pageSize` string
- `settlementIds` string[]
- `onlyShowDisputed` boolean
- `partnerIds` string[]
- `partyConnectionIds` string[]
- `counterpartyConnectionIds` string[]
- `statuses` string[]

## Response `200`

OK

- V1ClientListSettlementsOkPayload
  - `settlements` union[], required
    - union
      - object
        - `transferDirection` 'send' | 'receive' | 'send-and-receive', required
        - `id` string, required — The unique identifier of the settlement. This is a UUID that uniquely identifies the settlement record.
        - `partnerId` string, required — The unique identifier of the partner the settlement is associated with. This is a UUID that uniquely identifies the partner.
        - `externalId` string, required — External identifier provided by the partner when creating the settlement.
        - `status` 'pending', required
        - `settlementType` 'onchain' | 'offchain', required
        - `reconciled` boolean, required — Whether or not the settlement is reconciled against trade data. Currently there are no reconciled settlements. This field is always false.
        - `initiatedBy` string, required — Id of the user which initiated the settlement.
        - `notes` string — The notes associated with the settlement. This is a free-form text field that can contain any additional information about the settlement.
        - `createdAt` string, date-time, required — The date and time when the settlement was created. This is a timestamp in ISO 8601 format.
        - `updatedAt` string, date-time, required — The date and time when the settlement was last updated. This is a timestamp in ISO 8601 format.
        - `rtId` string — Routed transaction id associated with the settlement. This is a UUID that uniquely identifies the routed transaction. This field is only populated for on-chain settlements for partners with automation enabled.
        - `lossSLAAlertSent` boolean, required — Whether or not an alert has been sent if loss settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `gainSLAAlertSent` boolean, required — Whether or not an alert has been sent if gain settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `cutoffAt` string, date-time — The date and time of the newest trade being settled in the partner system. This is a timestamp in ISO 8601 format. This field is only populated for dispute enabled partners.
        - `disputed` boolean — Whether or not a dispute was raised on this settlement.
      - object
        - `transferDirection` 'send' | 'receive' | 'send-and-receive', required
        - `id` string, required — The unique identifier of the settlement. This is a UUID that uniquely identifies the settlement record.
        - `partnerId` string, required — The unique identifier of the partner the settlement is associated with. This is a UUID that uniquely identifies the partner.
        - `externalId` string, required — External identifier provided by the partner when creating the settlement.
        - `reason` string, required
        - `status` 'failed', required
        - `settlementType` 'onchain' | 'offchain', required
        - `reconciled` boolean, required — Whether or not the settlement is reconciled against trade data. Currently there are no reconciled settlements. This field is always false.
        - `initiatedBy` string, required — Id of the user which initiated the settlement.
        - `notes` string — The notes associated with the settlement. This is a free-form text field that can contain any additional information about the settlement.
        - `createdAt` string, date-time, required — The date and time when the settlement was created. This is a timestamp in ISO 8601 format.
        - `updatedAt` string, date-time, required — The date and time when the settlement was last updated. This is a timestamp in ISO 8601 format.
        - `rtId` string — Routed transaction id associated with the settlement. This is a UUID that uniquely identifies the routed transaction. This field is only populated for on-chain settlements for partners with automation enabled.
        - `lossSLAAlertSent` boolean, required — Whether or not an alert has been sent if loss settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `gainSLAAlertSent` boolean, required — Whether or not an alert has been sent if gain settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `cutoffAt` string, date-time — The date and time of the newest trade being settled in the partner system. This is a timestamp in ISO 8601 format. This field is only populated for dispute enabled partners.
        - `disputed` boolean — Whether or not a dispute was raised on this settlement.
      - object
        - `transferDirection` 'send' | 'receive' | 'send-and-receive', required
        - `id` string, required — The unique identifier of the settlement. This is a UUID that uniquely identifies the settlement record.
        - `partnerId` string, required — The unique identifier of the partner the settlement is associated with. This is a UUID that uniquely identifies the partner.
        - `externalId` string, required — External identifier provided by the partner when creating the settlement.
        - `status` 'completed', required
        - `settlementType` 'onchain' | 'offchain', required
        - `reconciled` boolean, required — Whether or not the settlement is reconciled against trade data. Currently there are no reconciled settlements. This field is always false.
        - `initiatedBy` string, required — Id of the user which initiated the settlement.
        - `notes` string — The notes associated with the settlement. This is a free-form text field that can contain any additional information about the settlement.
        - `createdAt` string, date-time, required — The date and time when the settlement was created. This is a timestamp in ISO 8601 format.
        - `updatedAt` string, date-time, required — The date and time when the settlement was last updated. This is a timestamp in ISO 8601 format.
        - `finalizedAt` string, date-time, required
        - `rtId` string — Routed transaction id associated with the settlement. This is a UUID that uniquely identifies the routed transaction. This field is only populated for on-chain settlements for partners with automation enabled.
        - `lossSLAAlertSent` boolean, required — Whether or not an alert has been sent if loss settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `gainSLAAlertSent` boolean, required — Whether or not an alert has been sent if gain settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `cutoffAt` string, date-time — The date and time of the newest trade being settled in the partner system. This is a timestamp in ISO 8601 format. This field is only populated for dispute enabled partners.
        - `disputed` boolean — Whether or not a dispute was raised on this settlement.
      - object
        - `transferDirection` 'send' | 'receive' | 'send-and-receive', required
        - `id` string, required — The unique identifier of the settlement. This is a UUID that uniquely identifies the settlement record.
        - `partnerId` string, required — The unique identifier of the partner the settlement is associated with. This is a UUID that uniquely identifies the partner.
        - `externalId` string, required — External identifier provided by the partner when creating the settlement.
        - `reason` string, required
        - `status` 'rejected', required
        - `settlementType` 'onchain' | 'offchain', required
        - `reconciled` boolean, required — Whether or not the settlement is reconciled against trade data. Currently there are no reconciled settlements. This field is always false.
        - `initiatedBy` string, required — Id of the user which initiated the settlement.
        - `notes` string — The notes associated with the settlement. This is a free-form text field that can contain any additional information about the settlement.
        - `createdAt` string, date-time, required — The date and time when the settlement was created. This is a timestamp in ISO 8601 format.
        - `updatedAt` string, date-time, required — The date and time when the settlement was last updated. This is a timestamp in ISO 8601 format.
        - `finalizedAt` string, date-time, required
        - `rtId` string — Routed transaction id associated with the settlement. This is a UUID that uniquely identifies the routed transaction. This field is only populated for on-chain settlements for partners with automation enabled.
        - `lossSLAAlertSent` boolean, required — Whether or not an alert has been sent if loss settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `gainSLAAlertSent` boolean, required — Whether or not an alert has been sent if gain settlement SLA is close to being breached. Only relevant for on-chain settlements.
        - `cutoffAt` string, date-time — The date and time of the newest trade being settled in the partner system. This is a timestamp in ISO 8601 format. This field is only populated for dispute enabled partners.
        - `disputed` boolean — Whether or not a dispute was raised on this settlement.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)