Create order
curl --request POST \
--url https://app.sandbox.rio.trade/api/orders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"quoteId": "60d5ec9af682fbd39a1fa614",
"notes": "Note",
"payoutBankAccountId": "60d5ec9af663fbd39a1fa523",
"userAddressId": "50d5ec9af663fbd39a1fa629",
"clientReferenceId": "03d5ec9af663fbd39a1fa"
}
'import requests
url = "https://app.sandbox.rio.trade/api/orders"
payload = {
"quoteId": "60d5ec9af682fbd39a1fa614",
"notes": "Note",
"payoutBankAccountId": "60d5ec9af663fbd39a1fa523",
"userAddressId": "50d5ec9af663fbd39a1fa629",
"clientReferenceId": "03d5ec9af663fbd39a1fa"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quoteId: '60d5ec9af682fbd39a1fa614',
notes: 'Note',
payoutBankAccountId: '60d5ec9af663fbd39a1fa523',
userAddressId: '50d5ec9af663fbd39a1fa629',
clientReferenceId: '03d5ec9af663fbd39a1fa'
})
};
fetch('https://app.sandbox.rio.trade/api/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sandbox.rio.trade/api/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quoteId' => '60d5ec9af682fbd39a1fa614',
'notes' => 'Note',
'payoutBankAccountId' => '60d5ec9af663fbd39a1fa523',
'userAddressId' => '50d5ec9af663fbd39a1fa629',
'clientReferenceId' => '03d5ec9af663fbd39a1fa'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sandbox.rio.trade/api/orders"
payload := strings.NewReader("{\n \"quoteId\": \"60d5ec9af682fbd39a1fa614\",\n \"notes\": \"Note\",\n \"payoutBankAccountId\": \"60d5ec9af663fbd39a1fa523\",\n \"userAddressId\": \"50d5ec9af663fbd39a1fa629\",\n \"clientReferenceId\": \"03d5ec9af663fbd39a1fa\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sandbox.rio.trade/api/orders")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quoteId\": \"60d5ec9af682fbd39a1fa614\",\n \"notes\": \"Note\",\n \"payoutBankAccountId\": \"60d5ec9af663fbd39a1fa523\",\n \"userAddressId\": \"50d5ec9af663fbd39a1fa629\",\n \"clientReferenceId\": \"03d5ec9af663fbd39a1fa\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sandbox.rio.trade/api/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quoteId\": \"60d5ec9af682fbd39a1fa614\",\n \"notes\": \"Note\",\n \"payoutBankAccountId\": \"60d5ec9af663fbd39a1fa523\",\n \"userAddressId\": \"50d5ec9af663fbd39a1fa629\",\n \"clientReferenceId\": \"03d5ec9af663fbd39a1fa\"\n}"
response = http.request(request)
puts response.read_body{
"quoteId": "60d5ec9af682fbd39a1fa614",
"userId": "65a99abb6a92bda6e52bf7af",
"status": "awaitingTimeInForceToStart",
"crypto": "USDC",
"destinationOfFunds": {
"blockchainAddress": "TS9kqAVq4PR7xNoQDJXSP6Kgz8GFbwUbzi",
"blockchainMemo": "1234567890",
"accountHolderName": "John Doe",
"accountNumber": "1234567890",
"CCI": "00111233001112345678",
"CLABE": "014027000000000008"
},
"side": "buy",
"fiat": "USD",
"createdAt": "2024-06-04T16:38:43.994Z",
"cryptoAddress": "0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C",
"country": "MX",
"amountFiat": 1000,
"amountCrypto": 54.16,
"fees": {
"processingFeeFiat": 0,
"transferFeeFiat": 0.1803336531356813,
"platformFeeFiat": 20
},
"marketPrice": 0.055452766725000005,
"notes": "Note",
"expiredQuotes": [
"<string>"
],
"id": "665f4313b96e4fb76f5a1403",
"payoutAddressId": "673b5cf6302b8444c78dd3d3",
"attributes": [
"fixedPrice"
],
"payoutTransferLimit": 475000,
"paymentsReceived": [],
"payoutsSent": [],
"type": "market",
"parentOrderId": "6660beaccc4633bc6412318a",
"limitNetPrice": 0.0555,
"timeInForceStartsAt": "2024-06-04T15:02:13.097Z",
"timeInForceEndsAt": "2024-06-04T15:02:13.097Z",
"twoWaySettlementDate": "2024-06-04T15:02:13.097Z",
"effectiveTwoWaySettlementDateOffset": 1,
"informationalFees": {
"serviceFeeFiat": 0,
"serviceFeeFiatTax": 0
}
}{
"errors": [
{
"code": 19,
"message": "Not authorized"
}
]
}Orders API
Create order
POST
/
api
/
orders
Create order
curl --request POST \
--url https://app.sandbox.rio.trade/api/orders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"quoteId": "60d5ec9af682fbd39a1fa614",
"notes": "Note",
"payoutBankAccountId": "60d5ec9af663fbd39a1fa523",
"userAddressId": "50d5ec9af663fbd39a1fa629",
"clientReferenceId": "03d5ec9af663fbd39a1fa"
}
'import requests
url = "https://app.sandbox.rio.trade/api/orders"
payload = {
"quoteId": "60d5ec9af682fbd39a1fa614",
"notes": "Note",
"payoutBankAccountId": "60d5ec9af663fbd39a1fa523",
"userAddressId": "50d5ec9af663fbd39a1fa629",
"clientReferenceId": "03d5ec9af663fbd39a1fa"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quoteId: '60d5ec9af682fbd39a1fa614',
notes: 'Note',
payoutBankAccountId: '60d5ec9af663fbd39a1fa523',
userAddressId: '50d5ec9af663fbd39a1fa629',
clientReferenceId: '03d5ec9af663fbd39a1fa'
})
};
fetch('https://app.sandbox.rio.trade/api/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sandbox.rio.trade/api/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quoteId' => '60d5ec9af682fbd39a1fa614',
'notes' => 'Note',
'payoutBankAccountId' => '60d5ec9af663fbd39a1fa523',
'userAddressId' => '50d5ec9af663fbd39a1fa629',
'clientReferenceId' => '03d5ec9af663fbd39a1fa'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sandbox.rio.trade/api/orders"
payload := strings.NewReader("{\n \"quoteId\": \"60d5ec9af682fbd39a1fa614\",\n \"notes\": \"Note\",\n \"payoutBankAccountId\": \"60d5ec9af663fbd39a1fa523\",\n \"userAddressId\": \"50d5ec9af663fbd39a1fa629\",\n \"clientReferenceId\": \"03d5ec9af663fbd39a1fa\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sandbox.rio.trade/api/orders")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quoteId\": \"60d5ec9af682fbd39a1fa614\",\n \"notes\": \"Note\",\n \"payoutBankAccountId\": \"60d5ec9af663fbd39a1fa523\",\n \"userAddressId\": \"50d5ec9af663fbd39a1fa629\",\n \"clientReferenceId\": \"03d5ec9af663fbd39a1fa\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sandbox.rio.trade/api/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quoteId\": \"60d5ec9af682fbd39a1fa614\",\n \"notes\": \"Note\",\n \"payoutBankAccountId\": \"60d5ec9af663fbd39a1fa523\",\n \"userAddressId\": \"50d5ec9af663fbd39a1fa629\",\n \"clientReferenceId\": \"03d5ec9af663fbd39a1fa\"\n}"
response = http.request(request)
puts response.read_body{
"quoteId": "60d5ec9af682fbd39a1fa614",
"userId": "65a99abb6a92bda6e52bf7af",
"status": "awaitingTimeInForceToStart",
"crypto": "USDC",
"destinationOfFunds": {
"blockchainAddress": "TS9kqAVq4PR7xNoQDJXSP6Kgz8GFbwUbzi",
"blockchainMemo": "1234567890",
"accountHolderName": "John Doe",
"accountNumber": "1234567890",
"CCI": "00111233001112345678",
"CLABE": "014027000000000008"
},
"side": "buy",
"fiat": "USD",
"createdAt": "2024-06-04T16:38:43.994Z",
"cryptoAddress": "0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C",
"country": "MX",
"amountFiat": 1000,
"amountCrypto": 54.16,
"fees": {
"processingFeeFiat": 0,
"transferFeeFiat": 0.1803336531356813,
"platformFeeFiat": 20
},
"marketPrice": 0.055452766725000005,
"notes": "Note",
"expiredQuotes": [
"<string>"
],
"id": "665f4313b96e4fb76f5a1403",
"payoutAddressId": "673b5cf6302b8444c78dd3d3",
"attributes": [
"fixedPrice"
],
"payoutTransferLimit": 475000,
"paymentsReceived": [],
"payoutsSent": [],
"type": "market",
"parentOrderId": "6660beaccc4633bc6412318a",
"limitNetPrice": 0.0555,
"timeInForceStartsAt": "2024-06-04T15:02:13.097Z",
"timeInForceEndsAt": "2024-06-04T15:02:13.097Z",
"twoWaySettlementDate": "2024-06-04T15:02:13.097Z",
"effectiveTwoWaySettlementDateOffset": 1,
"informationalFees": {
"serviceFeeFiat": 0,
"serviceFeeFiatTax": 0
}
}{
"errors": [
{
"code": 19,
"message": "Not authorized"
}
]
}v1 (legacy). This page documents the API before the v2 update. The v1
format is not enabled for new accounts and must be enabled on your account by
your account manager. New integrations should use the
current documentation. To update an existing integration,
follow the migration guide.
Requirements to consume the endpoint.
Create and modify role
The user must have the role to create and modify.
User approved
The user must be approved in at least one country.
Authorizations
Body
application/json
Id of the quote to be associated with this order.
Example:
"60d5ec9af682fbd39a1fa614"
An optional description to be added to the order for your future reference.
Example:
"Note"
Required for sell orders. This is the ID of the bank account where the funds will be deposited.
Example:
"60d5ec9af663fbd39a1fa523"
Required for buy orders. It is the ID of the address to which we will send the funds. For US sell orders, it is the address from which you will send the funds.
Example:
"50d5ec9af663fbd39a1fa629"
Your own unique reference identifier for tracking this order in your system.
Maximum string length:
100Example:
"03d5ec9af663fbd39a1fa"
Response
Created
Unique identifier of the associated quote
Example:
"60d5ec9af682fbd39a1fa614"
Unique identifier of the user who created the order
Example:
"65a99abb6a92bda6e52bf7af"
Current status of the order. These are the statuses an order moves through on a normal flow, and which ones it sees depends on whether it is a buy or a sell and on whether payment is deferred. Other statuses can appear depending on the circumstances of the order.
Available options:
awaitingTimeInForceToStart, awaitingLimitPriceCondition, timeInForceEnded, created, addressCheckPassed, awaitingPayment, processing, paid, incorrectAmountPaid, sourcingLiquidity, liquiditySourced, filled, complete, depositAddressCreated, awaitingBankPayoutDetails, bankPayoutDetailsAdded, depositConfirmed, awaitingPayout, bankPaymentDetailsAdded, awaitingAsyncPayment, awaitingAsyncPayout, cancelled, expired Type of cryptocurrency involved in the order
Available options:
USDC, USDC_POLYGON_NXTB, SOL_USDC_PTHX, XLM_USDC_5F3T, USDC_BASECHAIN_ETH_5I5C, USDCE_TEMPO_MXYR, USDT_POLYGON, USDT_ERC20, TRX_USDT_S2UZ, USDT_BSC, SOL_USDT_EWAY, EUROC_ETH_F5NG, EURC_SOL, EURC_B609K9QB_Y213 Details about the destination of funds
Show child attributes
Show child attributes
Indicates whether the order is a buy or sell order
Available options:
buy, sell Type of fiat currency used in the order
Available options:
USD, MXN, PEN, COP Timestamp indicating when the order was created
Example:
"2024-06-04T16:38:43.994Z"
Cryptocurrency address associated with the order
Example:
"0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C"
Country of residence of the user who created the order
Available options:
MX, PE, CO Amount of fiat currency involved in the order
Example:
1000
Amount of cryptocurrency involved in the order
Example:
54.16
Details about the fees
Show child attributes
Show child attributes
The price of the cryptocurrency
Example:
0.055452766725000005
Any additional notes
Example:
"Note"
List of expired quotes
The ID of the order
Example:
"665f4313b96e4fb76f5a1403"
The unique identifier of the payout address
Example:
"673b5cf6302b8444c78dd3d3"
List of attributes associated with the order
Example:
["fixedPrice"]
The limit for payout transfer
Example:
475000
List of payments received
Show child attributes
Show child attributes
Example:
[]
List of payouts sent
Show child attributes
Show child attributes
Example:
[]
The type of order. market means that the order is executed at the current market price, while limit means that the order is executed at a specified limit net price.
Available options:
market, limit The ID of the parent order. This is only applicable for if the order was spawned from a partial fill.
Example:
"6660beaccc4633bc6412318a"
Limit price for limit orders, expressed like netPrice as units of what you receive per unit of what you pay (crypto per fiat on a buy, fiat per crypto on a sell). Only applicable when orderType is limit.
Example:
0.0555
The date and time from which the order is scheduled to be executed (optional).
Example:
"2024-06-04T15:02:13.097Z"
The date and time until which the order is scheduled to be executed (optional).
Example:
"2024-06-04T15:02:13.097Z"
The date on which the order is settled.
Example:
"2024-06-04T15:02:13.097Z"
The number of billable days until the order is settled. This is only applicable for if the twoWaySettlementType is TPlusOffset.
Example:
1
Informational fees for the order (does not affect quote)
Show child attributes
Show child attributes