---
title: "Get the details of an order"
method: GET
path: "/orders/{order_uuid}"
tags: ["Orders"]
---

# Get the details of an order

`GET /orders/{order_uuid}`

Please note the following:

- If the amount paid is not exactly the input amount, we can be
  required to cancel the order, or the output amount will be adjusted
  and extra fees could be charged.
- If it is sent in multiple transactions, we can be required to cancel
  the order and extra processing fees could be charged.

### Minimal details

When the request does not include sufficient credentials, only minimal
information is returned. If you are unexpectedly receiving only minimal
details, please double check which security scheme you are using and
used to place the order. When no security scheme is used, please make
sure you are making all the requests to the correct URLs and that
cookies are accepted and handled according to RFC 6265. Most user
agents handle that for you but cookies must not be disabled and you may
have to request the user-agent to include credentials in the request.

The full information is returned when one of the following is true:

- No security scheme is used and the order was placed while
  unauthenticated, in the same session.
- The `bity_account_oauth` or `bity_account_oauth_client` security
  scheme are used, the scope includes
  `https://auth.bity.com/scopes/exchange.place` or
  `https://auth.bity.com/scopes/exchange.history`, and the OAuth client
  is the client having placed the order.
- The `bity_account_oauth` or `bity_account_oauth_client` security
  scheme are used and the scope includes
  `https://auth.bity.com/scopes/exchange.audit`.
- The `client_oauth` security scheme is used and the OAuth client is
  the client having placed the order.

### Output address signature

When the customer is not authenticated or has not gone through the KYC
process, crypto-to-crypto and fiat-to-crypto orders require the
signature of a message by the output address for the order to become
executable. When such a signature is required "message_to_sign" is
included in the response. The price will not be fixed and the payment
details will not be provided before the signature of the message is
submitted.

### Input and output objects

The input type and output type can be one of "crypto_address" or
"bank_account".

- In case it is "crypto_address" the object additionally contains
  "crypto_address".
- In case it is "bank_account" the object additionally contains "iban".

Whenever the input object contains iban or crypto_address, the input
must be paid from the corresponding object. If this is not the case, we
can be required to cancel the order and perform a refund uppon
reception of the funds and extra fees can be charged.

### Payment details

This object describes how to pay the input amount.

There are two different possible types of payment details:
`"crypto_address"` and `"bank_account"`. Both types are described
bellow. The amount and the associated currency is found in the input
object.

#### Crypto-address

When the payment must be made to a crypto-address, the `type` is
`"crypto_address"` and the address to use as a destination address
is found in the `"crypto_address"` attribute. If the payment details
contain a `"memo"`, the cryptocurrency transaction must include it.

#### Bank account

When the payment must be made to a bank account, the type is
`"bank_account"`.

In most cases the banks involved in sending, transmitting and receiving
the payment will require the IBAN, SWIFT code and the bank account
owner name and address to process the payment. This is reflected by the
information provided in the response:

- `"iban"`: The IBAN to which the payment must be made.
- `"owner"`: An object containing information about the owner of the
  bank account. It can contain the following properties: "name",
  "address", "address_complement", "zip", "city", "state", "country".
  The country is formatted as a two-letter country code.
- `"swift_bic"` The SWIFT code (also known as BIC) of the bank account
  at which the bank account is located.

### Amounts

When `timestamp_price_guaranteed` is not present or has elapsed, the
amounts (input, output and price breakdown) are an estimation of the
amounts that would have been used should the order have been executed
at the time the order details were retrieved.

When `timestamp_price_guaranteed` is present and has not elapsed, the
amounts correspond to the amounts that will be used provided that the
exact input amount is received before `timestamp_price_guaranteed`
elapses.

## Path parameters

- `order_uuid` string, required

## Response `200`

Order successfully retrieved.

