---
title: "Get a settlement by ID"
method: GET
path: "/atlas/settlements/{settlementId}"
tags: ["Atlas Settlement Network"]
---

# Get a settlement by ID

`GET /atlas/settlements/{settlementId}`

Permissions required: **Read vault activity**


Get a single settlement by its ID.

## Path parameters

- `settlementId` string, required

## Response `200`

settlement

- SNSettlementResponse
  - `settlement` SNSettlement, required — A settlement is a proposal to move assets between wallets owned by two participants. When the settlement status is `ActionNeeded`, refer to your participant's settlement side (`proposerSide` or `acceptorSide`) for more detailed information. Fields on the settlement side reflect the individual actions needed.
    - `acceptorSide` SNSettlementSide, required
      - `authorized` boolean — This can be null if authorization is not required or if the caller doesn't have access to this information.
      - `feesFunded` boolean — This can be null if the caller doesn't have access to this information. Fees funded status is based on the same fee logic as transfers and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet. If the primary amount and fee amount are the of same asset, the primary amount is also taken into account when calculating this.
      - `funded` boolean — This can be null if the caller doesn't have access to this information. The funded status does not include fees and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet.
      - `gasStationEnabled` boolean — Indicates the Gas Station is enabled to cover fees for this participant. This can be null if the caller doesn't have access to this information.
      - `participantId` string, required
      - `walletAmounts` SNWalletAmount[]
        - `assetType` string, required — A string representing a type of crypto-asset, which usually corresponds to the crypto asset's ticker symbol. Use `/asset-types` to list all of the supported asset types for your organization.
        - `quantity` string, required — The numeric value of this amount, excluding units. Use positive numbers for receiving and negative for sending assets. Amounts never include fees.
        - `walletId` string
    - `clientReferenceId` string, required — An ID, set by the proposer, visible to both sides, to uniquely identify the purpose of the settlement so that both sides can account for it correctly.
    - `pendingAcceptorReview` boolean, required — a flag indicating whether the settlement is awaiting acceptor selection
    - `proposerSide` SNSettlementSide, required
      - `authorized` boolean — This can be null if authorization is not required or if the caller doesn't have access to this information.
      - `feesFunded` boolean — This can be null if the caller doesn't have access to this information. Fees funded status is based on the same fee logic as transfers and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet. If the primary amount and fee amount are the of same asset, the primary amount is also taken into account when calculating this.
      - `funded` boolean — This can be null if the caller doesn't have access to this information. The funded status does not include fees and is checked independently of any other settlements. It takes into account only the current available balance for the relevant wallet.
      - `gasStationEnabled` boolean — Indicates the Gas Station is enabled to cover fees for this participant. This can be null if the caller doesn't have access to this information.
      - `participantId` string, required
      - `walletAmounts` SNWalletAmount[]
        - `assetType` string, required — A string representing a type of crypto-asset, which usually corresponds to the crypto asset's ticker symbol. Use `/asset-types` to list all of the supported asset types for your organization.
        - `quantity` string, required — The numeric value of this amount, excluding units. Use positive numbers for receiving and negative for sending assets. Amounts never include fees.
        - `walletId` string
    - `settlementId` string, required
    - `state` 'ActionNeeded' | 'CounterpartyActionNeeded' | 'Executing' | 'TimedOut' | 'Rejected' | 'Executed' | 'Failed', required

## Other responses

- `401` — Unauthenticated
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/anchorage/apis/anchorage-digital-api-reference.md) · [All operations](https://skmtc.net/anchorage/apis/anchorage-digital-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/anchorage/anchorage-digital-api-reference/versions/166864b1ec6d/schema)