In diesem Thema wird beschrieben, wie Sie Berichtsdaten als kommagetrennte Werte (CSV) herunterladen können, indem Sie einen HTTPS POST-Abfrage-String übermitteln. Durch die Implementierung der hier beschriebenen CSV-Download-Funktionalität kann Ihr System so konfiguriert werden, dass es Anfragen in Ihrem Namen verarbeitet, so dass Sie den Prozess des Herunterladens der erforderlichen Datensätze automatisieren können.
CSV-Dateien mit Transaktionsdaten können auch heruntergeladen werden, indem Sie sich bei Portal anmelden und die Seite Transaktionssuche verwenden.
Die maximale Anzahl von Datensätzen, die heruntergeladen werden können, beträgt 75.000.
Wenn Sie mehr als 75.000 Datensätze haben, empfehlen wir, kleinere Zeitrahmen anzufordern und mehrere aufeinanderfolgende Abfragen durchzuführen
Überblick über den Prozess
Mit Hilfe von Berichten können Sie die Anzahl der Anfragen verfolgen, die in einem bestimmten Zeitraum über Ihr Konto bearbeitet wurden. Diese Informationen werden nach den in der POST angegebenen Kriterien gruppiert.
Beispielhafte Anwendungsfälle:
- Laden Sie die Anzahl der genehmigten Transaktionen herunter.
- Laden Sie die Anzahl der ausgesetzten Transaktionen herunter.
- Laden Sie den Gesamtbetrag der abgerechneten Mittel herunter.
- Laden Sie die Anzahl der mit PayPal verarbeiteten Transaktionen herunter.
Im Folgenden finden Sie ein Beispiel für eine POST-Anfrage für einen Berichtsdownload CSV-Berichts:
wget --output-document=output.csv --user=example@example.com --ask-password --post-data="sitereferences=test_site12345&startdate=2017-01-01&enddate=2017-01-31&settlestatuss=100&sqlgroupbys=currencyiso3a&sqlgroupbys=paymenttypedescription" https://myst.securetrading.net/auto/transactions/reporting
Der obige Antrag besteht aus vier Hauptteilen:
Sie müssen einen Trust Payments API-Benutzernamen mit ausreichenden Benutzerrechten angeben, um den Download für die angegebene(n) Website-Referenz durchzuführen.
--user=example@example.com --ask-password
Die CSV-Datei kann über einen HTTPS POST-Abfrage-String mit Basic Access Authentication heruntergeladen werden. Basic Access Authentication ist eine Methode, bei der ein Webbrowser-Clientprogramm einen Benutzernamen und ein Passwort angeben muss, wenn es eine Anfrage bearbeitet.
Unterstützte Benutzerrollen
Sie können mit Ihrem Webservices Benutzernamen und Passwort verwenden, um Transaktionsdatensätze und Berichte herunterzuladen. Wenn Sie noch keinen Webservices Benutzernamen haben, können Sie einen neuen API-Benutzer erstellen, indem Sie Portal.
Wir unterstützen auch zwei zusätzliche Benutzerrollen für CSV-Downloads. Diese sind "Transaktionsdownload" und "Berichtsdownload" für das Herunterladen von Transaktionsdatensätzen bzw. Berichten. Um Benutzer mit diesen Rollen einzurichten, wenden Sie sich bitte an unser Support-Team.
Autorisierung Kopfzeile
Ein Benutzername und ein Passwort, getrennt durch einen Doppelpunkt, dann base64 kodiert, müssen in der Autorisierung Kopfzeile enthalten sein, wenn die Anfrage durchgeführt wird. Die meisten URL-Bibliotheken erstellen den Basis-Authentifizierungs-Header automatisch, aber wenn Sie dies manuell durchführen müssen, folgen Sie bitte diesem Beispiel:
Benutzername: csvdownload@example.com
Passwort: pa55word
Getrennt durch einen Doppelpunkt: csvdownload@example.com:pa55word
Base64 kodieren: Y3N2ZG93bmxvYWRAZXhhbXBsZS5jb206cGE1NXdvcmQ=
Daher sollte die Kopfzeile Autorisierung lauten:
Authorization: Basic Y3N2ZG93bmxvYWRAZXhhbXBsZS5jb206cGE1NXdvcmQ=
Die Anfrage kann mit Filtern versehen werden, so dass nur Datensätze zurückgegeben werden, die bestimmten Kriterien entsprechen.
sitereferences=test_site12345&startdate=2017-01-01&enddate=2017-01-31&settlestatuss=100
Standardmäßig werden alle Transaktionen innerhalb des Datumsbereichs für die angegebene(n) Website-Referenz im Download zurückgegeben. Es können Filter auf den Download angewendet werden, so dass nur bestimmte Datensätze zurückgegeben werden. Im obigen Beispiel wurden die folgenden Filter angewandt:
- Website-Referenz: test_site12345
- Datum der Transaktion Autorisierung : 1. Januar 2017 - 31. Januar 2017
- Abrechnungsstatus: 100
Mehrere Werte für dieselben Filter können durch ein "&" getrennt in den Aufruf aufgenommen werden.
Zum Beispiel für das Herunterladen von E-Commerce und MOTO Transaktionen, die accounttypedescriptions Filter kann zweimal mit zwei verschiedenen Werten enthalten sein:
accounttypedescriptions=ECOM&accounttypedescriptions=MOTO
Erforderliche Filter
Die folgenden Felder müssen in den POST-Daten enthalten sein:
| Name des Filters | Kommentar |
| sitereferences | Die Website-Referenz/s, von der Daten heruntergeladen werden sollen. |
| startdate | Das Startdatum für die angegebenen Datensätze (im Format JJJJ-MM-TT). |
| enddate | Das Enddatum für die angegebenen Datensätze (im Format JJJJ-MM-TT). |
Daten können für mehrere Website-Referenzen heruntergeladen werden, indem zusätzliche Website-Referenzen Felder durch ein "&" getrennt in den Aufruf aufgenommen werden.
Wenn zum Beispiel Transaktionen für Standort1 und Standort2 benötigt werden, würde der Aufruf Folgendes beinhalten:
sitereferences=site1&sitereferences=site2
Bitte beachten Sie, dass das Feld auch beim Herunterladen von Transaktionen für eine Website-Referenz immer sitereferences heißen muss.
Optionale Filter
Nützliche Filter
Im Folgenden finden Sie eine Liste der von unseren Händlern am häufigsten verwendeten Filter:
(Wenden Sie sich an unser Support-Team, um sich über die Verfügbarkeit weiterer Filter zu informieren)
| Name des Filters | Kommentar |
| accounttypedescriptions |
Filtern Sie nach Kontotyp, z. B. "ECOM" für E-Commerce. Sie können die für Ihr Konto auf Portal aktivierten Kontotypen einsehen, indem Sie zu Ihrer Website-Detailseite navigieren und auf "Konten" klicken. |
| currencyiso3as |
Filtern nach Währung. |
| errorcodes |
Nach Fehlercodes filtern. Klicken Sie hier, um eine Liste der Fehlercodes zu erhalten. |
| paymenttypedescriptions | Filtern Sie nach Zahlungsart. z.B. "VISA", "MASTERCARD" usw. |
| requesttypedescriptions |
Art der Anfrage, zum Beispiel "AUTH", "REFUND" usw. Klicken Sie hier, um eine Liste der Antragsarten zu erhalten. |
| settlestatuss |
Filter nach Status. z.B. "100" für alle abgerechneten Transaktionen. |
Beachten Sie, dass die Suche nach settlestatus, muss das Feld aufgerufen werden settlestatuss.
Nach Zeit filtern
Verwenden Sie die folgenden Filter, um Daten zu Transaktionen innerhalb eines bestimmten Zeitraums herunterzuladen:
| Name des Filters | Kommentar |
| starttimehour | So finden Sie Transaktionen zwischen HH:mm:00 und HH:mm:59 *Erforderlich, wenn Endzeit angegeben ist |
| starttimeminute | Um Transaktionen zwischen HH zu finden:mm:00 und HH:mm:59 * Erforderlich, wenn starttimehour angegeben |
| endtimehour | So finden Sie Transaktionen zwischen HH:mm:00 und HH:mm:59 * Erforderlich bei Angabe der Startzeit |
| endtimeminute | Um Transaktionen zwischen HH:mm:00 und HH zu finden:mm:59 * Erforderlich, wenn endtimehour angegeben |
Zum Beispiel für das Herunterladen von Transaktionen zwischen 13:30:00 und 14:29:59:
starttimehour=13&starttimeminute=30&endtimehour=14&endtimeminute=29
Datumstyp
Standardmäßig werden die angegebenen Datums- und Zeitangaben auf der Grundlage des Zeitpunkts gefiltert, zu dem die Transaktion ursprünglich verarbeitet wurde. Sie können jedoch explizit angeben, welche Art von Datum/Uhrzeit gefiltert wird, indem Sie den folgenden zusätzlichen Filter einfügen:
| Name des Filters | Kommentar |
| datetypes | Spezifizieren "settledtimestamp", um nach Datum/Uhrzeit der Abrechnung zu filtern.
Spezifizieren "transactionstartedtimestamp", um nach Datum/Uhrzeit der Bearbeitung von Anfragen zu filtern. |
Wenn Ihr System viele Band Transaktionen verarbeitet, empfehlen wir, die CSV-Dateien der Transaktionen stündlich (statt täglich) herunterzuladen, um die Leistung zu optimieren und die Größe der heruntergeladenen Dateien zu verringern. Ihr System kann stündlich eine Anfrage übermitteln und dabei die Zeitfilter wie oben beschrieben angeben, um sicherzustellen, dass nur die in der letzten Stunde verarbeiteten Transaktionen berücksichtigt werden.
Hier können Sie die Datenfelder angeben, die zurückgegeben werden sollen.
Als Minimum müssen alle Berichtsdownload CSVs den Namen des Acquirers und die Anzahl der Transaktionen enthalten, die für jeden dieser Acquirer innerhalb des angegebenen Zeitraums abgewickelt wurden.
Beispielhafte Ausgabe:
acquirertypedescription,settledcount
BARCLAYS,1916
PAYPAL,249
PAYSAFE,18
TEST,4
Gruppierung
Die in Berichtsdownload zurückgegebene Ausgabe kann nach den folgenden Optionen gruppiert werden:
- day
- sitereference
- currencyiso3a
- requesttypedescription
- accounttypedescription
- paymenttypedescription
- errorcode
- settlestatus
- livestatus
- transactionactive
- enrolled
- fraudcontrolshieldstatuscode
- orderreference
Sie können eine bevorzugte Gruppierung auf die Berichtsdownload anwenden, indem Sie die optionale sqlgroupbys Feld in der Anfrage.
Die folgende Beispielabfrage würde zuerst die nach Währung gruppierte Ausgabe zurückgeben und dann Zahlungsart:
wget --output-document=output.csv --user=example@example.com --ask-password --post-data="sitereferences=test_site12345&startdate=2017-01-01&enddate=2017-01-31&settlestatuss=100&sqlgroupbys=currencyiso3a&sqlgroupbys=paymenttypedescription" https://myst.securetrading.net/auto/transactions/reporting
Die Reihenfolge, in der die sqlgroupbys übermittelt werden, wirkt sich auf die Ausgabe aus. Die Ausgabe wird immer in der Reihenfolge gruppiert, in der sie in der Anfrage übermittelt wurde.
Sie könnten zum Beispiel stattdessen die Ausgabe zuerst nach Zahlungsart gruppieren und dann Währunggruppieren, indem Sie die beiden Felder im obigen Beispiel vertauschen.
Bei der Übermittlung der obigen Beispielabfrage würde die Ausgabe wie unten dargestellt gruppiert werden. Da die Daten sowohl nach Währung als auch nach Zahlungsart gruppiert werden sollten, gibt es in der Ausgabe eine Zeile für jede Kombination von Währung und Zahlungsart.
acquirertypedescription,currencyiso3a,paymenttypedescription,settledcount,sumsettlemainamount
TEST,GBP,VISA,1,10.99
TEST,GBP,MASTERCARD,3,33.96
TEST,EUR,VISA,17,214.10
TEST,EUR,MASTERCARD,7,72.80
Laden Sie die CSV-Datei von der folgenden URL herunter:
https://myst.securetrading.net/auto/transactions/reporting
Die Verwendung dieser URL ist von der Umstellung von MyST auf Portal
nicht betroffen. Bitte verwenden Sie weiterhin die oben angegebene MyST-URL zur Bearbeitung von Anfragen.
Ausgabe
Wenn Ihre Anfrage erfolgreich ist, hat die CSV-Ausgabe die folgende Struktur:
acquirertypedescription,currencyiso3a,paymenttypedescription,settledcount,sumsettlemainamount
TEST,GBP,VISA,1,10.99
TEST,GBP,MASTERCARD,3,33.96
TEST,EUR,VISA,17,214.10
TEST,EUR,MASTERCARD,7,72.80