- union
  - Order
    - `client_value` integer — An arbitrary integer provided by the API client. The property is shown in the order details and in the reporting API.
    - `id` string, required — Unique identifier of the order.
    - `input` OrderInput, required — unresolved $ref
    - `message_to_sign` MessageToSign — A message to be signed. The signature must be sent in the body of a POST request to the URL specified by `signature_submission_url`. This endpoint returns a 204 status code uppon submission of a valid signature. The message must be encoded as UTF-8 and the resulting sequence of bytes signed. Make sure to keep the message intact, including all white spaces. Use "eth_sign" with Ethereum addresses and "signmessage" with Bitcoin addresses. Keep the signature in the format provided by those calls (at the time of writing it is an hexadecimal string for Ethereum and base64 string for Bitcoin).
      - `body` string, required
      - `signature_submission_url` string, required
    - `output` OrderOutput, required — unresolved $ref
    - `payment_details` union
      - PaymentDetailsBankAccount — Payment details when the input type is `bank_account`. The bank account information details contained in this object must be used to perform a bank transfer to pay the order.
        - `account_number` string
        - `bank_address` string
        - `bank_code` string
        - `iban` string, required — IBAN of the bank account to which the order must be paid.
        - `recipient` string — Do not use, this property is present for backward compatibility. Use `recipient_name` and `recipient_postal_address` instead.
        - `recipient_name` string, required — Name of the recipient of the payment.
        - `recipient_postal_address` string[], required — Postal address of the recipient of the payment.
        - `reference` string — The reference (also known as communication or message to the recipient) that must be included in the bank transfer.
        - `swift_bic` string — BIC code of the bank account to which the order must be paid.
        - `type` 'bank_account', required
      - PaymentDetailsCryptoAddress — Payment details when the input type is `crypto_address`.
        - `crypto_address` string, required — Crypto-address to which to send the payment for the order.
        - `memo` string — When this property is present, the crypto-transaction paying the order must include this exact value as the memo.
        - `type` 'crypto_address', required
      - PaymentDetailsOnlineInstantPayment — Payment details when then input type is `online_instant_payment`.
        - `payment_ui_url` string, required
        - `type` 'online_instant_payment', required
    - `price_breakdown` PriceBreakdown, required
      - `customer_trading_fee` object — The customer trading fee applied to this order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `instant_payment_fee` object — The instant payment fee applied to this order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `non-verified_fee` object — The non-verified fee applied to this order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `output_transaction_cost` object — Execution cost of the output transaction. Includes crypto transaction fees, bank transaction fees, etc.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
      - `partner_fee` object — -> Additional fee perceived on behalf of the partner having placed the order.
        - `amount` string, required — Decimal number as a string
        - `currency` string, required
    - `purpose` OrderPurpose — Information about the purpose of the order.
      - `category` string — Non-exhaustive list of possible values: - `bill_payment`: The purpose of the order is to pay a bill.
      - `comment` string — Comment about the purpose of the order. Users can use this comment in order to remember what was their purpose when placing the order.
    - `timestamp_awaiting_payment_since` string, date-time — Date and time at which the order became executable and at which the payment information was made available.
    - `timestamp_cancelled` string, date-time — Date and time at which the order was cancelled.
    - `timestamp_created` string, date-time, required — Date and time at which the client submitted the initial information regarding this order.
    - `timestamp_executed` string, date-time — Date and time at which the output amount was sent.
    - `timestamp_payment_received` string, date-time — Date and time at which the input amount is confirmed to have been received.
    - `timestamp_price_guaranteed` string, date-time — When present, the price is locked until the current time exceeds that particular timestamp. If the payment of the appropriate input amount is received before the indicated time, then the currently shown output amount will be sent. If the payment is received at a later time, execution of the order will use the market price instead. When absent, indicates that the price has not been locked yet.
  - OrderMinimal — Minimal information of a previously placed order. This information can be retrieved without authentication.
    - `id` string, required — Unique identifier of the order.
    - `timestamp_awaiting_payment_since` string, date-time — Date and time at which the order became executable and at which the payment information was made available.
    - `timestamp_cancelled` string, date-time — Date and time at which the order was cancelled.
    - `timestamp_created` string, date-time, required — Date and time at which the client submitted the initial information regarding this order.
    - `timestamp_executed` string, date-time — Date and time at which the output amount was sent.
    - `timestamp_payment_received` string, date-time — Date and time at which the input amount is confirmed to have been received.
    - `timestamp_price_guaranteed` string, date-time — When present, the price is locked until the current time exceeds that particular timestamp. If the payment of the appropriate input amount is received before the indicated time, then the currently shown output amount will be sent. If the payment is received at a later time, execution of the order will use the market price instead. When absent, indicates that the price has not been locked yet.

## Other responses

- `400` — Order with such ID not found.
- `429` — Rate-limited (request ignored)

---

[API](https://skmtc.dev/bity/apis/bity-exchange-api.md) · [All operations](https://skmtc.dev/bity/apis/bity-exchange-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bity/bity-exchange-api/revisions/fd48443fbac2/schema)