Documentación API
RateON Exchange API v1
Esta documentación explica cómo integrar el servicio de intercambio RateON en una wallet, plataforma de monitoreo, aplicación o servicio asociado. La API permite obtener direcciones de intercambio, calcular importes, crear órdenes y seguir sus estados.
https://rateon.io/api/userapi/v1/{method}
Direcciones de intercambio
Creación de órdenes
Seguimiento de estado
Formato del endpoint
https://rateon.io/api/userapi/v1/{method}
Content type
Para los parámetros en el cuerpo de la solicitud se recomienda usar application/x-www-form-urlencoded.
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 | Obligatorio | Descripción |
|---|---|---|
API-LOGIN | Sí | API login emitido para tu cuenta de integración. |
API-KEY | Sí | Clave API privada emitida para tu cuenta de integración. |
API-LANG | No | Idioma forzado de la respuesta. Ejemplos: en_US, ru_RU. |
Cargar monedas y direcciones
Llama a get_direction_currencies y get_directions para mostrar los pares de intercambio disponibles.
Obtener detalles de la dirección
Llama a get_direction para obtener el tipo de cambio, reserva, límites, comisiones y campos obligatorios.
Calcular el importe
Llama a get_calc justo antes de crear la orden para calcular los importes actuales de envío y recepción.
Crear y seguir la orden
Llama a create_bid, luego usa bid_info, get_exchanges o callbacks para seguir el estado.
1. Crear selección de par
Usa get_direction_currencies y get_directions para obtener monedas, pares y direction_id.
2. Mostrar campos dinámicos
Usa get_direction para mostrar los campos obligatorios give_fields, get_fields y dir_fields.
3. Calcular antes de enviar
Usa get_calc justo antes de crear la orden para mostrar el importe actual y detectar posibles cambios.
4. Crear orden y guardar ID
Usa create_bid y guarda los valores devueltos id, hash, status y los datos de la acción de pago.
5. Seguir el estado
Usa callback_url para notificaciones push y después verifica el estado mediante bid_info o get_exchanges.
6. Respetar las acciones API
Llama a pay_bid y cancel_bid solo si el valor devuelto en api_actions permite explícitamente la acción vía API.
| Método | Propósito | Uso típico |
|---|---|---|
test | Verifica el acceso API. | Úsalo primero para comprobar credentials y la IP allowlist. |
get_direction_currencies | Devuelve las monedas disponibles para intercambio. | Construir selectores de monedas. |
get_directions | Devuelve las direcciones de intercambio disponibles. | Construir la lista de pares y obtener direction_id. |
get_direction | Devuelve información detallada sobre una dirección. | Mostrar tipo de cambio, límites, reserva y campos obligatorios. |
get_calc | Calcula el importe del intercambio. | Mostrar el importe actual antes de crear la orden. |
create_bid | Crea una orden de intercambio. | Enviar la solicitud final de intercambio. |
bid_info | Devuelve información de pago y estado de una orden creada mediante API. | Comprobar por id o hash. |
get_exchanges | Devuelve órdenes creadas por la clave API actual. | Mostrar historial de órdenes o sincronizar estados. |
pay_bid | Marca una orden como pagada si está permitido. | Usar solo si api_actions.pay = api. |
cancel_bid | Cancela una orden si está permitido. | Usar solo si api_actions.cancel = api. |
Parámetros de solicitud
No hay parámetros obligatorios.
Parámetros opcionales
currency_id_give, currency_id_get.
Respuesta
Devuelve las monedas disponibles para el lado de envío y recepción. Usa este método para construir selectores de monedas.
Parámetros opcionales
currency_id_give, currency_id_get.
Respuesta
Cada dirección incluye direction_id, ID de monedas de envío/recepción, nombres de monedas y logotipos.
Parámetro obligatorio
direction_id — ID de la dirección de intercambio.
Campos de respuesta
Usa campos de respuesta como reserve, course_give, course_get, min_give, max_give, min_get, max_get, give_fields, get_fields y dir_fields.
Parámetros obligatorios
direction_id, calc_amount, calc_action.
Valores de calc_action
1 importe de envío, 2 importe de recepción, 3 importe de envío con comisión, 4 importe de recepción con comisión.
Campos de respuesta
Usa sum_give, sum_give_com, sum_get, sum_get_com, com_give, com_get, límites y el flag changed.
Parámetros principales
direction_id, calc_amount, calc_action, account1, account2, campos personalizados cf1–cf99.
Parámetros opcionales
api_id, partner_id, callback_url. Usa callback_url si quieres que RateON notifique a tu servidor cuando cambie el estado de la orden.
Campos de respuesta
Guarda los valores devueltos id y hash. Usa status, status_title, campos de importe, instrucción de pago y api_actions.
Parámetros
Envía id o hash. Usa este método después de callback notifications y cuando el usuario abra la pantalla de la orden.
Filtros opcionales
start_time, end_time, ip, id, api_id, status_history, limit, offset.
api_actions.pay
Si el valor es api, la wallet puede llamar a pay_bid. Si se devuelve un enlace o instrucción de pago, muéstralo al usuario.
api_actions.cancel
Si el valor es api, la wallet puede llamar a cancel_bid. De lo contrario, la cancelación puede no estar disponible para esta orden.
api_actions. Algunas acciones pueden ser procesadas automáticamente por merchant modules o no estar disponibles para una orden específica.Usa callbacks como notificación server-to-server de que una orden puede haber cambiado. La wallet siempre debe verificar el estado final mediante la API antes de actualizar la interfaz del usuario.
Activar callbacks
Envía callback_url al llamar a create_bid. La URL debe estar disponible por HTTPS y poder recibir solicitudes POST de RateON.
Recibir datos de callback
El callback payload puede incluir bid_id, account1, account2 y campos personalizados de la orden cf1–cf99, según la dirección seleccionada y los campos de la orden.
Verificar el estado de la orden
Después de recibir un callback, llama a bid_info usando el id o hash de la orden. Si necesitas sincronizar varias órdenes, usa get_exchanges.
Actualizar la interfaz de la wallet
Actualiza la pantalla de la orden solo después de verificarla mediante API. Esto evita cambios de estado incorrectos si el callback se retrasa, se duplica o se reintenta.
bid_info o get_exchanges.| Error | Posible causa | Acción recomendada |
|---|---|---|
Api disabled | Credentials incorrectas o acceso API desactivado. | Comprueba API-LOGIN, API-KEY, acceso API e IP allowlist. |
Empty response | Los datos solicitados no se encontraron o los parámetros son incorrectos. | Comprueba los parámetros obligatorios e ID. |
No bid exists | La orden solicitada no existe. | Comprueba el id o hash de la orden. |
Method not supported | El método API seleccionado no está habilitado para esta clave API. | Solicita acceso al método requerido. |
Direction not found | La dirección de intercambio solicitada no está disponible mediante API. | Comprueba la disponibilidad de la dirección y los permisos API. |
FAQ
get_calc justo antes de create_bid para calcular el importe de intercambio actual.bid_info para una orden, get_exchanges para el historial de órdenes o envía callback_url al crear una orden.¿Listo para la integración?
Envía tu caso de uso, los métodos API necesarios y las IP de tus servidores. Prepararemos las credentials y ayudaremos con la primera solicitud de prueba.
Contactar con soporte