Anwendungsszenarien

1) Integration einer Exchange auf der Website

Ziel

eine Tauschmaske mit Auswahl von Währungen/Netzwerken, Adressprüfung und Auftragserstellung zur Website hinzufügen.

Endpoints

• v2: POST /api/v2/instruments/public/validate-address, POST /api/v2/instruments/public/one, GET /api/v2/instruments/public, POST /api/v2/orders/public/create, POST /api/v2/orders/public/set-email
• v1 (zusätzlich bei Bedarf für Status/Schaufenster): GET /api/v1/instruments/public, GET /api/v1/instruments/public/one, POST /api/v1/instruments/public/validate-address

Ablauf

1. Das Verzeichnis aktiver Instrumente (Währung + Netzwerk) laden, um die Listen „Gebe/Erhalte“ aufzubauen.
2. Nach Auswahl durch den Nutzer Details zum „Erhalte“-Instrument anfordern (Genauigkeit, Memo/Tag, Limits).
3. Die Zieladresse über validate-address validieren.
4. Auftrag erstellen: POST /api/v2/orders/public/create (v2 empfohlen). orderId speichern und dem Nutzer die depositAddress anzeigen.
5. (Optional) E-Mail zum Auftrag hinzufügen: POST /api/v2/orders/public/set-email — für Benachrichtigungen an den Nutzer.
6. Eine Seite mit Zahlungsanweisungen an die depositAddress und einem Timer anzeigen.

2) Abrufen und Anzeigen von Kursen

Ziel

dem Nutzer aktuelle Kurse für das ausgewählte Paar anzeigen.

Endpoints

• v1: GET /api/v1/rates/public/one — öffentlicher Kurs als JSON.

Ablauf

1. Bei Auswahl eines Paares durch den Nutzer den öffentlichen Kurs über rates/public/one anfordern.
2. Den Kurs, minimale/maximale Beträge (falls zurückgegeben) sowie den Aktualitätszeitpunkt anzeigen.
3. (Optional) einen visuellen „Markup“ für den Schaufensterkurs anwenden (siehe Szenario 4), den angepassten Kurs jedoch nicht zur tatsächlichen Auftragserstellung in einer anderen API-Version verwenden.

3) Erstellen und Verfolgen von Orders

Ziel

einen Auftrag erstellen und dem Nutzer einen klaren Ausführungsstatus bereitstellen.

Endpoints

• v2: POST /api/v2/orders/public/create, POST /api/v2/orders/public/set-email
• v1: POST /api/v1/orders/public/create, GET /api/v1/orders/public-info, GET /api/v1/orders/public/latest, POST /api/v1/orders/public/accept-rate-mode-change, POST /api/v1/orders/public/request-refund, GET /api/v1/orders/order-refund-info

Ablauf (v2 — für die Erstellung empfohlen)

1. Eingaben und Zieladresse validieren.
2. Auftrag erstellen: v2/orders/public/create → orderId, depositAddress erhalten.
3. „E-Mail hinzufügen“ anbieten: v2/orders/public/set-email.
4. Dem Nutzer Einzahlungsanweisungen anzeigen.

Statusverfolgung (Schaufenster und Nutzerkonto)

• Schaufenster „letzte Tausche“: GET /api/v1/orders/public/latest.
• Details zu einem bestimmten Auftrag: GET /api/v1/orders/public-info?orderId=...&destinationAddress=... — Arrays deposits/withdrawals, confirmations, txId, networkFee.
• Wechsel des Kursmodus auf Anfrage: POST /api/v1/orders/public/accept-rate-mode-change.
• Rückerstattungen: POST /api/v1/orders/public/request-refund → Details über GET /api/v1/orders/order-refund-info.

4) Prüfung des Transaktionsstatus

Ziel

dem Nutzer Transparenz zum Fortschritt von Einzahlungen und Auszahlungen geben.

Endpoints

• v1: GET /api/v1/orders/public-info, GET /api/v1/orders/order-refund-info

Ablauf

1. public-info periodisch anhand von orderId und destinationAddress abfragen.
2. Im Block deposits[0] isPending, confirmations, txId, depositAddress analysieren.
3. Wenn die Einzahlung bestätigt ist — Auszahlungsinformationen aus dem Array withdrawals anzeigen (Betrag, networkFee, txId).
4. Im Falle einer Rückerstattung — Details über order-refund-info abrufen und den Status „Rückerstattung in Bearbeitung/abgeschlossen“ anzeigen.