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

# Get Client Settlement

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

This API call allows clients to get a list of settlement transactions for any connected network account,
for a specific settlement. The settlement and its metadata will be returned along with all
related settlement transfers in and out of the clients’ network accounts.

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

- 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 settlement cannot be found.
- Examples: Settlement ID doesn’t exist or the calling client isn’t involved in the settlement.

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

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

## Path parameters

- `enterpriseId` string, required
- `settlementId` string, required

## Query parameters

- `currencies` string[]
- `pageNumber` string, integer
- `pageSize` string

## Response `200`

OK

- V1ClientGetSettlementOkPayload
  - `settlement` union, required
    - V1PendingSettlementOutput
      - `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.
    - V1FailedSettlementOutput
      - `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.
    - V1CompleteSettlementOutput
      - `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.
    - V1RejectedSettlementOutput
      - `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.
  - `settlementTransfers` object[], required
    - `sourceTradingAccountId` string — The go account id of the source party.
    - `sourceNetworkAccountId` string — The network account id of the source party.
    - `destinationTradingAccountId` string — The go account id of the destination party.
    - `destinationNetworkAccountId` string — The network account id of the destination party (if the destination party is a connection).
    - `currency` string, required — The currency involved in the settlement movement.
    - `quantity` string, required
    - `txIds` string[], required
    - `status` 'pending' | 'pending_onchain' | 'onchain_initiated' | 'onchain_failed' | 'completed' | 'failed' | 'rejected' | 'disputed' | 'pending_settlement_assignment', required
    - `usdValue` union, required — The USD value of the settlement transfer in cents. This is a non-negative value represented as a string.
      - string, number
      - number
    - `settlementId` string, required — The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement.
    - `disputeClosureId` string — The unique identifier of the dispute closure the settlement transfer was created from. This is a UUID that uniquely identifies dispute closure if the transfer was created as a result of closing a dispute.
    - `id` string, required — The unique identifier of the settlement transfer. This is a UUID that uniquely identifies the settlement transfer record.
    - `createdAt` string, date-time, required — The date and time when the settlement transfer was created. Represented as an ISO 8601 formatted date string.
    - `updatedAt` string, date-time, required — The date and time when the settlement transfer was last updated. Represented as an ISO 8601 formatted date string.
    - `settlementStatus` 'failed' | 'completed' | 'pending' | 'rejected', required
    - `settlementNotes` string — Optional notes for the settlement
    - `sourceClientName` string — The client name of the source party. Will be obfuscated if the source party is not the calling client.
    - `destinationClientName` string — The client name of the destination party. Will be obfuscated if the destination party is not the calling client.
    - `sourceConnectionName` string — The name of the source connection (if the source party is a connection). Will be obfuscated if the source party is not the calling client.
    - `destinationConnectionName` string — The name of the destination connection (if the destination party is a connection). Will be obfuscated if the destination party is not the calling client.
  - `settlingDisputes` object[], required
    - `settledInSettlementId` string, required
    - `disputeClosureId` string, required
    - `disputeClosure` DisputeClosureOutput, required
      - `id` string, required — The unique identifier of the dispute closure.
      - `closedBy` 'client' | 'admin', required
      - `userId` string, required — The id of the user who closed the dispute.
      - `notes` string, required — notes entered by the user when closing the dispute.
      - `adjustedSettlementTransfers` object[], required
        - `id` string, required — The unique identifier of the settlement transfer.
        - `sourceTradingAccountId` string, required — The go account id of the source party.
        - `destinationTradingAccountId` string, required — The go account id of the destination party.
        - `destinationNetworkAccountId` string, required — The network account id of the destination party.
        - `disputeClosureId` string, required — The unique identifier of the dispute closure the settlement transfer was created from. This is a UUID that uniquely identifies dispute closure if the transfer was created as a result of closing a dispute.
        - `currency` string, required — The currency involved in the settlement movement.
        - `quantity` string, required
        - `status` 'pending' | 'pending_onchain' | 'onchain_initiated' | 'onchain_failed' | 'completed' | 'failed' | 'rejected' | 'disputed' | 'pending_settlement_assignment', required
        - `createdAt` string, date-time, required — The date and time when the settlement transfer was created. Represented as an ISO 8601 formatted date string.
        - `updatedAt` string, date-time, required — The date and time when the settlement transfer was last updated. Represented as an ISO 8601 formatted date string.
        - `settlementId` string — The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement. Will only be undefined if the settlement transfer is in `pending_settlement_assignment` status.
        - `sourceNetworkAccountId` string — The network account id of the source party.
      - `createdAt` string, date-time, required — The date and time when the dispute closure was created.
      - `status` 'pending_review' | 'approved' | 'rejected', required
      - `adjustedTransfers` ExpectedTransfers, required
      - `reviewedBy` string — The id of the admin who reviewed the dispute closure.
      - `reviewNotes` string — Any comments entered by the admin when reviewing the dispute closure.
    - `id` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `connectionId` string, required
    - `disputedSettlementId` string, required
    - `userId` string, required
    - `expectedTransfers` ExpectedTransfersOutput, required
    - `retracted` boolean, required
    - `reason` string
    - `retractedBy` string
    - `retractedAt` string, date-time
    - `retractedReason` string
  - `settlementDisputes` object[], required
    - `disputeClosure` DisputeClosureOutput
      - `id` string, required — The unique identifier of the dispute closure.
      - `closedBy` 'client' | 'admin', required
      - `userId` string, required — The id of the user who closed the dispute.
      - `notes` string, required — notes entered by the user when closing the dispute.
      - `adjustedSettlementTransfers` object[], required
        - `id` string, required — The unique identifier of the settlement transfer.
        - `sourceTradingAccountId` string, required — The go account id of the source party.
        - `destinationTradingAccountId` string, required — The go account id of the destination party.
        - `destinationNetworkAccountId` string, required — The network account id of the destination party.
        - `disputeClosureId` string, required — The unique identifier of the dispute closure the settlement transfer was created from. This is a UUID that uniquely identifies dispute closure if the transfer was created as a result of closing a dispute.
        - `currency` string, required — The currency involved in the settlement movement.
        - `quantity` string, required
        - `status` 'pending' | 'pending_onchain' | 'onchain_initiated' | 'onchain_failed' | 'completed' | 'failed' | 'rejected' | 'disputed' | 'pending_settlement_assignment', required
        - `createdAt` string, date-time, required — The date and time when the settlement transfer was created. Represented as an ISO 8601 formatted date string.
        - `updatedAt` string, date-time, required — The date and time when the settlement transfer was last updated. Represented as an ISO 8601 formatted date string.
        - `settlementId` string — The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement. Will only be undefined if the settlement transfer is in `pending_settlement_assignment` status.
        - `sourceNetworkAccountId` string — The network account id of the source party.
      - `createdAt` string, date-time, required — The date and time when the dispute closure was created.
      - `status` 'pending_review' | 'approved' | 'rejected', required
      - `adjustedTransfers` ExpectedTransfers, required
      - `reviewedBy` string — The id of the admin who reviewed the dispute closure.
      - `reviewNotes` string — Any comments entered by the admin when reviewing the dispute closure.
    - `id` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `connectionId` string, required
    - `disputedSettlementId` string, required
    - `userId` string, required
    - `expectedTransfers` ExpectedTransfersOutput, required
    - `retracted` boolean, required
    - `settledInSettlementId` string
    - `reason` string
    - `retractedBy` string
    - `retractedAt` string, date-time
    - `disputeClosureId` string
    - `retractedReason` string

## 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)