Zum Inhalt springen

Dokumentation

API-Dokumentation

Zahlungen annehmen, Rechnungen stellen, auszahlen, Webhooks empfangen — alles über eine REST-API. Mit Schnellstart, HMAC-Signatur, Fehlerformat und Sandbox.

API

Authentifizierung
Jede Anfrage an die Händler-API mit HMAC-SHA256 authentifizieren: erforderliche Header, kanonische Zeichenkette, Zeitstempel und Schutz vor Wiedereinspielung.
API-Schlüssel
Payment- und Payout-Schlüssel erstellen, ihre Geltungsbereiche und Präfixe verstehen, Zugangsdaten sicher wechseln und Test von Live trennen.
Basis-URL
Die Basis-URL der Paymos Händler-API für Test- und Live-Anfragen: Die Umgebung wählt der Präfix des API-Schlüssels, der Integrationspfad bleibt derselbe.
Unterstützte Währungen
Prüfen, welche der 13 Blockchain-Netzwerke USDT, USDC, USD1, DAI und das goldgedeckte XAUT unterstützen, bevor Sie Assets in einem Projekt aktivieren.
Fehlerbehandlung
Fehler der Händler-API einheitlich behandeln: Antwortumschlag, HTTP-Statusgruppen, maschinenlesbare Codes, Anfragegrenzen und Hinweise zum Wiederholen.
Fehlercodes
Fehlschläge der Händler-API über stabile maschinenlesbare Codes, feldbezogene Prüfdetails und dokumentierte Wege zur Behebung behandeln.

Allgemein

GET
Serverzeit
Uhren abgleichen, bevor Sie Anfragen signieren: GET /v1/time liefert die Paymos-Serverzeit in Unix-Sekunden — öffentlich, ohne API-Schlüssel und ohne Signatur.

Rechnungen

POST
Rechnung erstellen
Eine Rechnung für eine Krypto-Zahlung erstellen. Zwei Wege: direkt in Krypto (Token und Netzwerk fest) und in Fiat (der Kunde wählt das Token im Checkout).
GET
Rechnungen auflisten
Rechnungen mit strengen Status- und Datumsfiltern auflisten, per Cursor vorwärts blättern und Ergebnisse ohne doppelte Seiten abgleichen.
POST
Zahlung bestätigen
Token und Netzwerk für eine in Fiat oder in Token ausgezeichnete Rechnung im eigenen Checkout bestätigen und die zurückgegebene Einzahlungsadresse anzeigen.
GET
Rechnung abrufen
Eine Rechnung anhand ihrer ID abrufen, ihren Zahlungs- und Bestätigungsstand prüfen und die Antwort mit der eigenen externen Bestellreferenz abgleichen.
POST
Rechnung stornieren
Eine offene Rechnung stornieren, bevor der Kunde ein Asset festlegt — mit dem erlaubten Zustandsübergang und der Behandlung der Antwort.
POST
Rechnungszahlung simulieren
Eine Sandbox-Rechnung durch ein Zahlungsergebnis führen und denselben Lebenszyklus und dieselben Webhooks testen wie bei einem bestätigten On-Chain-Transfer.

Auszahlungen

POST
Auszahlung erstellen
Eine Auszahlung aus einem Token-Guthaben an ein freigegebenes Wallet erstellen, das Auszahlungsnetzwerk wählen, die Anfrage signieren und den Status verfolgen.
GET
Auszahlungen auflisten
Auszahlungen mit strengen Filtern und vorwärts gerichteter Cursor-Navigation auflisten, Zielnetzwerke prüfen und die Transferhistorie verlässlich abgleichen.
GET
Auszahlung abrufen
Eine Auszahlung anhand ihrer ID abrufen, ihren aktuellen Zustand und die Transaktionsreferenz prüfen und den Abschluss mit dem signierten Webhook abgleichen.
POST
Auszahlung stornieren
Eine offene Auszahlung stornieren, bevor die Signatur beginnt — welche Zustände eine Stornierung erlauben und wie die aktualisierte Antwort zu verarbeiten ist.
POST
Abschluss einer Auszahlung simulieren
Eine offene Sandbox-Auszahlung abschließen, ohne eine Transaktion zu senden, und die Auszahlungs-Webhooks vollständig prüfen.

Guthaben

GET
Guthaben abrufen
Verfügbare Token-Guthaben abrufen, Beträge je Coin statt je Herkunftsnetzwerk lesen und das Ergebnis vor dem Anlegen einer Auszahlung nutzen.

Zahlungskanäle

