API Documentation
RateON Exchange API v1
This documentation explains how to integrate RateON exchange into a wallet, monitoring platform, application or partner service. Use the API to get exchange directions, calculate amounts, create orders and track statuses.
https://rateon.io/api/userapi/v1/{method}
Exchange directions
Order creation
Status tracking
Endpoint format
https://rateon.io/api/userapi/v1/{method}
Content type
application/x-www-form-urlencoded is recommended for request body parameters.
curl -X POST "https://rateon.io/api/userapi/v1/test" \
-H "API-LOGIN: YOUR_API_LOGIN" \
-H "API-KEY: YOUR_API_KEY" \
-H "API-LANG: en_US"| Header | Required | Description |
|---|---|---|
API-LOGIN | Yes | API login issued for your integration account. |
API-KEY | Yes | Private API key issued for your integration account. |
API-LANG | No | Forced response language. Example values: en_US, ru_RU. |
Load currencies and directions
Call get_direction_currencies and get_directions to display available exchange pairs.
Get direction details
Call get_direction to receive rate, reserve, limits, commissions and required fields.
Calculate amount
Call get_calc immediately before order creation to calculate current give/receive amounts.
Create and track order
Call create_bid, then use bid_info, get_exchanges or callbacks to track status.
1. Build pair selection
Use get_direction_currencies and get_directions to get currencies, pairs and direction_id.
2. Render dynamic fields
Use get_direction to render required give_fields, get_fields and dir_fields.
3. Calculate before submit
Use get_calc right before order creation to show the latest amount and detect possible amount changes.
4. Create order and save IDs
Use create_bid and store returned id, hash, status and payment action data.
5. Track status
Use callback_url for push updates, then verify the status with bid_info or get_exchanges.
6. Respect API actions
Call pay_bid and cancel_bid only when returned api_actions explicitly allows API action.
| Method | Purpose | Typical use |
|---|---|---|
test | Checks API access. | Use first to verify credentials and IP allowlist. |
get_direction_currencies | Returns currencies available for exchange. | Build currency selectors. |
get_directions | Returns available exchange directions. | Build pair list and get direction_id. |
get_direction | Returns detailed information about a direction. | Show rates, limits, reserve and required fields. |
get_calc | Calculates exchange amount. | Show current amount before order creation. |
create_bid | Creates an exchange order. | Submit the final exchange request. |
bid_info | Returns payment and status information for one API-created order. | Check by id or hash. |
get_exchanges | Returns orders created by the current API key. | Show order history or sync statuses. |
pay_bid | Marks an order as paid when allowed. | Use only when api_actions.pay = api. |
cancel_bid | Cancels an order when allowed. | Use only when api_actions.cancel = api. |
Request parameters
No required parameters.
Optional parameters
currency_id_give, currency_id_get.
Response
Returns available currencies for give and receive sides. Use this method to build currency selectors.
Optional parameters
currency_id_give, currency_id_get.
Response
Each direction includes direction_id, give/get currency IDs, currency titles and logos.
Required parameter
direction_id — ID of the exchange direction.
Response fields
Use response fields such as reserve, course_give, course_get, min_give, max_give, min_get, max_get, give_fields, get_fields and dir_fields.
Required parameters
direction_id, calc_amount, calc_action.
calc_action values
1 give amount, 2 receive amount, 3 give amount with commission, 4 receive amount with commission.
Response fields
Use sum_give, sum_give_com, sum_get, sum_get_com, com_give, com_get, limits and changed flag.
Main parameters
direction_id, calc_amount, calc_action, account1, account2, custom fields cf1–cf99.
Optional parameters
api_id, partner_id, callback_url. Use callback_url if you want RateON to notify your server when the order status changes.
Response fields
Store returned id and hash. Use status, status_title, amount fields, payment instruction and api_actions.
Parameters
Send either id or hash. Use this method after callbacks and when the user opens the order screen.
Optional filters
start_time, end_time, ip, id, api_id, status_history, limit, offset.
api_actions.pay
If value is api, the wallet may call pay_bid. If a payment link or instruction is returned, show it to the user.
api_actions.cancel
If value is api, the wallet may call cancel_bid. Otherwise cancellation may not be available for this order.
api_actions. Some actions may be handled automatically by merchant modules or may not be available for a specific order.Use callbacks as a server-to-server notification that an order may have changed. The wallet should always verify the final state through the API before updating the user interface.
Enable callbacks
Pass callback_url when calling create_bid. The URL must be available over HTTPS and able to receive POST requests from RateON.
Receive callback data
The callback payload may include bid_id, account1, account2 and custom order fields cf1–cf99, depending on the selected direction and order fields.
Verify order status
After receiving a callback, call bid_info using the order id or hash. If you need to sync multiple orders, use get_exchanges.
Update wallet UI
Update the order screen only after API verification. This prevents incorrect status changes if the callback is delayed, duplicated or retried.
bid_info or get_exchanges.| Error | Possible reason | Recommended action |
|---|---|---|
Api disabled | Incorrect credentials or API access is disabled. | Check API-LOGIN, API-KEY, API access and IP allowlist. |
Empty response | Requested data was not found or parameters are incorrect. | Check required parameters and IDs. |
No bid exists | The requested order does not exist. | Check order id or hash. |
Method not supported | The selected API method is not enabled for this API key. | Request access to the required method. |
Direction not found | The requested exchange direction is not available through API. | Check direction availability and API permissions. |
FAQ
get_calc immediately before create_bid to calculate the latest available exchange amount.bid_info for one order, get_exchanges for order history, or pass callback_url when creating an order.Ready to integrate?
Send your use case, required API methods and server IP addresses. We will prepare credentials and help with the first test request.
Contact support