Skip to main content
Execute sell orders to liquidate asset positions from your customers’ portfolios.

​
Getting Started

This guide walks you through creating sell orders using the Rime API. You’ll make your first successful API call to place a sell order and understand how to help your customers redeem their asset holdings.

​
Prerequisites

Before creating sell orders, ensure you have:
  1. Authentication token - Follow our authentication guide to get your access token
  2. Customer account - The account_id for the account that the sell order is placed for
  3. Existing holdings - The provided account must own shares of the asset that should be sold

​
Order Structure

Sell orders are structured with the following key attributes: Required parameters:
  • Order side (side) - Set to SELL for liquidation orders
  • Market type (market) - PRIMARY for redemptions, SECONDARY for trading
  • Amount of units (amount_of_units) - Number of share units to sell
  • Currency (currency) - Currency for the transaction (only EUR is currently supported)
  • Share class (isin) - The ISIN code of the asset to sell from
  • Account ID (account_id) - Your customer’s account

​
Step-by-Step Implementation

​
Step 1: Create a sell order

Place a sell order for your customer to liquidate fund shares: 
curl -X POST "https://sandbox.api.rime.finance/v1/orders" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "side": "SELL",
    "market": "PRIMARY",
    "amount_of_units": 50000,
    "currency": "EUR",
    "isin": "${ISIN}",
    "account_id": "${ACCOUNT_ID}"
  }'

​
Step 2: Handle the response

A successful sell order creation returns a 201 Created status with the order details:
201
{
  "side": "SELL",
  "market": "PRIMARY",
  "amount_of_units": 50000,
  "value": 50000,
  "currency": "EUR",
  "isin": "NL1111111111",
  "settlement_transaction_hash": null,
  "payment_transaction_reference": null,
  "custom_offering_id": null
}

Order Processing

Sell orders start with “PLACED” status and progress through processing stages. Monitor order status to track completion.

​
Troubleshooting

Cause: Invalid isin or share class doesn’t existSolution: Verify the isin is correct and the fund allows redemptions
{
  "detail": "Share class not found"
}
Cause: Customer doesn’t own enough shares to fulfill the sell orderSolution: Verify your customer has sufficient holdings in the fund or reduce the order value
{
  "detail": "Insufficient holdings for sell order"
}
Cause: Customer’s shares are locked and cannot be sold until the lock period expiresSolution: Check the locked_until date in the portfolio and wait until shares are unlocked
{
  "detail": "Holdings are locked until 2024-12-31"
}
Cause: Missing required fields or invalid data typesSolution: Check all required parameters are provided with correct data types
{
  "detail": [
    {
      "loc": ["body", "value"],
      "msg": "ensure this value is greater than 0",
      "type": "value_error.number.not_gt"
    }
  ]
}

​
Next Steps

After creating sell orders for your customers:
  1. Get portfolio information - View the updated portfolio after liquidation
  2. Buy shares - Help customers reinvest in different funds
  3. Retrieve fund information - Research alternative investment options
⌘I