Requirements to start the flow.
API key
Have an API key (Tutorial here).
Order flow
The process of placing a T+n order is very similar to the process of placing a regular order, but with the addition of a few steps. In this guide, we will go through the process of placing a T+1 buy order.Disclaimer: Settlement does not imply custody or receipt of funds before
the order is executed on the date specified in the settlement details.
1
Register the deposit crypto address
Before creating an order, you need to register the crypto address that will receive the funds. This only needs to be done once per address-currency pair, so you can skip this step if the address is already registered.Send the wallet address in the
address field and the currency it is for in the crypto field. Keep the id from the response, since that is what you pass as userAddressId when creating the order.Go to create a new crypto address
2
Create a quote
When creating a T+n order, you need to specify the number of days until the order is settled. This is done by setting the Keep in mind that banking hours and holidays may cause the effective settlement date to be different than what you expected. Please always confirm the
twoWaySettlementType body parameter of the request to TPlusOffset and the twoWaySettlementDateOffset parameter to the number of business days until the order is settled.
For example, if you want to place a T+0 buy order, you need to set the twoWaySettlementDateOffset field to 0. If you want to place a T+1 buy order, you need to set the twoWaySettlementDateOffset field to 1, etc.A T+1 buy order of USDC with MXN looks like this:twoWaySettlementDate field of the quote to get the effective settlement date and make sure it matches your expectation before creating an order. The effectiveTwoWaySettlementDateOffset field tells you how many billable days that works out to, which can differ from the offset you asked for.Quotes expire. The expiresAt field is the date and time after which the quote can no longer be used to create an order, and the window is short, so read that field rather than assuming a fixed duration.Go to create quote endpoint
Learn more about how quotes work
3
Create order
Once you are satisfied with a quote, you can create an order for the quoted amount. Pass the quote through the
quoteId field and the crypto address that should receive the funds through the userAddressId field. The quote must not have expired.Go to create order
4
Wait for the order to be ready to accept payment.
Poll the order or subscribe to our webhooks. Wait for the order to have a status of
awaitingPayment. After this, you have until the payment due date, specified in the dueDate field of the order’s paymentInstructions object, to pay for the order.Go to check order status
5
Pay for the order (skip if placing the order in our sandbox environment)
Please send the amount specified in the
amountFiat field of the order object to the bank account specified in the paymentInstructions field of the order. Do not forget to send the reference.The payment instructions are part of the order itself, so there is no separate endpoint to call. Get the order and read its paymentInstructions field, which holds bankName, companyName, accountNumber, the reference you must include with the transfer, and the country specific identifiers that apply, such as CLABE in Mexico or CCI in Peru. A transfer that arrives without the reference cannot be matched to your order.6
Confirm payment (optional)
This final step is only necessary if the payment is made in USD, or if the order was placed in our sandbox environment and you want to simulate a successful payment. Everywhere else Rio detects the incoming transfer on its own.
Go to confirm payment
7
Wait for funds
Rio will send the funds to your wallet in the next few minutes. The order ends up in
complete, and you can see the details of the transfer in its payoutsSent field.Poll order status or subscribe to webhooks
Go to check order status
Go to register a webhook
Subscribe to
orders webhooks to get order updates pushed to you instead of
polling.Settlement dates beyond T+4: any offset up to T+4 is available by default.
Going further out is a separate permission, so please contact support to
enable it for your account or for your broker’s account if you trade under
one.
Disclaimer: All technical documentation is subject to the terms and
conditions, which apply supplementarily and take precedence over the
documentation.