POST
/
api
/
orders
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",
  "wireMessage": "Message"
}'
{
  "quoteId": "60d5ec9af682fbd39a1fa614",
  "userId": "65a99abb6a92bda6e52bf7af",
  "status": "created",
  "crypto": "USDC",
  "destinationOfFunds": {
    "blockchainAddress": "TS9kqAVq4PR7xNoQDJXSP6Kgz8GFbwUbzi",
    "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,
    "brokerFeeFiat": 0,
    "brokerFeeFiatTax": 0,
    "platformFeeFiat": 20,
    "platformFeeFiatTax": 3.2
  },
  "price": 0.055452766725000005,
  "notes": "Note",
  "expiredQuotes": [
    "<string>"
  ],
  "id": "665f4313b96e4fb76f5a1403",
  "payoutAddressId": "673b5cf6302b8444c78dd3d3",
  "attributes": [
    "fixedPrice"
  ],
  "payoutTransferLimit": 475000,
  "paymentsReceived": [],
  "payoutsSent": []
}

​
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

​
x-api-key
string
header
required

Body

application/json
​
quoteId
string
required

Id of the quote to be associated with this order.

Example:

"60d5ec9af682fbd39a1fa614"

​
notes
string

An optional description to be added to the order for your future reference.

Example:

"Note"

​
payoutBankAccountId
string

Required for sell orders. This is the ID of the bank account where the funds will be deposited.

Example:

"60d5ec9af663fbd39a1fa523"

​
userAddressId
string

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"

​
wireMessage
string

Only for sell orders in the US. This is an optional wire message that can be sent with the payout wire transfer.

Example:

"Message"

Response

201
application/json
Created
​
quoteId
string

Unique identifier of the associated quote

Example:

"60d5ec9af682fbd39a1fa614"

​
userId
string

Unique identifier of the user who created the order

Example:

"65a99abb6a92bda6e52bf7af"

​
status
enum<string>

Current status of the order

Available options:
created,
cancelled,
processing,
sourcingLiquidity,
cryptoAddressAdded,
liquiditySourced,
awaitingBankPayoutDetails,
awaitingBinanceSettlement,
binanceSettlementFailed,
incorrectBinanceSettlement,
depositRegistered,
depositConfirmed,
paymentOriginMismatch,
paid,
filled,
refundInitiated,
addressCheckPassed,
depositAddressCreated,
complete,
failedPayment,
bankPayoutDetailsAdded,
awaitingPayment,
awaitingOriginOrderCompletion,
awaitingTransferReissue,
awaitingPayout,
awaitingAsyncPayout,
awaitingAsyncPayment,
awaitingBridgeRouting,
failedFill,
failedTransfer,
failedQuote,
failedProcessorRouting,
failedLiquidityRouting,
failedFees,
incorrectAmountPaid,
insufficientLiquidityFailed,
depositAddressFailed,
addressCheckFailed,
refundFailed,
refundComplete,
bridgeOrderCreationFailed,
bridgeOrderRoutingFailed,
bridgeTransferFailed,
depositAmountMismatchFailed,
failedUnknown,
expired
​
crypto
enum<string>

Type of cryptocurrency involved in the order

Available options:
USDC,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ
​
destinationOfFunds
object

Details about the destination of funds

​
side
enum<string>

Indicates whether the order is a buy or sell order

Available options:
buy,
sell
​
fiat
enum<string>

Type of fiat currency used in the order

Available options:
USD,
MXN,
PEN
​
createdAt
string

Timestamp indicating when the order was created

Example:

"2024-06-04T16:38:43.994Z"

​
cryptoAddress
string

Cryptocurrency address associated with the order

Example:

"0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C"

​
country
enum<string>

Country of residence of the user who created the order

Available options:
MX,
PE,
US
​
amountFiat
number

Amount of fiat currency involved in the order

Example:

1000

​
amountCrypto
number

Amount of cryptocurrency involved in the order

Example:

54.16

​
fees
object

Details about the fees

​
price
number

The price of the cryptocurrency

Example:

0.055452766725000005

​
notes
string

Any additional notes

Example:

"Note"

​
expiredQuotes
string[]

List of expired quotes

​
id
string

The ID of the order

Example:

"665f4313b96e4fb76f5a1403"

​
payoutAddressId
string

The unique identifier of the payout address

Example:

"673b5cf6302b8444c78dd3d3"

​
attributes
string[]

List of attributes associated with the order

Example:
["fixedPrice"]
​
payoutTransferLimit
number

The limit for payout transfer

Example:

475000

​
paymentsReceived
object[]

List of payments received

Example:
[]
​
payoutsSent
object[]

List of payouts sent

Example:
[]