API-Dokumentation
RateON Exchange API v1
Diese Dokumentation erklärt, wie der RateON-Wechselservice in eine Wallet, Monitoring-Plattform, Anwendung oder einen Partnerdienst integriert werden kann. Mit der API können Wechselrichtungen abgerufen, Beträge berechnet, Aufträge erstellt und deren Status verfolgt werden.
https://rateon.io/api/userapi/v1/{method}
Wechselrichtungen
Auftragserstellung
Statusverfolgung
Endpoint-Format
https://rateon.io/api/userapi/v1/{method}
Content type
Für Parameter im Request Body wird application/x-www-form-urlencoded empfohlen.
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 | Erforderlich | Beschreibung |
|---|---|---|
API-LOGIN | Ja | API-Login, der für Ihr Integrationskonto ausgestellt wurde. |
API-KEY | Ja | Privater API-Schlüssel, der für Ihr Integrationskonto ausgestellt wurde. |
API-LANG | Nein | Erzwungene Antwortsprache. Beispielwerte: en_US, ru_RU. |
Währungen und Richtungen laden
Rufen Sie get_direction_currencies und get_directions auf, um verfügbare Wechselpaare anzuzeigen.
Details zur Richtung abrufen
Rufen Sie get_direction auf, um Kurs, Reserve, Limits, Gebühren und Pflichtfelder zu erhalten.
Betrag berechnen
Rufen Sie get_calc direkt vor der Auftragserstellung auf, um die aktuellen Sende- und Empfangsbeträge zu berechnen.
Auftrag erstellen und verfolgen
Rufen Sie create_bid auf und verwenden Sie anschließend bid_info, get_exchanges oder Callbacks, um den Status zu verfolgen.
1. Paarauswahl aufbauen
Verwenden Sie get_direction_currencies und get_directions, um Währungen, Paare und direction_id zu erhalten.
2. Dynamische Felder anzeigen
Verwenden Sie get_direction, um erforderliche give_fields, get_fields und dir_fields darzustellen.
3. Vor dem Absenden berechnen
Verwenden Sie get_calc direkt vor der Auftragserstellung, um den aktuellen Betrag anzuzeigen und mögliche Änderungen zu erkennen.
4. Auftrag erstellen und IDs speichern
Verwenden Sie create_bid und speichern Sie die zurückgegebenen Werte id, hash, status sowie die Daten der Zahlungsaktion.
5. Status verfolgen
Verwenden Sie callback_url für Push-Benachrichtigungen und prüfen Sie den Status anschließend über bid_info oder get_exchanges.
6. API-Aktionen beachten
Rufen Sie pay_bid und cancel_bid nur auf, wenn die zurückgegebenen api_actions die Aktion über die API ausdrücklich erlauben.
| Methode | Zweck | Typische Verwendung |
|---|---|---|
test | Prüft den API-Zugang. | Zuerst verwenden, um Credentials und IP-Allowlist zu prüfen. |
get_direction_currencies | Gibt Währungen zurück, die für den Wechsel verfügbar sind. | Währungsselektoren erstellen. |
get_directions | Gibt verfügbare Wechselrichtungen zurück. | Liste der Paare erstellen und direction_id erhalten. |
get_direction | Gibt detaillierte Informationen zu einer Richtung zurück. | Kurse, Limits, Reserve und Pflichtfelder anzeigen. |
get_calc | Berechnet den Wechselbetrag. | Aktuellen Betrag vor der Auftragserstellung anzeigen. |
create_bid | Erstellt einen Wechselauftrag. | Finale Wechselanfrage absenden. |
bid_info | Gibt Zahlungsinformationen und Status eines über die API erstellten Auftrags zurück. | Prüfung per id oder hash. |
get_exchanges | Gibt Aufträge zurück, die mit dem aktuellen API-Schlüssel erstellt wurden. | Auftragshistorie anzeigen oder Status synchronisieren. |
pay_bid | Markiert einen Auftrag als bezahlt, wenn dies erlaubt ist. | Nur verwenden, wenn api_actions.pay = api. |
cancel_bid | Storniert einen Auftrag, wenn dies erlaubt ist. | Nur verwenden, wenn api_actions.cancel = api. |
Request-Parameter
Keine Pflichtparameter.
Optionale Parameter
currency_id_give, currency_id_get.
Antwort
Gibt verfügbare Währungen für die Sende- und Empfangsseite zurück. Verwenden Sie diese Methode, um Währungsselektoren zu erstellen.
Optionale Parameter
currency_id_give, currency_id_get.
Antwort
Jede Richtung enthält direction_id, IDs der Sende-/Empfangswährungen, Währungsnamen und Logos.
Pflichtparameter
direction_id — ID der Wechselrichtung.
Antwortfelder
Verwenden Sie Antwortfelder wie reserve, course_give, course_get, min_give, max_give, min_get, max_get, give_fields, get_fields und dir_fields.
Pflichtparameter
direction_id, calc_amount, calc_action.
calc_action-Werte
1 Sendebetrag, 2 Empfangsbetrag, 3 Sendebetrag inklusive Gebühr, 4 Empfangsbetrag inklusive Gebühr.
Antwortfelder
Verwenden Sie sum_give, sum_give_com, sum_get, sum_get_com, com_give, com_get, Limits und das Flag changed.
Hauptparameter
direction_id, calc_amount, calc_action, account1, account2, benutzerdefinierte Felder cf1–cf99.
Optionale Parameter
api_id, partner_id, callback_url. Verwenden Sie callback_url, wenn RateON Ihren Server bei einer Statusänderung des Auftrags benachrichtigen soll.
Antwortfelder
Speichern Sie die zurückgegebenen Werte id und hash. Verwenden Sie status, status_title, Betragsfelder, Zahlungsanweisungen und api_actions.
Parameter
Senden Sie entweder id oder hash. Verwenden Sie diese Methode nach Callback-Benachrichtigungen und wenn der Nutzer den Auftragsbildschirm öffnet.
Optionale Filter
start_time, end_time, ip, id, api_id, status_history, limit, offset.
api_actions.pay
Wenn der Wert api ist, kann die Wallet pay_bid aufrufen. Wenn ein Zahlungslink oder eine Zahlungsanweisung zurückgegeben wird, zeigen Sie diese dem Nutzer an.
api_actions.cancel
Wenn der Wert api ist, kann die Wallet cancel_bid aufrufen. Andernfalls ist eine Stornierung für diesen Auftrag möglicherweise nicht verfügbar.
api_actions, bevor Zahlungs- oder Stornobuttons angezeigt werden. Einige Aktionen können automatisch durch Merchant-Module verarbeitet werden oder für einen bestimmten Auftrag nicht verfügbar sein.Verwenden Sie Callbacks als Server-to-Server-Benachrichtigung darüber, dass sich ein Auftrag geändert haben kann. Die Wallet sollte den endgültigen Zustand immer über die API prüfen, bevor die Benutzeroberfläche aktualisiert wird.
Callbacks aktivieren
Übergeben Sie callback_url beim Aufruf von create_bid. Die URL muss über HTTPS erreichbar sein und POST-Anfragen von RateON empfangen können.
Callback-Daten empfangen
Der Callback-Payload kann je nach ausgewählter Richtung und Auftragsfeldern bid_id, account1, account2 und benutzerdefinierte Auftragsfelder cf1–cf99 enthalten.
Auftragsstatus prüfen
Rufen Sie nach Erhalt eines Callbacks bid_info mit der Auftrags-id oder dem hash auf. Wenn mehrere Aufträge synchronisiert werden müssen, verwenden Sie get_exchanges.
Wallet-Oberfläche aktualisieren
Aktualisieren Sie den Auftragsbildschirm erst nach der API-Prüfung. Dadurch werden falsche Statusänderungen verhindert, falls ein Callback verzögert, dupliziert oder erneut gesendet wird.
bid_info oder get_exchanges bestätigt werden.| Fehler | Mögliche Ursache | Empfohlene Aktion |
|---|---|---|
Api disabled | Falsche Credentials oder API-Zugang ist deaktiviert. | Prüfen Sie API-LOGIN, API-KEY, API-Zugang und IP-Allowlist. |
Empty response | Die angeforderten Daten wurden nicht gefunden oder Parameter sind falsch. | Prüfen Sie Pflichtparameter und IDs. |
No bid exists | Der angeforderte Auftrag existiert nicht. | Prüfen Sie Auftrags-id oder hash. |
Method not supported | Die ausgewählte API-Methode ist für diesen API-Schlüssel nicht aktiviert. | Fordern Sie Zugriff auf die erforderliche Methode an. |
Direction not found | Die angeforderte Wechselrichtung ist über die API nicht verfügbar. | Prüfen Sie die Verfügbarkeit der Richtung und die API-Berechtigungen. |
FAQ
get_calc unmittelbar vor create_bid aufzurufen, um den aktuellen Wechselbetrag zu berechnen.bid_info für einen einzelnen Auftrag, get_exchanges für die Auftragshistorie oder übergeben Sie callback_url bei der Auftragserstellung.Bereit für die Integration?
Senden Sie uns Ihren Anwendungsfall, die benötigten API-Methoden und die Server-IP-Adressen. Wir bereiten die Credentials vor und unterstützen beim ersten Testrequest.
Support kontaktieren