Skip to main content
DELETE
/
v1
/
orders
/
{order_id}
/
Cancel Order
curl --request DELETE \
  --url https://sandbox.api.rime.finance/v1/orders/{order_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "side": "BUY",
  "market": "PRIMARY",
  "status": "CANCELLED",
  "amount_of_units": 100000,
  "value": 100000,
  "currency": "EUR",
  "isin": "NL1111111111",
  "account_id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2024-01-15T10:30:00Z",
  "settlement_transaction_hash": null,
  "payment_transaction_reference": null,
  "custom_offering_id": null
}

Authorizations

​
Authorization
string
header
required

Bearer access token. Provide as a Authorization: Bearer <token> header.

Path Parameters

​
order_id
string<uuid>
required

Response

200 - application/json

Order cancelled successfully

​
side
enum<string>
required

Whether the order is a buy or a sell order.

Available options:
BUY,
SELL
​
market
enum<string>
required

The market the order is executed on.

On the primary market, buy orders can be executed when the fund's subcribable flag is set to true. Sell orders on the primary market are only excepted when the fund's redeemable flag is set to true.

On the secondary market, both buy and sell orders can be executed when the fund's tradeable flag is set to true.

Available options:
PRIMARY,
SECONDARY
​
amount_of_units
integer
required

Number of units of the share class in the order.

​
value
integer
required

Positive integer representing the order value in the smallest unit of the currency, in cents.

​
currency
string
required

Three-letter ISO currency code, in uppercase.

Example:

"EUR"

​
isin
string
required

ISIN code of the share class being ordered.

​
payment_transaction_reference
string | null

Reference of the payment transaction associated with this order, if available.

​
sender_payment_method_details
object | null

Payment sender details used in the order.

​
recipient_payment_method_details
object | null

Payment recipient details used in the order.

​
recipient_wallet_address
string | null

Wallet address of the recipient (visible for buy orders).

⌘I