Sign in

v1

latestOpenAPI 3.0.3Bity2026-08-06148380.1 KB
Orders

Place an order

It is possible to specify amount in the input or output in which case the corresponding input or output amount will be computed.

The input or output amount can be estimated beforehand using the dedicated endpoint, see "Estimate the amount of an order".

The input object must in principle contain the IBAN or crypto-address which will be used to pay the order. In some cases, this is optional. See "Estimate the amount of an order" to figure out if this information can be omitted or not. Omitting the information increases the number of situations were we can be required to cancel an order uppon reception of the funds. To ensure a reliable execution of your order, the crypto-address or IBAN must be provided and the paiment must be made from the provided object.

post/orders

Request body

client_valueinteger

An arbitrary integer provided by the API client. The property is shown in the order details and in the reporting API.

Example request

{
  "input": {
    "currency": "BTC",
    "owner": {
      "country": "CH"
    }
  },
  "output": {
    "currency": "BTC",
    "owner": {
      "country": "CH"
    },
    "ultimate_debtor": {
      "country": "CH"
    }
  }
}

Response

The order has been successfully created.

The Location header contains the URI (which can be relative) at which the order status and details can be retrieved. That is the Location header is meant to be interpreted as per RFC 7231 section 7.1.2.