Reporting via paydirekt API

Die Transaktionsübersicht via paydirekt API bietet Ihnen die Möglichkeit, Ihre Reports automatisiert abzurufen und direkt in Ihren Systemen weiterzuverarbeiten. Die Transaktionsübersicht via API bietet Ihnen die maximale Flexibilität und vollen Zugriff auf alle Parameter einer Transaktion. Im Abschnitt Identifier finden Sie eine Übersicht der per Transaktionsübersicht verfügbaren Parameter.

Durch die Möglichkeit der Automatisierung ist das Reporting bzw. die Reconciliation via paydirekt API das empfohlene Verfahren.

Verfügbare Ausgabeformate

Durch die Angabe des Accept-Headers wird das Format des Reports gewählt. Dabei stehen Ihnen die Formate JSON sowie CSV zur Verfügung.

Filtermöglichkeiten

Um die Liste der abzurufenden Transaktionen noch besser spezifizieren zu können, stehen Ihnen diverse optionale Filter zur Verfügung. Speziell die Möglichkeit nach einer oder mehreren paymentInformationIds sowie einem bestimmten Datumsbereich, filtern zu können, vereinfacht die Reconciliation.

Die paydirekt API bietet Ihnen hierbei folgende Filtermöglichkeiten zur Einschränkung Ihrer Transaktionssuche:

Feld-Name Beschreibung
from Zeitstempel im ISO-8601-Format, ab dem Transaktionen berücksichtigt werden. Falls nicht angegeben, werden die 30 Tage seit dem to-Zeitstempel abgefragt, d. h. der from-Zeitstempel wird implizit auf to-Zeitstempel minus 30 Tage gesetzt.
to Zeitstempel im ISO-8601-Format, bis zu dem Transaktionen berücksichtigt werden. Falls nicht angegeben, wird bis zum aktuellen Zeitpunkt abgefragt.
fields Eine Liste mit Feldbezeichnern für Transaktionen. Für den Transaktionsreport im CSV-Format bestimmt fields die enthaltenen Spalten und deren Reihenfolge. Für den Transaktionsreport im JSON-Format bestimmt fields die enthaltenen Felder. Ist fields nicht angegeben, enthält der Transaktionsreport alle möglichen Felder, wie sie in Transaktionen aufgezählt sind.
reconciliationReferences Liste von merchantReconciliationReferenceNumbers, nach denen Transaktionen gefiltert werden. Eine leere Liste wird ignoriert.
paymentInformationIds Liste von paymentInformationIds, nach denen Transaktionen gefiltert werden. Eine leere Liste wird ignoriert.
merchantReferenceNumbers Liste von merchantReferenceNumbers, nach denen Transaktionen gefiltert werden. Eine leere Liste wird ignoriert.
checkoutInvoiceNumbers Liste von checkoutInvoiceReferenceNumbers, nach denen Transaktionen gefiltert werden. Eine leere Liste wird ignoriert.
captureInvoiceNumbers Liste von captureInvoiceReferenceNumbers, nach denen Transaktionen gefiltert werden. Eine leere Liste wird ignoriert.

Um die Transaktionsübersicht via paydirekt API nutzen zu können, müssen Sie sich mit der paydirekt API über eine Direktanbindung verbinden. Folgen Sie dazu den Beschreibungen in unserem Implementierungsguide und unserer API-Schnittstellenbeschreibung.