Co přesně je dávka? Každá transakce, kterou vytvoříte, patří do tzv. dávky. Stejně jako účtenka má každá dávka své číslo a je vlastně balíčkem transakcí. Uzávěrka je administrativní operace, pomocí které terminál uzavře dávku a vyzve systémy, aby se dávka uzavřela a otevřela nová. V systémech Global Payments je možné u každé transakce vidět číslo uzávěrky a je možné transakce filtrovat podle tohoto čísla.
Přihlášení & autentifikace
Pro všechny neveřejné koncové body je potřeba ověření pomocí tokenu JWT. Token (s životností 90 dnů) získáte prostřednictvím koncového bodu /cloud/oauth/token s následujícími poskytnutými argumenty:
- Základní autentizace pro koncové body tokenu (jméno/heslo) – bude poskytnuto pro každého uživatele.
- Uživatelské jméno obchodníka – stejné jako pro GP tom
- Heslo obchodníka – stejné jako pro GP tom
- ID terminálu (TID) – ID cílového terminálu
- Autorizační koncový bod se nachází na: https://cloud-api-dev.gptom.com/cloud/oauth/token.
Získání access tokenu
Příklad požadavku:
POST {{apiCloudHost}}/cloud/oauth/token
Authorization: Basic YXRvb…
Content-Type: application/x-www-form-urlencoded
grant_type=password&username=jan.novak@example.com&password=ABCDEFGHIJKL&tid=999888
Příklad odpovědi:
{ "access_token": "eyJh…", // access token used in authenticated API requests "token_type": "bearer", "refresh_token": "GciO…", "expires_in": 3600, "scope": "read write", "tid": "999888", }
Obnovení tokenu
Po vypršení platnosti access_tokenu je k dispozici refresh_token.
Příklad požadavku:
POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvb…
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Typ bezpečnostního schématu
HTTP
Vytvoření tasku
Zavolejte koncový bod POST /v1/tasks/TRANSACTION a použijte CreateCloudTaskTransactionApiRequest s následujícími údaji vyplněnými k vytvoření požadavku:
Proměnná
MANDATORY
MANDATORY
MANDATORY
MANDATORY
Formát
Popis
Příklad: „Faktura 37364FD“
Příklad
Obsah odpovědi [CloudTaskDetailApiResponse]:
Možné kódy odpovědí jsou:
Odpověd
Zpráva
Popis
Jak se zachovat
Níže naleznete proměnné použité v odpovědi:
Proměnná
Formát
Popis
Příklad
RC200
RC403
RC406
RC502
Kontrola stavu tasku
V dalším kroku budete kontrolovat stav tasku na koncovém bodu GET /v1/tasks/{taskID} pomocí požadavku, který zahrnuje:
Proměnná
Formát
Popis
Příklad
Možné návratové kódy:
Odpověd
Zpráva
Zpráva
Popis
Proměnné v odpovědi:
Proměnná
Formát
Popis
Příklad
RC200
RC404
Požadavek na stav tasku by se měl opakovat, dokud nezískáte jeden z konečných kódů odpovědi, kterými jsou:
Stav
Popis
Jak se zachovat
Dalším krokem můžete pokračovat pouze tehdy, když je odpověď ve stavu COMPLETED.
Získání výsledku uzávěrky
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é:
Proměnná
Formát
Popis
Příklad
Možné kódy odpovědí jsou:
Odpověd
Zpráva
Zpráva
Popis
Odpověď obsahuje následující proměnné v závislosti na kódu odpovědi:
Proměnná
Formát
Popis
-closeBatchNumber (string) - closeBatchNumber podřízené dávky
- totalCount (number) - Celkový počet transakcí v dávce
- saleCount (number) - Počet transakcí typu prodej v dávce
- saleAmount (number) - Objem transakcí typu prodej v dávce
- voidCount (number) - Počet storen transakcí
- voidAmount (number) - Objem storen transakcí v dávce