Zum Inhalt springen

API

Auf dieser Seite

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.

POST/v1/invoices/:invoice_id/confirm-payment

API-Schlüssel: Payment

Bestätigt Stablecoin und Netzwerk für eine Rechnung, solange sie in awaiting_client steht. Der Aufruf vergibt die Einzahlungsadresse und setzt die Rechnung auf awaiting_payment — gleich, ob der Betrag in Fiat oder in einem Token ausgezeichnet ist. Bei einer in Fiat ausgezeichneten Rechnung wird im selben Moment der Wechselkurs fixiert. Steht der Betrag bereits in einem Token, gibt es keinen Kurs zu fixieren: Das bestätigte Token muss das bei der Erstellung angeforderte sein, das Netzwerk ebenso, sofern die Erstellung eines festgelegt hat.

Nutzen Sie diesen Aufruf, wenn Sie einen eigenen Checkout darstellen und die Token-Wahl auf Ihrem Server entgegennehmen. Alle Checkouts, die Paymos selbst bereitstellt — die gehostete Seite hinter der payment_url, die Iframe-Einbettung, das Low-Code SDK und der Paymos-Bot, den die payment_url eines Telegram-Bot-Projekts stattdessen öffnet — bestätigen die Auswahl auf ihrem eigenen Weg; dafür brauchen Sie diesen Endpunkt nicht. Vom Kanal des Projekts hängt der Aufruf nicht ab: Bestätigen Sie auch bei einem Telegram-Bot-Projekt serverseitig, landet der Zahlende über den Link direkt auf der Einzahlungsadresse — der Auswahlschritt entfällt.

Sie bekommen hier einen Endpunkt, kein Produkt unter fremder Marke. Er lässt Sie die Zahlseite selbst bauen, auf Ihrer eigenen Domain, und ändert nichts an den Seiten, die wir hosten: Dort steht in jedem Farbschema und in jeder Einbettung die Zeile "Secured by Paymos", und eine Zahlseite unter Ihrem eigenen CNAME bietet Paymos nicht an.

Anfragekörper

Parameter Typ Erforderlich Beschreibung
currency Zeichenkette Ja Der Stablecoin, mit dem der Kunde zahlen möchte (etwa USDT, USDC). Muss im Projekt der Rechnung aktiviert sein
network Zeichenkette Ja Das Netzwerk, in dem der Kunde zahlen möchte (etwa TRC20, BASE) — es muss ein Netzwerk sein, in dem dieses Token aktiviert ist
{
  "currency": "USDT",
  "network": "TRC20"
}

Antwort (200 OK)

Gibt die vollständige Rechnung zurück, deren Abschnitt payment jetzt gefüllt ist — mit gewählter currency und network, der vergebenen Einzahlungsadresse address, dem fixierten exchange_rate, sofern die Rechnung in Fiat ausgezeichnet ist, und dem erwarteten Krypto-Betrag expected. Da dieser Aufruf mit Ihrem Händlerschlüssel authentifiziert ist, trägt die Antwort außerdem die nur für Händler bestimmten Felder fee und net. Der Körper hat dieselbe Form wie bei Rechnung abrufen.

Fehler

Den vollständigen Katalog finden Sie unter Fehlercodes. Die type-URI in jeder Fehlerantwort verweist direkt auf die passende Zeile. Eine Rechnung zu bestätigen, die nicht Ihnen gehört, liefert 404. Eine Rechnung im Zustand expired oder cancelled liefert 410; jeder andere Status jenseits von awaiting_client liefert 409 — einschließlich der Endzustände paid, paid_over und underpaid.