Was genau ist eine Dosis? Jede von Ihnen angelegte Transaktion gehört zu einem sogenannten Batch. Wie eine Quittung hat jeder Batch seine eigene Nummer und ist eigentlich ein Paket von Transaktionen. Ein Cut-off ist ein administrativer Vorgang, bei dem ein Terminal einen Batch schließt und Systeme auffordert, den Batch zu schließen und einen neuen zu öffnen. In Systemen Global Payments Es ist möglich, die Schlussnummer für jede Transaktion zu sehen, und es ist möglich, Transaktionen nach dieser Nummer zu filtern.
Login & Authentifizierung
Die JWT-Tokenauthentifizierung ist für alle nicht öffentlichen Endpunkte erforderlich. Sie erhalten das Token (mit einer Lebensdauer von 90 Tagen) über den Endpunkt /cloud/oauth/token mit den folgenden Argumenten:
- Standardauthentifizierung für Token-Endpunkte (Name/Passwort) - wird für jeden Benutzer bereitgestellt.
- Händler-Benutzername – wie für GP tom
- Händlerpasswort – wie für GP tom
- Terminal ID (TID) – Zielterminal-ID
- Der Autorisierungsendpunkt befindet sich unter:
- Entwicklung: https://cloud-api-dev.gptom.com/cloud/oauth/token
- Produktion: https://cloud-api.gptom.com/cloud/oauth/token
Abrufen eines Zugriffstokens
Beispielanfrage:
POST {{apiCloudHost}}/cloud/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=password&username=jan.novak@example.com&password=ABCDEFGHIJKL&tid=999888
Beispielantwort:
{ "access_token": "eyJh…", // access token used in authenticated API requests "token_type": "bearer", "refresh_token": "GciO…", "expires_in": 3600, "scope": "read write", "tid": "999888", }
Token-Verlängerung
Wenn die access_tokenu abläuft, ist refresh_token verfügbar.
Beispielanfrage:
POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Erstellen einer Aufgabe
Rufen Sie den POST-Endpunkt /v1/tasks/BATCH auf, und verwenden Sie CreateCloudTaskTransactionApiRequest mit den folgenden Informationen, um die Anforderung zu stellen:
OBLIGATORISCH
MANDATORY
OBLIGATORISCH
OBLIGATORISCH
OBLIGATORISCH
Beispiel: "Rechnung 37364FD"
Inhalt der Antwort [CloudTaskDetailApiResponse]:
Mögliche Antwortcodes sind:
Im Folgenden finden Sie die in der Antwort verwendeten Variablen:
Überprüfen des Status einer Aufgabe
V dalším kroku budete kontrolovat stav tasku na koncovém bodu GET /v1/tasks/{taskID} pomocí požadavku, který zahrnuje:
Mögliche Rückgabecodes:
Variablen in der Antwort:
Die Aufgabenstatusanforderung sollte wiederholt werden, bis Sie einen der endgültigen Antwortcodes erhalten, nämlich:
Sie können mit dem nächsten Schritt nur fortfahren, wenn sich die Antwort im Status ABGESCHLOSSEN befindet.
Abrufen des Abschlussergebnisses
Nyní víme, že uzávěrka byla autorizována. Cílem tohoto kroku je získat stav uzávěrky a její údaje. Pro nový požadavek zavoláte koncový bod GET /v1/batches/{batchId}, kde použijete následující proměnné:
Mögliche Antwortcodes sind:
Die Antwort enthält je nach Antwortcode die folgenden Variablen:
-closeBatchNumber (string) - untergeordneter closeBatchNumber-Batch
- totalCount (number) - Gesamtzahl der Transaktionen im Batch
- saleCount (number) - Anzahl der Transaktionen der Verkaufsart im Batch
- saleAmount (number) - Transaktionsvolumen der Verkaufsart in Charge
- voidCount (number) - Anzahl der Transaktionsstornierungen
- voidAmount (number) - Transaktionsabbruchvolumen im Batch