Create Order

Creates a new order.

An order can either be on the buy or sell side depending on the intent. The acceptance of an order creation depends on the asset’s conditions (e.g. if it’s subscribable).

After the order is created, the primary payment method details of both recipient and sender are automatically attached to the order process.

POST /v1/orders

Create Order

cURL

curl --request POST \
  --url https://sandbox.api.rime.finance/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "side": "BUY",
  "market": "PRIMARY",
  "amount_of_units": 2,
  "currency": "<string>",
  "settlement_type": "bearer",
  "isin": "NL1111111111",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

201

buy_order

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "side": "BUY",
  "market": "PRIMARY",
  "status": "PLACED",
  "created_at": "2024-01-15T10:30:00Z",
  "amount": 100000,
  "amount_of_units": 100000,
  "currency": "EUR",
  "gross_value": 100000,
  "net_amount": 99500,
  "subscription_fee_amount": 500,
  "subscription_fee": 50,
  "fee_source": "DEFAULT",
  "fund_details": {
    "isin": "NL1111111111",
    "name": "AltAccess JP Morgan Multi-Alternatives Fund"
  },
  "payment_details": {
    "bank_account_name": "AltAccess Fund Services B.V.",
    "iban": "NL91ABNA0417164300",
    "payment_reference": "ORD-550e8400"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

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 share units to purchase or sell. The total monetary value is calculated automatically based on current NAV.

Required range: x >= 1

currency · string · required

Currency the order should be purchased for or sold in. Must be a valid three-letter ISO currency code, in uppercase. Only EUR is currently supported.

settlement_type · enum<string> · default: bearer · required

Type of order settlement.

• Bearer: Shares are delivered as digital tokens to a blockchain wallet. A registered wallet is required as a prerequisite.
• Claimable: Shares are held in custody on behalf of the investor. No wallet is needed — settlement is handled through traditional payment methods only.

Available options: bearer, claimable

isin · string<string> · required

ISIN code of the share class being ordered for purchase or sale.

All share classes of a fund can be retrieved from the List Funds endpoint.

Example:

"NL1111111111"

account_id · string<uuid> · required

ID of the account placing the order.

sender_payment_method_details · OrderPaymentMethodDetails · object

Payment sender details. Optional when primary payment method is configured for buy orders.

Show child attributes

recipient_payment_method_details · OrderPaymentMethodDetails · object

Payment recipient details. Optional when primary payment method is configured for sell orders.

Show child attributes

sender_wallet_address · string | null

Ethereum wallet address of the sender for sell orders. Optional when primary wallet is configured.

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x1234567890abcdef1234567890abcdef12345678"

recipient_wallet_address · string | null

Ethereum wallet address for recipient for buy orders. Optional when primary wallet is configured.

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0xabcdef1234567890abcdef1234567890abcdef12"

custom_offering_id · string<uuid> | null

Custom offering ID that must be related to the provided ISIN

Response

201 - application/json

Order created successfully

id · string<uuid> · required

Unique identifier for the created order.

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

status · enum<string> · required

Status the order is currently in. This status is updated by the system depending on the order's lifecycle state.

Buy order flow: PLACED → AWAITING_PAYMENT → PAYMENT_RECEIVED → EXECUTED → DELIVERY_INITIATED → DELIVERY_COMPLETED → COMPLETED

Sell order flow: PLACED → REDEMPTION_GATED (if locked) → EXECUTED → PAYMENT_SENT → PAYMENT_COMPLETED → COMPLETED

Orders can be CANCELLED from non-terminal states.

Available options: PLACED, AWAITING_PAYMENT, PAYMENT_RECEIVED, DELIVERY_INITIATED, DELIVERY_COMPLETED, PAYMENT_SENT, PAYMENT_COMPLETED, REDEMPTION_GATED, EXECUTED, COMPLETED, CANCELLED

created_at · string<date-time> · required

Timestamp when the order was created.

amount · integer · required

Amount of money invested in micro-units (1 EUR = 10,000 units).

Example:

100000

amount_of_units · integer · required

Number of units of the share class in the order.

currency · string · required

Three-letter ISO currency code, in uppercase.

Example:

"EUR"

fund_details · OrderFundDetails · object · required

Show child attributes

subscription_fee_amount · integer | null

Absolute fee amount charged in micro-units.

subscription_fee · integer | null

Fee rate in integer rate units (100% = 10,000; e.g., 0.5% = 50).

fee_source · enum<string> | null

Source of the applied fee rate — either the default share class fee or a custom offering.

Available options: DEFAULT, OFFERING

net_amount · integer | null

Net investment amount after fees, in micro-units.

gross_value · integer | null

Gross investment value before fees, in micro-units.

payment_details · OrderPaymentDetails · object

Payment details associated with this order, including bank account name, IBAN, and payment reference.

Show child attributes