Orders

This module contains the complete set of endpoints required to create and manage a payment order, from checking rates to tracking its status.

Core Endpoints

Get Exchange Rates

Get a live list of all supported currencies and their indicative exchange rates.

Lock Rate

Lock a specific exchange rate for a short period to guarantee it for a transaction.

Place Order

Create a new order using a previously locked rate. This process is asynchronous.

Get Order Details

Check the current status and details of a previously created order.

Typical Workflow

A typical process for creating and handling an order consists of four steps.

1. Get current rates (Optional)

Use the Get Exchange Rates endpoint to display live, indicative rates to the user.

2. Lock a specific rate

When the user is ready to pay, call the Lock Rate endpoint. This guarantees the rate for a short period and returns a lockId required for the next step.

3. Place the order

Use the lockId to call the Place Order endpoint. The API will immediately respond with an orderId. Note: At this point, the payment wallet is being created asynchronously in the background.

4. Track the order's progress

After receiving the orderId, you have two ways to track its progress:

Listen for the webhook Order status (recommended) – it will be sent as soon as the wallet is ready.

Poll the Get Order Details endpoint until the order's status is no longer WAITING_FOR_WALLET_ADDRESS.

Core Endpoints#

Typical Workflow#

1. Get current rates (Optional)#

2. Lock a specific rate#