Skip to main content
API docs by Redocly

Metódy terminálového REST API – CloudPOS (2.0)

Terminálové REST API slúžia na internetové prepojenie pokladničného alebo iného obchodného systému s platobným terminálom od Comgate. Umožňuje na diaľku zadávať pokyny terminálu, typicky pre začatie platby a následné zistenie jej výsledku. V terminálovom REST API podporujeme iba dátový formát JSON. Proces spracovania jednej transakcie sa obvykle skladá z nasledujúcich krokov:

Založenie platby (povinný krok)
Pokladničný systém zavolá metódu POST /v2.0/terminalPayment.json a odovzdá jej povinné údaje: čiastku (price), menu (curr), popr. je možné doplniť referenciu platby/variabilný symbol (refId). Pokiaľ je požiadavka v poriadku, API vráti unikátny identifikátor transakcie transId. Tento kód v pokladničnom systéme uložte, je kľúčový pre všetky ďalšie operácie s touto platbou.

Zistenie stavu platby (voliteľný krok)
Pokladničný systém môže zisťovať výsledok platby na termináli. Opakovane volajte metódu GET /v2.0/terminalPayment/transId/{transId}.json, kým sa stav (status) nezmení z 'PENDING' na finálnu hodnotu. Možné finálne stavy sú:

  • PAID – platba prebehla úspešne,
  • CANCELLED – platba bola zrušená, zamietnutá, neprebehla korektne alebo vypršal čas.
Storno platby (voliteľný krok)
Pokiaľ potrebujete už zaplatenú transakciu zrušiť (napr. pri okamžitom vrátení tovaru), môžete použiť metódu DELETE /v2.0/terminalPayment/transId/{transId}.json. Storno je možné uskutočniť iba pri platbách v stave 'PAID' a iba do vykonania uzávierky na termináli.

CloudPOS Terminal Flow

Doplnkové metódy

Stav terminálu
Volaním metódy GET /v2.0/terminal.json môžete overiť, či je terminál online.

Uzávierka
Metóda POST /v2.0/terminalClosing.json slúži na vykonanie uzávierky, ktorá vráti súhrnné informácie o transakciách vykonaných od predchádzajúcej uzávierky a vymaže históriu transakcií v termináli.

Zabezpečenie a autorizácia

Pre zaistenie integrity a dôvernosti prenášaných dát prebieha všetka komunikácia výhradne cez šifrovaný protokol. Prístup ku všetkým metódam API môže byť povolený iba z vopred schválených IP adries. V takom prípade budú požiadavky z iných IP adries zamietnuté. Každá požiadavka musí tiež obsahovať autorizačnú hlavičku vo formáte: Authorization: Basic [base64_encode(merchant:secret)]. Parameter 'merchant' je váš prihlasovací identifikátor k terminálu a 'secret' je heslo. Tieto údaje spolu s možnosťami nastavenia povolených IP adries pre prístup k API nájdete v Klientskom portáli v sekcii Integrácia – Nastavenie obchodov – Terminály.

UPOZORNENIE

V súčasnej dobe pripravujeme ďalšie metódy pre prácu s predautorizáciami a MOTO platbami.

Založenie platby

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Request Body schema: application/json

Vytvorenie novej platby.

price
required
integer <int32>

Cena za produkt v centoch alebo halieroch. Napríklad pre platbu 10 EUR je treba použiť hodnotu '1000'.
Musí byť min. 1 CZK; 0,1 EUR.
Max. 1 000 000 CZK; 40 000 EUR.

curr
required
string

Kód meny podľa ISO 4217. K dispozícii sú meny: EUR, CZK.

refId
string

Parameter vhodný na zadanie variabilného symbolu alebo čísla objednávky na strane Klienta (nemusí byť unikátne, tzn. možno založiť viac platieb s rovnakým refId). V Klientskom portáli a denným csv je parameter označený ako ID Klienta.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1107 cena platby nie je podporovaná
1200 databázová chyba
1301 neznámy terminál
1309 nesprávna čiastka
1310 neznáma mena
1399 neočakávaný výsledok z databázy
1400 chybná požiadavka
1500 neočakávaná chyba

message
required
string
transId
string

Unikátny alfanumerický identifikátor (kód) transakcie.

Request samples

Content type
application/json
{
  • "price": 1000,
  • "curr": "CZK",
  • "refId": "2010102600"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "transId": "AB12-CD34-EF56"
}

