Skip to main content
POST
/
v1
/
orders
Create Order
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"
}'
{
  "side": "BUY",
  "market": "PRIMARY",
  "amount_of_units": 100000,
  "value": 100000,
  "currency": "EUR",
  "isin": "NL1111111111",
  "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.

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 orders require wallet addresses for settlement. Claimable orders settle 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
object | null

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

​
recipient_payment_method_details
object | null

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

​
sender_wallet_address
string | null

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

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
recipient_wallet_address
string | null

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

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

​
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