transactions/ stellt eine Schnittstelle zur Verfügung, mit der Zahlungsinformationen aus dem Shop-System abgerufen und verwaltet werden können.
Zu jeder Transaktion lassen sich Details wie Zahlungsart, Status, Beträge und zeitliche Abläufe einsehen. Darüber hinaus unterstützt die Schnittstelle die Aktualisierung des Status sowie Aktionen wie Erfassung, Rückerstattung oder Abbruch.
Unterstützte Methoden
Angabe aller unterstützten Methoden.Datenfelder einer Transaktion
Beispiel
Methoden für die Transaktionen
Die folgenden Methoden ermöglichen es, Transaktionen im Shop-System zu verwalten. Eine Transaktion erfasst die Zahlungsbewegung zu einer Bestellung und enthält Informationen wie Betrag, Status, Zahlungsart und Zeitpunkte der Zahlung oder Rückerstattung. Über die API können Transaktionen ausgelesen, ihr Status aktualisiert, zurückerstattet, abgebrochen oder erfasst werden. Für alle Methoden müssen entsprechende Berechtigungen zum Lesen oder Schreiben von Transaktionsdaten vorhanden sein.GET transactions
Mit dem Endpunkttransactions können Sie auf eine Liste abgeschlossener Transaktionen im Shop zugreifen.
Die API ermöglicht es, Transaktionen nach verschiedenen Kriterien wie Zeiträumen, Zahlungsstatus oder Subshop zu filtern und zu sortieren. Die Transaktionen enthalten unter anderem Informationen zu Beträgen, Zahlungsmethoden, zugehörigen Bestellungen und Kundenkonten.
Um auf diesen Endpunkt zuzugreifen, müssen die entsprechenden Berechtigungen zum Lesen von Transaktionsdaten vorhanden sein.
Beispiel
Das Beispiel zeigt eine Abfrage von bis zu 100 Transaktionen, die im Zeitraum vom 23.03.2025 bis einschließlich 22.04.2025 erstellt wurden.Antwort
Filterfelder
id, createdAt, payedAt, refundedAt, paymentStatus, subshopId, accountId, sandboxPayment
Sortierfelder
id, createdAt, updatedAt, payedAt, refundedAt, paymentStatus, subshopId, accountId, orderId, sessionId, clearerId, currency, amount, paymentMethod, sandboxPayment
Fehlercodes
GET transactions/{id}
Diese Methode lädt die vollständigen Details einer einzelnen Transaktion basierend auf ihrer eindeutigen ID. Sie können damit Transaktionsinformationen wie Zahlungsstatus, Adressen sowie Zusatzdaten abrufen. Damit die Methode verwendet werden kann, müssen die erforderlichen Berechtigungen zum Lesen von Transaktionen vorhanden sein.Beispiel
Antwort
Fehlercodes
PUT transactions/{id}/refresh
Mit dieser Methode wird der aktuelle Status einer vorhandenen Transaktion beim angebundenen Zahlungsdienstleister abgefragt und aktualisiert. Sie kann verwendet werden, wenn der Status einer Transaktion nicht mehr aktuell erscheint (z. B. bei ausstehenden Zahlungen oder Rückerstattungen). Es müssen entsprechende Berechtigungen zum Schreiben von Transaktionsdaten vorhanden sein.Beispiel
Antwort
Fehlercodes
PUT transactions/{id}/cancel
Mit dieser Methode wird versucht, eine Transaktion beim angebundenen Zahlungsdienstleister zu stornieren. Dies ist beispielsweise bei noch nicht abgeschlossenen oder fehlerhaften Zahlungen erforderlich. Nach erfolgreicher Stornierung wird die aktualisierte Transaktion zurückgegeben. Es müssen entsprechende Berechtigungen zum Schreiben von Transaktionen vorhanden sein.Beispiel
Antwort
paymentStatus in der Regel auf 4 (Canceled) oder 6 (CanceledByAdmin) gesetzt. Der genaue Wert hängt vom Zahlungsdienstleister ab.
Fehlercodes
PUT transactions/{id}/refund
Diese Methode löst eine Rückerstattung eines bereits bezahlten Betrags bei der angegebenen Transaktion aus. Optional kann ein Teilbetrag (amount) und ein Rückgabegrund (reason) im Request Body übergeben werden. Wird kein Betrag angegeben, wird der gesamte Betrag erstattet. Nach erfolgreicher Rückerstattung wird die aktualisierte Transaktion zurückgegeben.
Für diese Aktion müssen entsprechende Berechtigungen zum Schreiben von Transaktionen vorhanden sein.
Beispiel
Request Body
Antwort
paymentStatus auf 7 (Refunded) oder 8 (RefundedPartially) gesetzt, je nachdem ob der gesamte oder ein Teilbetrag erstattet wurde.
Fehlercodes
PUT transactions/{id}/capture
Diese Methode dient dazu, eine reservierte Transaktion zu erfassen, d. h. der ursprünglich nur vorgemerkte Betrag wird final vom Kundenkonto abgebucht. Diese Funktion wird vor allem bei Zahlungsanbietern benötigt, bei denen eine Autorisierung und eine separate Erfassung erforderlich sind (z. B. Kreditkarte). Die aktualisierte Transaktion wird im Anschluss zurückgegeben. Für diese Aktion müssen entsprechende Berechtigungen zum Schreiben von Transaktionen vorhanden sein.Beispiel
Antwort
paymentStatus in der Regel auf 1 (Finished) gesetzt. Bei einem Fehler wird er auf 2 (Error) gesetzt.