---
title: "Get swap order"
method: GET
path: "/v0/swap-orders/{id}"
tags: ["Swap orders"]
---

# Get swap order

`GET /v0/swap-orders/{id}`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/swap-orders/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/swap-orders/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

**Retrieve information about a specific swap order.**

- Includes order status (`created` / `executed` / `canceled`).
- Once `executed`, `settlement` carries both sides: the amount, share quantity and applied NAV that left the source share class and that entered the target one, plus the applied exchange rate for a cross-currency swap.

## Path parameters

- `id` string, uuid, required: a Universally Unique Identifier

## Response `200`

Success

- union
  - object
    - `id` string, uuid, required: a Universally Unique Identifier
    - `investorId` string, uuid, required: a Universally Unique Identifier
    - `accountId` string, uuid, required: a Universally Unique Identifier
    - `fromShareClassId` string, uuid, required: a Universally Unique Identifier
    - `toShareClassId` string, uuid, required: a Universally Unique Identifier
    - `quantity` union, required
      - object
        - `mode` 'amount', required
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
      - object
        - `mode` 'shares', required
        - `shares` string, required
      - object
        - `mode` 'total', required
    - `createdAt` string, required
    - `status` 'created', required
  - object
    - `id` string, uuid, required: a Universally Unique Identifier
    - `investorId` string, uuid, required: a Universally Unique Identifier
    - `accountId` string, uuid, required: a Universally Unique Identifier
    - `fromShareClassId` string, uuid, required: a Universally Unique Identifier
    - `toShareClassId` string, uuid, required: a Universally Unique Identifier
    - `quantity` union, required
      - object
        - `mode` 'amount', required
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
      - object
        - `mode` 'shares', required
        - `shares` string, required
      - object
        - `mode` 'total', required
    - `createdAt` string, required
    - `status` 'executed', required
    - `executedAt` string, required
    - `settlement` object, required
      - `source` object, required
        - `shareClassId` string, uuid, required: a Universally Unique Identifier
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
        - `sharesAmount` string, required
        - `appliedNAV` object, required
          - `day` string, required: a day in ISO format "YYYY-MM-DD"
          - `amount` NonNegativeAmount, required
            - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
            - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
      - `target` object, required
        - `shareClassId` string, uuid, required: a Universally Unique Identifier
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
        - `sharesAmount` string, required
        - `appliedNAV` object, required
          - `day` string, required: a day in ISO format "YYYY-MM-DD"
          - `amount` NonNegativeAmount, required
            - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
            - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
      - `exchangeRate` object, nullable, required
        - `fundId` string, uuid, required: a Universally Unique Identifier
        - `day` string, required: a day in ISO format "YYYY-MM-DD"
        - `baseCurrency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
        - `quoteCurrency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
        - `fxRate` string, required
  - object
    - `id` string, uuid, required: a Universally Unique Identifier
    - `investorId` string, uuid, required: a Universally Unique Identifier
    - `accountId` string, uuid, required: a Universally Unique Identifier
    - `fromShareClassId` string, uuid, required: a Universally Unique Identifier
    - `toShareClassId` string, uuid, required: a Universally Unique Identifier
    - `quantity` union, required
      - object
        - `mode` 'amount', required
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
      - object
        - `mode` 'shares', required
        - `shares` string, required
      - object
        - `mode` 'total', required
    - `createdAt` string, required
    - `status` 'canceled', required
    - `canceledAt` string, required
    - `canceledBy` 'admin' | 'distributor' | 'investor' | 'system', required

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `404`: NotFound
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/ad85137fd00b?raw)