Zum Inhalt springen

API

Auf dieser Seite

Ereignisse

Alle 16 Paymos-Webhook-Ereignistypen mit explizitem Ressourcenzustand und der Bedeutung von Endzuständen behandeln.

Paymos veröffentlicht 16 Ereignistypen: 8 für Rechnungen, 5 für Auszahlungen und 3 für Zahlungskanäle. Abonniert wird je Kategorie auf Ebene des Endpunkts; einzelne Ereignisnamen innerhalb einer Kategorie lassen sich nicht getrennt auswählen.

Ereignisse zu Rechnungen

Ereignis Bedeutung Endgültig
invoice.awaiting_payment Eine tiefe Reorganisation hat jeden gezählten Transfer entfernt, und die Rechnung ist auf „wartet auf Zahlung“ zurückgefallen. Der erstmalige Übergang in diesen Zustand sendet dieses Ereignis nicht Nein
invoice.confirming Eine Zahlung wurde erkannt und wartet auf die erforderliche Finalität in der Blockchain Nein
invoice.underpaid_waiting Der eingegangene Betrag liegt unter dem erwarteten, und die Rechnung kann weiterhin Zahlungen annehmen Nein
invoice.paid Der erwartete Betrag wurde gezahlt Ja
invoice.paid_over Es wurde mehr als der erwartete Betrag gezahlt; der gesamte eingegangene Betrag wird gutgeschrieben Ja
invoice.underpaid Die Rechnung hat den Endzustand „unterbezahlt“ erreicht Ja
invoice.expired Die Rechnung ist ohne qualifizierende Zahlung abgelaufen Ja
invoice.cancelled Der Händler hat die Rechnung storniert Ja

Ereignisse zu Auszahlungen

Ereignis Bedeutung Endgültig
withdrawal.created Die Auszahlung wurde angenommen und angelegt Nein
withdrawal.processing Die ausgehende Transaktion wurde on-chain beobachtet und ihr Transaktions-Hash liegt vor Nein
withdrawal.completed Die ausgehende Transaktion ist on-chain abgeschlossen Ja
withdrawal.failed Die Auszahlung ist fehlgeschlagen und hat einen Endzustand erreicht Ja
withdrawal.cancelled Die Auszahlung wurde vor dem Abschluss storniert Ja

Ereignisse zu Zahlungskanälen

Ereignis Bedeutung Endgültig
payment_channel.deposit.confirming Ein Transfer ist an einer Kanaladresse eingegangen und wartet auf die erforderliche Finalität in der Blockchain Nein
payment_channel.deposit.reorged Eine Reorganisation der Chain hat die Transaktion verdrängt. Wird sie erneut aufgenommen, kehrt dieselbe Einzahlung nach confirming zurück Nein
payment_channel.deposit.confirmed Die Einzahlung ist abgeschlossen, und der Nettobetrag ist Ihrem Guthaben gutgeschrieben Ja

Ein Fehlerereignis gibt es nicht: Kommt die Transaktion in keinen weiteren Block, bleibt die Einzahlung auf reorged, und es folgt kein weiteres Ereignis.

Regeln für die Verarbeitung

  • Verteilen Sie anhand des exakten event_type; ignorieren Sie unbekannte künftige Typen gefahrlos und melden Sie sie zur Prüfung.
  • Lesen Sie data.status und data.is_final aus dem Inhalt, statt den Zustand aus dem Ereignisnamen zu rekonstruieren.
  • Nehmen Sie keine Zustellreihenfolge an. Durch parallele Zustellung und Wiederholungen kann eine neuere Momentaufnahme der Ressource zuerst eintreffen.
  • Ein endgültiges Ereignis ist für die Zustandsmaschine dieser Ressource final. Eine erneute Zustellung derselben event_id bleibt ein Duplikat und ist kein weiterer Übergang.
  • Deduplizieren Sie den fachlichen Zustand über die Ressourcen-ID in data (inv_…, wdr_…, pcd_…): Sie ist über jeden Übergang und jeden Endpunkt hinweg stabil. event_id bezeichnet eine Zustellung, nicht eine Zahlung.

Den gemeinsamen Umschlag und die Ressourcenfelder beschreibt der Vertrag der Inhalte.