POST
Zahlungskanal erstellen
Eine dauerhafte Einzahlungsadresse je Netzwerk für einen einzelnen Kunden anlegen, geführt über Ihre eigene externe Kennung und beliebig oft wiederverwendbar.
GET
Zahlungskanäle auflisten
Zahlungskanäle durchblättern, neueste zuerst, per Cursor und gefiltert nach Projekt, Status oder eigener externer Kennung.
GET
Zahlungskanal abrufen
Einen Zahlungskanal lesen: dauerhafte Adressen je Netzwerk, aktuell angenommene Token und Ihre geltenden Gebührensätze.
POST
Zahlungskanal sperren
Einem Zahlungskanal keine neuen Einzahlungen mehr zuordnen, ohne ihn zu löschen, seine Adressen freizugeben oder bereits eingegangene Zahlungen anzutasten.
POST
Zahlungskanal entsperren
Einem Zahlungskanal wieder Einzahlungen zuordnen; der Server setzt ihn auf active oder provisioning, je nachdem, ob schon eine Adresse existiert.
GET
Einzahlungen der Kanäle abfragen
Bestätigte Kanaleinzahlungen in Veröffentlichungsreihenfolge abfragen, mit stets vorrückendem Cursor: keine abgeschlossene Zahlung geht verloren.
GET
Einzahlung eines Kanals abrufen
Eine Kanaleinzahlung in jedem Zustand lesen: eingefrorene Gebührensätze, Brutto-, Gebühren- und Nettobetrag und die Belege aus der Chain.
POST
Einzahlung in einen Kanal simulieren
Eine Einzahlung in der Sandbox nach confirming, reorged oder confirmed treiben und dieselben Webhooks erhalten wie bei einer echten On-Chain-Zahlung.

Webhooks

Webhooks
Paymos über signierte, nach Umgebung getrennte Webhook-Endpunkte an Ihr Backend anbinden — mit vollständigem Zustellablauf.
Webhook-Ereignisse
Alle 16 Paymos-Webhook-Ereignistypen mit explizitem Ressourcenzustand und der Bedeutung von Endzuständen behandeln.
Inhalte der Webhooks
Den versionierten Webhook-Umschlag lesen und die vollständige Momentaufnahme von Rechnung, Auszahlung oder Kanaleinzahlung in data auswerten.
Signaturen prüfen
X-Webhook-Signature mit HMAC-SHA256 prüfen, Signaturen sicher vergleichen, Zeitstempelregeln durchsetzen und den Wechsel des Geheimnisses unterstützen.
Zustellung und Wiederholungen
Auf 11 Zustellversuche über rund 16 Stunden auslegen, wiederholte Ereignisse entdoppeln, Fehlschläge prüfen und nach der Wiederherstellung nachsenden.
Webhooks testen
Den echten Weg von Sandbox-Rechnung und Webhook-Zustellung aus dem interaktiven Playground der Dokumentation durchspielen.

Plugins

WooCommerce Plugin
Das offizielle Paymos Plugin für WooCommerce installieren, Zugangsdaten verbinden, den Checkout testen und Bestellungen per signiertem Webhook aktualisieren.
WHMCS Plugin
Stablecoin-Zahlungen zu WHMCS-Rechnungen hinzufügen, Paymos ohne Eingabe von Schlüsseln verbinden, den Webhook testen und Bereitstellungsregeln behalten.
OpenCart Plugin
Die offizielle Paymos Erweiterung für OpenCart installieren, den Shop ohne kopierte Geheimnisse verbinden und Statusänderungen im Testmodus prüfen.
Easy Digital Downloads Plugin
Paymos mit Easy Digital Downloads verbinden, eine Stablecoin-Bestellung testen, signierte Meldungen prüfen und Dateien erst nach der Bestätigung freigeben.
CS-Cart Plugin
Das offizielle Paymos Add-on für CS-Cart und Multi-Vendor installieren, ein Projekt verbinden, signierte Statusmeldungen prüfen und eine Bestellung testen.
Magento 2 Plugin
Das Paymos Modul für Magento 2 oder Adobe Commerce installieren, Test- und Live-Zugangsdaten verbinden und den Weg von der Bestellung zur Rechnung prüfen.
Shopware 6 Plugin
Das Paymos Plugin für Shopware 6 installieren, je Verkaufskanal aktivieren, signierte Transaktionsmeldungen prüfen und den Modus ohne Neuinstallation wechseln.
PrestaShop Plugin
Paymos zu PrestaShop 8 oder 9 hinzufügen, den Shop mit einem Klick verbinden, den signierten Callback prüfen und den Status „Zahlung angenommen“ testen.