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.

Request API access View methods Quick start

Base URL /api/userapi/v1/ https://rateon.io/api/userapi/v1/{method}

Request / response POST → JSON All parameters are sent in the request body. Responses are returned in JSON format.

Quick start

Send a POST request to the method endpoint and pass credentials in headers.

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"

Authentication

Each request must include API credentials in HTTP headers. API access is issued after approval and can be restricted by IP address and allowed methods.

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`.

Security: keep the API key on your server side only. Do not expose it in browser JavaScript or public mobile app code.

Recommended integration flow

The flow below is recommended for wallets, exchange widgets, monitoring platforms and partner applications.

Load currencies and directions

Call get_direction_currencies and get_directions to display available exchange pairs.

1

Get direction details

Call get_direction to receive rate, reserve, limits, commissions and required fields.

2

Calculate amount

Call get_calc immediately before order creation to calculate current give/receive amounts.

3

Create and track order

Call create_bid, then use bid_info, get_exchanges or callbacks to track status.

4

Methods overview

Main API methods used for exchange integrations.

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`.
`success_bid`	Marks an order as completed when enabled.	Use only if this action is enabled for your key.

Method reference

Open a method to view required parameters and response fields.

POSTtestTest method for checking API availability.⌄

Request parameters

No required parameters.

Response

Returns a response confirming that API key, login and access settings are valid.

POSTget_direction_currenciesReturns lists of currencies available for exchange.⌄

Request parameters

Parameter	Required	Description
`currency_id_give`	No	Filter by currency ID to give.
`currency_id_get`	No	Filter by currency ID to receive.

Response fields

Returns two lists: give and get. Each list item contains id, title and logo.

POSTget_directionsReturns exchange directions available through API.⌄

Request parameters

Parameter	Required	Description
`currency_id_give`	No	Filter by currency ID to give.
`currency_id_get`	No	Filter by currency ID to receive.

Response fields

Each item contains direction_id, give currency data and receive currency data.

POSTget_directionReturns full information about one exchange direction.⌄

Request parameters

Parameter	Required	Description
`direction_id`	Yes	ID of the exchange direction.

Response fields

Returns direction data: id, url, currency codes, reserve, rates, amounts, commissions and minimum/maximum limits.

Also returns informational texts and field groups: give_fields, get_fields, dir_fields. Field description can include name, type, label, req, tooltip, options and cd.

POSTget_calcCalculates exchange amounts for a selected direction.⌄

Request parameters

Parameter	Required	Description
`direction_id`	Yes	ID of the exchange direction.
`calc_amount`	Yes	Amount to calculate.
`calc_action`	Yes	`1` give amount, `2` receive amount, `3` give with commission, `4` receive with commission.
`cd`	No	Additional direction fields marked with `cd = 1`, URL-encoded in one field.

Example

curl -X POST "https://rateon.io/api/userapi/v1/get_calc" \
  -H "API-LOGIN: YOUR_API_LOGIN" \
  -H "API-KEY: YOUR_API_KEY" \
  -d "direction_id=123" \
  -d "calc_amount=1000" \
  -d "calc_action=1"

POSTcreate_bidCreates a new exchange order.⌄

Main parameters

Parameter	Required	Description
`direction_id`	Yes	ID of the exchange direction.
`calc_amount`	Yes	Exchange amount.
`calc_action`	Yes	Amount type: `1`, `2`, `3` or `4`.
`api_id`	No	Your internal order ID.
`partner_id`	No	Partner ID, if the order should be linked to a partner.
`callback_url`	No	URL that will receive POST updates when order status changes.
`account1`	Depends on direction	Sender account or wallet field.
`account2`	Depends on direction	Receiver account or wallet field.
`cf1`–`cf99`	Depends on direction	Custom fields required by the selected direction.

Important: required order fields depend on the selected direction. Always call get_direction first and use returned field groups to build the order form.

Response fields

