Was genau ist ein Batch? Jede von Ihnen erstellte Transaktion gehört zu einem sogenannten Batch. Genau wie ein Kassenbon hat jeder Batch eine eigene Nummer und ist im Grunde ein Bündel von Transaktionen. Ein Abschluss ist ein administrativer Vorgang, mit dem das Terminal einen Stapel abschließt und die Systeme auffordert, den Stapel zu schließen und einen neuen zu eröffnen. In den Systemen von Global Payments kann bei jeder Transaktion die Abschlussnummer eingesehen werden, und es ist möglich, Transaktionen nach dieser Nummer zu filtern.
Anmeldung & Authentifizierung
Für alle nicht öffentlichen Endpunkte ist eine Authentifizierung mittels JWT-Token erforderlich. Das Token (mit einer Gültigkeitsdauer von 90 Tagen) erhalten Sie über den Endpunkt /cloud/oauth/token mit den folgenden übergebenen Argumenten:
- Basisauthentifizierung für Token-Endpunkte (Benutzername/Passwort) – wird für jeden Benutzer bereitgestellt.
- Händlername – derselbe wie für GP tom
- Händler-Passwort – dasselbe wie für GP tom
- Terminal-ID (TID) – ID des Zielterminals
- Der Autorisierungsendpunkt befindet sich unter:
Beantragung eines Zugriffstokens
Beispielanfrage:
POST {{apiCloudHost}}/cloud/oauth/token
Autorisierung: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Inhalt-Typ: anwendung/x-www-form-urlencoded
grant_type=password&username=jan.novak@example.com&password=ABCDEFGHIJKL&tid=999888
Beispielantwort:
{
"access_token": "eyJh…", // Zugriffstoken, das bei authentifizierten API-Anfragen verwendet wird
"token_type": "bearer",
"refresh_token": "GciO…",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}Token zurücksetzen
Nach Ablauf des access_tokens steht ein refresh_token zur Verfügung.
Beispielanfrage:
POST {{apiHost}}/api/oauth/token
Autorisierung: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Inhalt-Typ: anwendung/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Erstellen eines Ordners
Rufen Sie den Endpunkt POST /v1/tasks/BATCH auf und verwenden Sie CreateCloudTaskTransactionApiRequest mit den folgenden Angaben, um die Anfrage zu erstellen:
VERPFLICHTUNG
VERPFLICHTUNG
VERPFLICHTUNG
VERPFLICHTUNG
VERPFLICHTUNG
Beispiel: „Rechnung 37364FD“
Inhalt der Antwort [CloudTaskDetailApiResponse]:
Mögliche Antwortcodes sind:
Nachfolgend finden Sie die in der Antwort verwendeten Variablen:
Überprüfung des Taschenzustands
Im nächsten Schritt überprüfen Sie den Status der Aufgabe am Endpunkt GET /v1/tasks/{taskID} mithilfe einer Anfrage, die Folgendes enthält:
Mögliche Rückgabecodes:
Variablen in der Antwort:
Die Abfrage des Tasks-Status sollte so lange wiederholt werden, bis Sie einen der folgenden endgültigen Antwortcodes erhalten:
Sie können erst dann mit dem nächsten Schritt fortfahren, wenn der Status der Antwort „COMPLETED“ lautet.
Ermittlung des Bilanzergebnisses
Wir wissen nun, dass der Abschluss genehmigt wurde. Ziel dieses Schritts ist es, den Status des Abschlusses und die dazugehörigen Daten abzurufen. Für die neue Anfrage rufen Sie den Endpunkt GET /v1/batches/{batchId} auf, wobei Sie die folgenden Variablen verwenden:
Mögliche Antwortcodes sind:
Die Antwort enthält je nach Antwortcode die folgenden Variablen:
-closeBatchNumber (Zeichenkette) – closeBatchNumber des untergeordneten Batches
- totalCount (number) – Gesamtzahl der Transaktionen im Batch
- saleCount (number) – Anzahl der Verkaufstransaktionen im Batch
- saleAmount (number) – Betrag der Verkaufstransaktionen im Stapel
- voidCount (number) – Anzahl der stornierten Transaktionen
- voidAmount (number) – Betrag der stornierten Transaktionen im Stapel
