GET
/
api
/
orders
/
{id}
Get order
curl --request GET \
  --url https://app.sandbox.rio.trade/api/orders/{id} \
  --header 'x-api-key: <api-key>'
{
  "fees": {
    "processingFeeFiat": 0,
    "transferFeeFiat": 0.17584797034499297,
    "platformFeeFiat": 20
  },
  "destinationOfFunds": {
    "blockchainAddress": "TS9kqAVq4PR7xNoQDJXSP6Kgz8GFbwUbzi",
    "accountHolderName": "John Doe",
    "accountNumber": "1234567890",
    "CCI": "00111233001112345678",
    "CLABE": "014027000000000008"
  },
  "quoteId": "6660be85d6c964829d63fd05",
  "userId": "65a99abb6a92bda6e52bf7af",
  "status": "created",
  "crypto": "USDC",
  "side": "buy",
  "fiat": "USD",
  "createdAt": "2024-06-05T19:38:20.264Z",
  "country": "MX",
  "amountFiat": 1000,
  "amountCrypto": 55.54,
  "marketPrice": 0.0568673040717,
  "netPrice": 0.05554,
  "notes": "Description Pt.1",
  "payoutBankAccountId": "660c10c6eb4fbb235708b8e8",
  "expiredQuotes": [],
  "USBankTransferMethod": "ach_push",
  "cryptoAddress": "0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C",
  "id": "67811d310936d148349f5676",
  "payoutAddressId": "673b5cf6302b8444c78dd3d3",
  "attributes": [
    "fixedPrice"
  ],
  "payoutTransferLimit": 475000,
  "paymentsReceived": [
    {
      "amount": 100000,
      "accountHolderName": "John Doe",
      "accountNumber": "<string>",
      "CCI": "<string>",
      "CLABE": "<string>",
      "receivedAt": "2025-01-10T13:14:42.855Z",
      "blockchainAddress": "<string>",
      "blockchainTxId": "<string>"
    }
  ],
  "payoutsSent": [
    {
      "amount": 4748.36,
      "blockchainTxId": "0x66ECBd38905CC32249ddd6f4f0B4A3DdDDCbd608",
      "sentAt": "2025-01-10T13:14:48.240Z",
      "SPEITrackingNumber": "<string>",
      "CEPLink": "<string>",
      "reference": "<string>"
    }
  ],
  "paymentInstructions": {
    "dueDate": "2024-06-04T15:02:13.097Z",
    "bankName": "Bank Name",
    "companyName": "Company Name",
    "companyAddress": "Company Address",
    "bankAddress": "Sandbox Bank Address, 12345, Sandbox City, Sandbox Country",
    "accountNumber": "<string>",
    "routingNumber": "123456789",
    "reference": "9f5676",
    "CLABE": "01212345678901",
    "RUC": "<string>",
    "RFC": "RBL123456789",
    "CCI": "00111233001112345678",
    "blockchainAddress": "0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C"
  },
  "paymentReceivedAt": "2025-01-10T13:14:42.855Z",
  "invoice": {
    "PDFLink": "<string>",
    "XMLLink": "<string>"
  },
  "informationalFees": {
    "serviceFeeFiat": 0,
    "serviceFeeFiatTax": 0
  },
  "twoWaySettlementType": "default",
  "twoWaySettlementDateOffset": 1,
  "twoWaySettlementDate": "2024-06-04T15:02:13.097Z",
  "effectiveTwoWaySettlementDateOffset": 1,
  "type": "market",
  "limitNetPrice": 18.75,
  "timeInForceStartsAt": "2024-06-04T15:02:13.097Z",
  "timeInForceEndsAt": "2024-06-04T15:02:13.097Z",
  "parentOrderId": "6660beaccc4633bc6412318a"
}

​
Requirements to consume the endpoint.

User approved

The user must be approved in at least one country.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Id of the order to be obtained.

Response

OK

​
fees
object

Object containing detailed information about various fees

​
destinationOfFunds
object

Details about the destination of funds

​
quoteId
string

The unique identifier of the quote

Example:

"6660be85d6c964829d63fd05"

​
userId
string

The unique identifier of the user

Example:

"65a99abb6a92bda6e52bf7af"

​
status
enum<string>

The 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>

The type of cryptocurrency involved in the order

Available options:
USDC,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ
​
side
enum<string>

The side of the order

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

The type of fiat currency used

Available options:
USD,
MXN,
PEN
​
createdAt
string

The date and time the order was created

Example:

"2024-06-05T19:38:20.264Z"

​
country
enum<string>

The country of the user

Available options:
MX,
PE,
US
​
amountFiat
number

The amount in fiat currency

Example:

1000

​
amountCrypto
number

The amount in cryptocurrency

Example:

55.54

​
marketPrice
number

The price of the cryptocurrency

Example:

0.0568673040717

​
netPrice
number

The net price of the cryptocurrency

Example:

0.05554

​
notes
string

Any additional notes

Example:

"Description Pt.1"

​
payoutBankAccountId
string

The unique identifier of the bank account to which the payout will be sent

Example:

"660c10c6eb4fbb235708b8e8"

​
expiredQuotes
string[]

List of expired quotes

Example:
[]
​
USBankTransferMethod
enum<string>

Indicates bank transfer method, applies only to the United States.

Available options:
ach_push,
wire
​
cryptoAddress
string

The address of the cryptocurrency

Example:

"0xAf56edF88c429F1D6858f9E47731FF53F6d34D0C"

​
id
string

The ID of the order

Example:

"67811d310936d148349f5676"

​
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[]

Information of any payments that were received by Rio for the order

​
payoutsSent
object[]

Information of any payouts that were made by Rio for the order

​
paymentInstructions
object

Account information for the bank to which funds will be sent to in a buy order or the blockchain address the funds will be sent to in a sell order

​
paymentReceivedAt
string

The date and time the payment was received

Example:

"2025-01-10T13:14:42.855Z"

​
invoice
object

order invoice details, only applies to Mexican orders.

​
informationalFees
object

Informational fees for the order (does not affect quote)

​
twoWaySettlementType
enum<string>

The type of settlement for the order. default means that the order is settles regularly (usually this means upon receipt of the payment), while TPlusOffset means that the order is settled after a certain number of business days.

Available options:
default,
TPlusOffset
​
twoWaySettlementDateOffset
number

The number of business days until the order is settled. This is only applicable for if the twoWaySettlementType is TPlusOffset.

Example:

1

​
twoWaySettlementDate
string

The date on which the order is settled.

Example:

"2024-06-04T15:02:13.097Z"

​
effectiveTwoWaySettlementDateOffset
number

The number of billable days until the order is settled. This is only applicable for if the twoWaySettlementType is TPlusOffset.

Example:

1

​
type
enum<string>

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
​
limitNetPrice
number

The net price of the order. This is only applicable for if the order type is limit.

Example:

18.75

​
timeInForceStartsAt
string

The date and time from which the order is scheduled to be executed (optional).

Example:

"2024-06-04T15:02:13.097Z"

​
timeInForceEndsAt
string

The date and time until which the order is scheduled to be executed (optional).

Example:

"2024-06-04T15:02:13.097Z"

​
parentOrderId
string

The ID of the parent order. This is only applicable for if the order was spawned from a partial fill.

Example:

"6660beaccc4633bc6412318a"