Response contains order URL, id, hash, status, status title, currency data, amounts and api_actions such as payment, cancellation and instruction details.

POSTbid_infoReturns payment and status information for one order.⌄

Request parameters

Parameter	Required	Description
`id`	Required if `hash` is not sent	Order ID.
`hash`	Required if `id` is not sent	Order hash.

This method can be used only for orders created through API.

POSTget_exchangesReturns orders created by the current API key.⌄

Optional filters

start_time, end_time, ip, id, api_id, status_history, limit, offset.

Response fields

Response contains an items list with order ID, API ID, date, currencies, exchange rate, amounts, user hash, user IP, current status and optional status history.

POSTpay_bid / cancel_bid / success_bidOrder actions available only when enabled for the API key and order.⌄

Request parameter

hash — order hash.

Important

Use pay_bid only when api_actions.pay = api. Use cancel_bid only when api_actions.cancel = api. success_bid must be enabled for your API key.

Order statuses

Use these values when processing responses from create_bid, bid_info, get_exchanges and callbacks.

new

New order.

coldnew

Waiting for verification.

techpay

User opened payment page.

payed

Marked as paid by user.

coldpay

Waiting for merchant confirmation.

partpay

Partially paid.

realpay

Payment received.

verify

Order is under review.

success

Completed order.

cancel

Cancelled order.

error

Failed or incorrect order.

payouterror

Auto-payout error.

mercherror

Merchant error.

delete

Deleted order.

partpayout

Partial payout.

coldsuccess

Waiting for payout confirmation.

Callback notifications

When creating an order, pass callback_url to receive POST notifications when the order status changes.

How to enable

Send callback_url in the create_bid request. The URL must be publicly accessible over HTTPS.

How to confirm

After receiving a callback, call bid_info or get_exchanges to verify the current order status from RateON side.

Partner API methods

Optional methods for affiliate dashboards and partner statistics.

`get_partner_info`

Returns partner ID, balance, minimum payout amount and payout currencies.

`get_partner_links`

Returns partner traffic data: date, browser, IP, referrer, user hash and query string.

`get_partner_exchanges`

Returns partner exchange orders, amounts, statuses and partner reward information.

`get_partner_payouts` / `add_partner_payout`

Returns payout requests or creates a new payout request by payout method and account.

Error responses

Common API errors and what they usually mean.

Error	Possible reason	Recommended action
`Api disabled`	Incorrect credentials or API access is disabled.	Check `API-LOGIN`, `API-KEY`, API settings 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 exchange direction is not available through API.	Check direction availability and API permissions.

FAQ

Answers to common integration questions.

How do I get API credentials?

Contact RateON support and provide your company name, use case, required API methods and server IP addresses. Credentials are issued after approval.

Can API access be restricted by IP?

Yes. API access can be limited to approved server IP addresses for security.

Should I call get_calc before creating an order?

Yes. Call get_calc immediately before create_bid to calculate the latest available exchange amount.

How can I track order status?

Use bid_info for one order, get_exchanges for order history, or pass callback_url when creating an order.

Start API integration

Request API credentials, send us your server IP addresses and integrate RateON exchange into your product.

Contact support

API Documentation

RateON Exchange API v1

Exchange directions

Order creation

Status tracking

On this page

Quick start

Endpoint format

Content type

Authentication

Recommended integration flow

Load currencies and directions

Get direction details

Calculate amount

Create and track order

Methods overview

Method reference

Request parameters

Response

Request parameters

Response fields

Request parameters

Response fields

Request parameters

Response fields

Request parameters

Example

Main parameters

Response fields

Request parameters

Optional filters

Response fields

Request parameter

Important

Order statuses

Callback notifications

How to enable

How to confirm

Partner API methods

get_partner_info

get_partner_links

get_partner_exchanges

get_partner_payouts / add_partner_payout

Error responses

FAQ

Start API integration

`get_partner_info`

`get_partner_links`

`get_partner_exchanges`

`get_partner_payouts` / `add_partner_payout`