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

# List client settlement transfers

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

Lists all settlement transfers for your OES client account.

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

## Path parameters

- `enterpriseId` string, required

## Query parameters

- `pageNumber` string, integer
- `pageSize` string
- `currencies` string[]
- `initiatedBy` string[]
- `partnerIds` string[]
- `settlementIds` string[]
- `settlementStatuses` string[]
- `settlementTransferStatuses` string[]
- `settlementUpdatedBefore` string, date-time
- `settlementUpdatedOnOrAfter` string, date-time
- `sortField` 'updatedAt'
- `sortDirection` 'ASC' | 'DESC'

## Response `200`

OK

- V1ClientGetSettlementTransfersOkPayload
  - `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.

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