Stav platby

Získanie stavu platby eventuálne s detailnými dátami o transakcii (ak sú k dispozícii).

path Parameters
transId
required
string
Example: AAAA-BBBB-CCCC

Unikátny alfanumerický identifikátor (kód) transakcie (transactionId).

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy.

message
required
string

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1200 databázová chyba
1400 chybný dotaz
1500 neočakávaná chyba

v prípade code = 0 sú v odpovedi nasledujúce parametre:

price
required
string

Cena za produkt v centoch alebo halieroch. Napríklad pri platbe 10 EUR bude vrátená hodnota '1000'.

curr
required
string

Kód meny podľa ISO 4217.

refId
required
string

Referencia platby (variabilný symbol).

transId
required
string

Unikátny alfanumerický identifikátor (kód) transakcie (transactionId).

status
required
string

Aktuálny stav transakcie, hodnoty:
PENDING – platba je založená, finálny výsledok nie je známy
PAID – platba bola úspešne zaplatená
CANCELLED – platba nebola dokončená korektne a je zrušená
AUTHORIZED – vyžiadaná predautorizácia prebehla úspešne

fee
string

Spočítaný poplatok za transakciu v centoch alebo halieroch, prípadne môže obsahovať hodnotu 'unknown'. Poplatky za platby sú dostupné v response najskôr druhý deň na základe reportov spracovateľov platby.

cardValid
string

Expirácia karty platiteľa vo formáte MM/RR (pokiaľ bola karta použitá). Príklad: '04/28'.

cardNumber
string

Čiastočné číslo karty platiteľa (pokiaľ bola karta použitá).

paymentErrorReason
string

Dôvod zamietnutia platby (ak je k dispozícii).

reversed
required
boolean

Príznak, či bola platba reverzovaná (stornovaná).

amountRefunded
string

Refundovaná čiastka v centoch alebo halieroch.

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/terminalPayment/transId/{transId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "price": "1000",
  • "curr": "CZK",
  • "refId": "2010102600",
  • "transId": "AB12-CD34-EF56",
  • "status": "PAID",
  • "fee": "string",
  • "cardValid": "04/28",
  • "cardNumber": "string",
  • "paymentErrorReason": "string",
  • "reversed": true,
  • "amountRefunded": "string"
}

Storno platby

Storno platby
Platbu je možné zrušiť, pokiaľ nie je na termináli vyvolaná uzávierka. Platba musí byť úspešne dokončená (v stave 'PAID').
Ak už bola na termináli medzitým vyvolaná uzávierka, zobrazí sa chyba a je nutné použiť metódu 'refund' (ak je to možné).
'code' = 0 odpovede značí úspešné založenie reversalu. Overenie skutočného vykonania zrušenia overíte volaním endpointu Stav platby.

path Parameters
transId
required
string
Example: AAAA-BBBB-CCCC

Unikátny alfanumerický identifikátor (kód) transakcie (transactionId).

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1400 nie je možné prepnúť platbu do cancelled stavu (platba nenájdená, platba nie je v stave paid, neoprávnený prístup)

message
required
string

Request samples 

# You can also use wget
curl -X DELETE https://payments.comgate.cz/v2.0/terminalPayment/transId/{transId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK"
}

Stav terminálu

Zistenie stavu terminálu.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
status
required
string

Stav testu pripojenia k autorizačnému serveru.
'ONLINE' – terminál je pripojený k autorizačnému serveru
'OFFLINE' – terminál nie je pripojený k autorizačnému serveru
'BUSY' – terminál zpracovává transakci
'UNKNOWN' – stav pripojenia nie je možné skontrolovať alebo je terminál nedostupný

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/terminal.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "status": "ONLINE"
}

Uzávierka

Vykoná uzávierku na termináli. Pri uzávierke dôjde k vymazaniu histórie transakcií v termináli.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
code
required
integer

0 - OK, inak podrobnosti v parametri 'message'.

message
required
string

OK alebo textový popis výsledku uzávierky.

batchNumber
integer

Číslo uzávierky.

Array of objects

Zoznam súhrnov uzávierky podľa mien.

Request samples 

# You can also use wget
curl -X POST https://payments.comgate.cz/v2.0/terminalClosing.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5' \
-H 'Content-Type: application/json'

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "batchNumber": 1,
  • "batchData": [
    ]
}

Založenie návratu

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Request Body schema: application/json

Vytvoriť nový návrat.

price
required
integer <int32>

Hodnota návratu v centoch alebo halieroch. Napríklad pre návrat 10 EUR je treba použiť hodnotu '1000'.
Musí byť min. 1 CZK; 0,1 EUR.
Max. 1 000 000 CZK; 40 000 EUR.

curr
required
string

Kód meny podľa ISO 4217. K dispozícii sú meny: EUR, CZK.

refId
string

Parameter vhodný na zadanie variabilného symbolu alebo čísla objednávky na strane Klienta (nemusí byť unikátne, tzn. možno založiť viac platieb s rovnakým refId). V Klientskom portáli a denným csv je parameter označený ako ID Klienta.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1107 cena návratu nie je podporovaná
1200 databázová chyba
1301 neznámy terminál
1309 nesprávna čiastka
1310 neznáma mena
1399 neočakávaný výsledok z databázy
1400 chybná požiadavka
1500 neočakávaná chyba

message
required
string
transId
string

Unikátny alfanumerický identifikátor (kód) transakcie.

Request samples

Content type
application/json
{
  • "price": 1000,
  • "curr": "CZK",
  • "refId": "2010102600"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "transId": "AB-CD123-EF456"
}

Stav návratu

Získanie stavu návratu eventuálne s detailnými dátami o transakcii (ak sú k dispozícii).

path Parameters
transId
required
string
Example: AA-BBBBB-CCCCC

Unikátny alfanumerický identifikátor (kód) transakcie (transactionId).

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy.

message
required
string

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1200 databázová chyba
1400 chybný dotaz
1500 neočakávaná chyba

v prípade code = 0 sú v odpovedi nasledujúce parametre:

price
required
string

Hodnota návratu v centoch alebo halieroch. Napríklad pri návratu 10 EUR bude vrátená hodnota '1000'.

curr
required
string

Kód meny podľa ISO 4217.

refId
required
string

Referencia návratu.

transId
required
string

Unikátny alfanumerický identifikátor (kód) transakcie (transactionId).

status
required
string

Aktuálny stav návratu, hodnoty:
PENDING – návrat je založen, finálny výsledok nie je známy
PAID – návrat bol úspešne zaplaten
CANCELLED – návrat nebol dokončen korektne a je zrušen

cardNumber
string

Čiastočné číslo karty platiteľa (pokiaľ bola karta použitá).

reversed
required
boolean

Príznak, či bol návrat reverzovaný (stornovaný).

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/terminalRefund/transId/{transId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "price": "1000",
  • "curr": "CZK",
  • "refId": "2010102600",
  • "transId": "AB-CD123-EF456",
  • "status": "PAID",
  • "cardNumber": "string",
  • "reversed": true
}

Storno návratu

Storno návratu
Návrat je možné zrušiť iba v rovnaký deň prevedenia. Návrat musí byť úspešne dokončený (v stave 'PAID').
'code' = 0 odpovede značí úspešné založenie reversalu. Overenie skutočného vykonania zrušenia overíte volaním endpointu Stav návratu.

path Parameters
transId
required
string
Example: AA-BBBBB-CCCCC

Unikátny alfanumerický identifikátor (kód) transakcie (transactionId).

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1400 nie je možné prepnúť návrat do cancelled stavu (návrat nenájdený, návrat nie je v stave paid, neoprávnený prístup)

message
required
string

Request samples 

# You can also use wget
curl -X DELETE https://payments.comgate.cz/v2.0/terminalRefund/transId/{transId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK"
}

Zoznam prevodov

Metóda transferList slúži na získanie informácie, aké prevody boli uskutočnené v rámci daného dňa. Informacije o bančnem prenosu (poslanem prejšnji delovni dan) so na voljo v dopoldanskih urah naslednjega dne.
Prevody a výpisy sa generujú iba pre zaplatené a prevedené produkčné platby. Pre všetky ostatné platby, vrátane testovacích, sa prevody a výpisy negenerujú.

path Parameters
date
required
string
Example: 2025-04-25

Uveďte dátum uskutočnenia prevodu.

query Parameters
test
boolean
Example: test=false

Ak vyplníte 'true', metóda vráti vopred definovaný vzorový prevod.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
Array
transferId
integer

Prevody, ktoré boli uskutočnené v rámci daného dňa.

transferDate
string <date>

Parametre date a transferDate sú interpretované v časovom pásme Europe/Prague (CET/CEST v závislosti od dátumu).

accountCounterparty
string

Číslo účtu protistrany.

accountOutgoing
string

Odchádzajúce číslo účtu.

variableSymbol
string

Identifikátor platby (variabilný symbol).

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/transferList/date/{date}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
[
  • {
    }
]

Informácie o prevode

Metóda singleTransfer zobrazuje detailné informácie ku konkrétnemu bankovému prevodu.
Povinný parameter 'transferId' získa obchodník pomocou metódy transferList.
Dátumové parametre sa interpretujú v časovom pásme Europe/Prague (CET/CEST v závislosti od dátumu).
Prevody a výpisy sa generujú iba pre zaplatené a prevedené produkčné platby. Pre všetky ostatné platby, vrátane testovacích, sa prevody a výpisy negenerujú.

path Parameters
transferId
required
string
Example: 1234567

Uveďte prevody, ktoré boli uskutočnené v rámci daného dňa. Zoznam získate pomocou metódy transferList.

query Parameters
test
boolean
Example: test=false

Vhodné na testovanie – Ak je hodnota true, vrátia sa detaily k vopred definovaným vzorovým prevodom.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
Array
typ
integer

Parameter označuje typ prevodu.

Merchant
string

Identifikátor e-shopu v systéme Comgate.

Datum založení
string

Dátum založenia transakcie.

Datum zaplacení
string

Dátum zaplatenia transakcie.

Datum převodu
string

Dátum vyplatenia hromadného prevodu transakcií.

Měsíc fakturace
integer

Mesiac, ku ktorému sa platba účtovne vzťahuje.

ID Comgate
string

Comgate ID platby, 12-miestny kód, jedinečná identifikácia platby.

Metoda
string

Výsledná metóda platby.

Produkt
string

Ľubovoľný identifikátor produktu, ktorý váš systém posiela pri založení platby pod parametrom 'name'.

Popis
string

Krátky popis produktu (1–16 znakov), ktorý váš systém posiela pri založení platby pod parametrom 'label'.

E-mail plátce
string

E-mail platiteľa platby.

Variabilní symbol plátce
string

Variabilný symbol pridelený platbe.

Variabilní symbol převodu
string

Variabilný symbol hromadného prevodu.

ID od klienta
string

Párovací symbol, pomocou ktorého identifikujete tovar a zákazníka, ktorý si ho objednal (napr. číslo objednávky, číslo zákazníka atď.). V rámci API protokolu je to parameter RefId, ktorý systém posiela pri založení platby.

Měna
string

Mena platby. Hodnota je vo formáte ISO 4217.

Potvrzená částka
string

Suma realizovanej transakcie (výška zákazníkovej objednávky).

Převedená částka
string

Suma, ktorá je e-shopu štandardne zaslaná na bankový účet (znížená o poplatok z transakcie).

Poplatek celkem
string

Celkový poplatok za platbu podľa platného cenníka. Poplatok celkom = medzibankový poplatok + poplatok asociácie + poplatok spracovateľa.

Poplatek mezibankovní
string

Poplatok, ktorý dostáva vydavateľ platobnej karty.

Poplatek asociace
string

Poplatok, ktorý z transakcie obdrží kartová asociácia.

Poplatek zpracovatel
string

Poplatok, ktorý si účtuje spracovateľ transakcie.

Typ karty
string

Typ použitej platobnej karty pri platbe kartou.

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/singleTransfer/transferId/{transferId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
[
  • {
    }
]

CSV denný výpis

Vďaka metóde csvSingleTransfer si možno stiahnuť denný výpis vo formáte CSV.
Prevody a výpisy sa generujú iba pre zaplatené a prevedené produkčné platby. Pre všetky ostatné platby, vrátane testovacích, sa prevody a výpisy negenerujú.

path Parameters
transferId
required
string
Example: 1234567

Uveďte prevody, ktoré boli uskutočnené v rámci daného dňa. Zoznam získate pomocou metódy transferList.

query Parameters
download
boolean
Example: download=false

Ak nie je vyplnené alebo je false, vracia dáta: názov súboru a jeho obsah; ak je true, vracia rovno CSV súbor.

test
boolean
Example: test=false

Ak je hodnota true, vráti ukážkový CSV súbor.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
nazev
string

Názov stiahnutého súboru CSV

csv
string

Súbor CSV s kódovaním Base64

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/csvSingleTransfer/transferId/{transferId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "nazev": "vypis-YYYY-MM-DD.csv",
  • "csv": "base64 encoded csv"
}

ABO denný výpis

Vďaka metóde aboSingleTransfer si možno stiahnuť denný výpis vo formáte ABO.
Prevody a výpisy sa generujú iba pre zaplatené a prevedené produkčné platby. Pre všetky ostatné platby, vrátane testovacích, sa prevody a výpisy negenerujú.

path Parameters
transferId
required
string
Example: 1234567

Uveďte prevody, ktoré boli uskutočnené v rámci daného dňa. Zoznam získate pomocou metódy transferList.

query Parameters
download
boolean
Example: download=true

Ak nie je vyplnené alebo je false, vracia dáta: názov súboru a jeho obsah; ak je true, vracia rovno ABO súbor.

type
string
Example: type=v1

Parameter 'type' môže nadobúdať hodnoty 'v1' a ''v2'. Pod 'v1'' získate ABO verziu s poplatkami uvedenými zvlášť ku každej platbe, pod 'v2' potom ABO so súhrnným poplatkom v jednom riadku. Pokiaľ nebude parameter vyplnený, automaticky obdržíte typ 'v1'.

encoding
string
Example: encoding=utf8

Kódovanie znakov môže byť utf8 alebo win1250. Ak hodnota nie je vyplnená, predvolená hodnota parametra je utf8.

test
boolean
Example: test=false

Ak je hodnota true, vráti ukážkový ABO súbor.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/json
nazev
string

Názov súboru.

abo
string

Base64 kódovaný súbor abo/gpc.

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/aboSingleTransfer/transferId/{transferId}.json \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Response samples

Content type
application/json
{
  • "nazev": "vypis-YYYY-MM-DD.gpc",
  • "abo": "base64_encoded_abo_file"
}

Stiahnutie CSV súborov

Priame preberanie CSV súborov pre konkrétny deň metódou csvDowload. Stiahnutý súbor vo formáte ZIP bude obsahovať jeden alebo viac súborov CSV, ak je viac prevodov v rámci dňa. Možno využiť napr. na volanie pomocou wget.
Prevody a výpisy sa generujú iba pre zaplatené a prevedené produkčné platby. Pre všetky ostatné platby, vrátane testovacích, sa prevody a výpisy negenerujú.

path Parameters
date
required
string
Example: 2025-04-25

Povinný len za jeden deň.

query Parameters
test
boolean
Example: test=false

Ak je hodnota true, vráti ukážkový CSV súbor vo formáte ZIP.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/zip
string <binary>

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/csvDownload/date/{date} \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'

Stiahnutie ABO súborov

Priame preberanie ABO súborov pre konkrétny deň metódou aboDowload. Stiahnutý súbor vo formáte ZIP bude obsahovať jeden alebo viac súborov ABO. Možno využiť napr. na volanie pomocou wget.
Prevody a výpisy sa generujú iba pre zaplatené a prevedené produkčné platby. Pre všetky ostatné platby, vrátane testovacích, sa prevody a výpisy negenerujú.

path Parameters
date
required
string
Example: 2025-04-25

Povinný len za jeden deň.

query Parameters
type
string

Parameter 'type' môže nadobúdať hodnoty 'v1' a 'v2'. Pod 'v1' získate ABO verziu s poplatkami uvedenými zvlášť ku každej platbe, pod 'v2' potom ABO so súhrnným poplatkom v jednom riadku. Pokiaľ nebude parameter vyplnený, automaticky obdržíte typ 'v1'.

encoding
string
Example: encoding=utf8

Kódovanie znakov môže byť utf8 alebo win1250. Ak hodnota nie je vyplnená, predvolená hodnota parametra je utf8.

test
boolean
Example: test=false

Ak je hodnota true, vráti ukážkový CSV súbor vo formáte ZIP.

header Parameters
authorization
required
string

Autorizačná hlavička je v tvare: Authorization: Basic [base64_encode(merchant:secret)]. Merchant je login identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Integrácia - Nastavenie obchodov - Terminály. Secret je heslo.

Responses

Response Schema: application/zip
string <binary>

Request samples 

# You can also use wget
curl -X GET https://payments.comgate.cz/v2.0/aboDownload/date/{date} \
-H 'Authorization: Basic MTIzNDU2Omd4NHE4T1YzVEp0Nm5vSm5maGpxSkt5WDNaNlljaDB5'