Skip to main content
API docs by Redocly

API metódy platby (2.0)

V REST variante API podporujeme iba dátové formáty JSON a XML. Formát multipart/form-data nie je podporovaný.

create

Prístup je chránený validáciou IP adresy a integrita odovzdávaných dát je zabezpečená použitím HTTPS protokolu.
Server platobnej brány zodpovedá len v prípade, že je platba zakladaná na pozadí. Všetky parametre sú 'urlencoded', rovnako ako v prípade HTTP requestu. Ak je platba založená presmerovaním, potom server platobnej brány rovno presmeruje Platiteľ na príslušnú URL alebo zobrazí chybové hlásenie.

Výber platobnej metódy
V rámci nákupného procesu v e-shope je možné zobraziť plátcovi výber platebných metód a na základe jeho výberu založiť platbu s konkrétnou metódou. V momente, keď je plátcovi zobrazená platobná brána, automaticky sa zobrazí predom vybraná platobná metóda. Nastavenie vybranej platobnej metódy je možné vyplnením parametra 'method'. Prostredníctvom tohto parametra je možné platobné metódy aj rôzne filtrovať.
Viac tu: https://apidoc.comgate.cz/sk/metody-platebni-brany/

Predautorizácia
Platobná brána umožňuje zadávať, potvrdzovať a rušiť predautorizácie platieb kartou. Založenie platby sa uskutočňuje štandardne, len je potrebné uviesť parameter 'preauth = true'. Potom platca prejde rovnakým procesom ako v prípade normálnej platby. Potom, čo zadá svoje údaje na platobnej bráne, je na jeho platobnej karte rezervovaná príslušná suma. Podľa výsledku tejto operácie prechádza buď do zvláštneho stavu Authorized, alebo v prípade zamietnutia do stavu CANCELLED. Tento stav je ohlásený na pozadí obvyklým postupom opísaným vyššie.
Aby boli peniaze skutočne strhnuté, vyvolá e-shop funkciu na potvrdenie predautorizácie. Ak sa peniaze majú uvoľniť (napr. nie je možné naplniť podmienky kúpnej zmluvy), vyvolá funkciu na zrušenie predautorizácie.

Presmerovanie na platbu pomocou transId
Odporúčame, aby si obchodník pri založení platby vždy uložil úplnú URL adresu na presmerovanie, ktorá je vrátená v parametri redirect, a túto adresu používal na všetky budúce presmerovania (vrátane e-mailov). V núdzových prípadoch je možné platiteľa presmerovať na platobnú bránu aj prostredníctvom identifikátora transakcie transId pomocou adresy: https://payments.comgate.cz/XXXX-XXXX-XXXX. Ak však platba nebude v systéme Comgate nájdená, zobrazí sa servisná chybová stránka. Nikdy sami nemeníte, či má byť platba presmerovaná na domény pay1, pay2, pay3, pay4, pay5 alebo pay6; systém to určí automaticky pri založení platby a použitie inej subdomény môže spôsobiť nefunkčnosť platby.

Presmerovanie
Pre zakladanie platby presmerovaním použite endpoint /v2.0/paymentRedirect/merchant/{merchant_id}, s rovnakými parametrami ako pri základnej create.

UPOZORNENIE

Adresa URL a štruktúra kódu platby sa môže zmeniť. Vždy používajte adresu vrátenú rozhraním API a nemanipulujte s ňou. Ak chcete platobný kód uložiť, použite parameter transId. Nikdy neparazitujte na údajoch z konkrétnych pozícií v texte, tie sa tiež môžu zmeniť.

Všetky hodnoty obsahujúce špeciálne znaky musia byť v UTF-8.

header Parameters
authorization
required
string

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

Request Body schema: application/json

Vytvorenie novej platby

test
boolean
Default: false

Hodnota 'true' znamená, že platba bude založená ako testovacia, hodnota 'false' znamená produkčnú verziu. Ak parameter chýba, založí sa platba ako produkčná.

country
string

Možné hodnoty: ALL, AT, BE, CY, CZ, DE, EE, EL, ES, FI, FR, GB, HR, HU, IE, IT, LT, LU, LV, MT, NL, NO, PL, PT , RO, SI, SK, SE, US. Ak parameter chýba, použije sa automaticky 'CZ'. Parameter slúži na obmedzenie výberu platobných metód na platobnej bráne. Je potrebné aby bola zvolená správna kombinácia parametrov 'country' a 'curry' (mena) pre daný región. Napríklad na zobrazenie českých tlačidiel a platby kartou v mene CZK zvoľte kombináciu country = CZ a curry = CZK. Pri slovenských bankových tlačidlách a platbe kartou v EUR zvoľte country = SK a curry = EUR. Pre poľské bankové tlačidlá a platbu kartou v PLN zvoľte country = PL a curry = PLN. Pre ostatné cudzie meny môžete použiť parameter country = ALL alebo ďalší kód krajiny, ktorý platobná brána prijíma.

price
required
integer <int32>

Cena za výrobok v centoch alebo halieroch. Pre menu HUF nemôžete zadať cenu s desatinnými miestami. V tomto prípade musí cena vždy končiť 00.
Musí byť min. 1 CZK; 0,1 EUR; 1 PLN; 100 HUF; 1 USD; 1 GBP; 5 RON; 0,5 NOK; 0,5 SEK.
Max. 1 000 000 CZK; 40 000 EUR; 170 000 PLN; 12 500 000 HUF; 45 000 USD; 35 000 GBP; 190 000 RON; 400 000 NOK; 390 000 SEK.

curr
required
string

Kód meny podľa ISO 4217. K dispozícii sú meny: EUR, CZK, PLN, HUF, USD, GBP, RON, NOK, SEK.

label
required
string

Krátky popis produktu (1-16 znakov) - podľa tejto položky je možné filtrovať platby v Klientskom portáli.

refId
required
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.

method
required
string

Metóda platby z tabuľky platobných metód, hodnota 'ALL' v prípade, že si má metódu vybrať platiteľa alebo jednoduchý výraz s výberom metód.
Viac tu: https://apidoc.comgate.cz/sk/metody-platebni-brany/

account
string

Identifikátor bankového účtu Klienta, na ktorý Comgate prevedie peniaze. Ak parameter nevyplníte, použije sa predvolený účet Klienta. Zoznam účtov Klienta nájdete na https://portal.comgate.cz/.

email
required
string

Kontaktný email platiteľa. Povinný je len jeden z údajov, emailová adresa alebo telefónne číslo.

phone
required
string

Telefónne číslo platiteľa v medzinárodnom formáte +420777112233. Povinný je len jeden z údajov, emailová adresa alebo telefónne číslo.

fullName
required
string

Meno a priezvisko plátcu, napr. Josef Novák.

billingAddrCity
string

Fakturačná adresa - mesto. (napr. Hradec Králové).

billingAddrStreet
string

Fakturačná adresa - ulica. (napr. Jiráskova 115).

billingAddrPostalCode
string

Fakturačná adresa - PSČ. (napr. 50304).

billingAddrCountry
string

Fakturačná adresa - krajina, vo formáte ISO 3166 alpha-2 (napr. CZ, SK, US, GB).

delivery
string

Spôsob doručenia - jedna z dostupných možností: HOME_DELIVERY, PICKUP, ELECTRONIC_DELIVERY. Možnosť PICKUP zahŕňa všetky miesta na vyzdvihnutie, vyzdvihovacie boxy, atď.

homeDeliveryCity
string

Doručovacia adresa - mesto. Vyplňuje sa len v prípade delivery=HOME_DELIVERY (napr. Hradec Králové).

homeDeliveryStreet
string

Doručovacia adresa - ulica. Vyplňuje sa len v prípade delivery=HOME_DELIVERY (napr. Štefanikova 421).

homeDeliveryPostalCode
string

Doručovacia adresa - PSČ. Vyplňuje sa len v prípade delivery=HOME_DELIVERY (napr. 50341).

homeDeliveryCountry
string

Doručovacia adresa - krajina, vo formáte ISO 3166 alpha-2. Vyplňuje sa len v prípade delivery=HOME_DELIVERY (napr. CZ, SK, US, GB).

category
string

Kategória produktu v košíku - jedna z dostupných možností, ktorá najlepšie popisuje košík: PHYSICAL_GOODS_ONLY, OTHER. Možnosť OTHER zahŕňa darčekové karty, poukážky alebo služby.

name
string

Identifikátor produktu - táto položka sa nachádza v dennom csv. Klienta pod názvom Produkt.

lang
string

Kód jazyka (ISO 639-1), v ktorom budú Platiteľovi zobrazené inštrukcie na dokončenie platby, štandardne povolené hodnoty ('bg', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'hr', 'hu', 'it', 'lt', 'lv', 'nl', 'no', 'pl', 'pt', 'ro', 'ru', 'sl', 'sk', 'sv', 'uk', 'vi'), ak parameter chýba, použije sa 'cs' v prípade požiadavky na ďalší jazyk, kontaktujte podpora@comgate.cz.

preauth
boolean

V prípade požiadavky na predautorizáciu platby kartou nastavte na 'true'. V prípade normálnej platby vyplňte 'false' alebo parameter nepoužívajte. Len na platby kartou.

initRecurring
boolean

Príznak pre založenie iniciačnej transakcie pre opakované platby. Len pre Klientov, ktorí majú službu povolenú.

verification
boolean

Parameter overovacej platby, v prípade požiadavky na založenie overovacej platby (hodnota 'true') nie je nutné posielať parameter 'initRecurring'.

expirationTime
string

Délka expirace platby. Povolená hodnota je celé číslo následované písmenem zvolené časové jednotky: 'm' (minuty), 'h' (hodiny) nebo 'd' (dny). Například '30m' (30 minut) nebo '10h' (10 hodin) nebo '2d' (2 dny). Jednotky nelze kombinovat. Výsledná délka musí být v rozmezí 30 minut až 7 dní. Pokud není vyplněno, použije se hodnota v nastavení obchodu zvolená v Klientském portálu.

dynamicExpiration
boolean

Hodnota 'true' znamená, že u platby bude použita dynamická expirace, hodnota 'false' znamená, že dynamická expirace použita nebude. Pokud není vyplněno, použije se hodnota v nastavení obchodu zvolená v Klientském portálu.

url_paid
string

Posamezne nastavitve za posamezna plačila. Na primer: 'https://www.example.com/result.php?id=${id}&refId=${refId}'

url_cancelled
string

Posamezne nastavitve za posamezna plačila. Na primer: 'https://www.example.com/result.php?id=${id}&refId=${refId}'

url_pending
string

Posamezne nastavitve za posamezna plačila. Na primer: 'https://www.example.com/result.php?id=${id}&refId=${refId}'

chargeUnregulatedCardFees
boolean

Pomocou tohto parametra zapnete alebo vypnete prenos poplatkov na platiteľa pri platbe neregulovanou kartou a zároveň vypnete metódu Apple Pay a Google Pay (ak nie je parametrom 'enableApplePayGooglePay' nastavené inak). Povolené hodnoty sú 'true' alebo 'false'.
Použitie tohto parametra je možné len po schválení a zapnutí zo strany Comgate. Nie všetky e-commerce riešenia tento parameter podporujú.

Viac informácií o prenesení poplatkov nájdete na stránke podpory.

enableApplePayGooglePay
boolean

Nastavte na 'false' pre vypnutie platobnej metódy Apple Pay a Google Pay pre konkrétnu platbu, aj keď sú tieto metódy vo vašom nastavení účtu povolené.
Nastavte na 'true' pre zapnutie platobnej metódy Apple Pay a Google Pay pre konkrétnu platbu, aj keď je použitý parameter 'chargeUnregulatedCardFees'.
Ak je použitý parameter 'chargeUnregulatedCardFees', tak je predvolená hodnota parametra 'enableApplePayGooglePay' 'false'. V opačnom prípade je predvolená hodnota 'true'.

threeDSPreference
string

Preferencia 3D Secure overenia kartových platieb. Povolené hodnoty sú 'AUTO' alebo 'FAST'.

FAST: Pri vybraných nízkorizikových platbách Comgate zrýchli priechod platbou bez zbytočného presmerovania na 3DS. Ak transakcia nesplní bezpečnostné pravidlá, automaticky spadne do režimu Automatické 3DS.
AUTO: Štandardný režim. Comgate použije 3DS podľa pravidiel kartových schém, regulácie a vyhodnotenia transakcie.

Ak parameter nie je zaslaný, použije sa nastavenie Dynamické riadenie 3DS v Klientskom portáli.

Táto služba je spoplatnená podľa vášho platného cenníka alebo cenníka doplnkových služieb.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1102 zadaný jazyk nie je podporovaný
1103 nesprávne zadaná metóda
1104 nemožno načítať platbu
1107 cena platby nie je podporovaná
1200 databázová chyba
1301 neznámy e-shop
1303 prepojenie alebo jazyk chýba
1304 neplatná kategória
1305 chýba popis produktu
1306 vyberte správnu metódu
1308 vybraný spôsob platby nie je povolený
1309 nesprávna čiastka
1310 neznáma mena
1311 neplatný identifikátor bankového účtu Klienta
1316 e-shop nemá povolené opakované platby
1317 neplatná metóda - nepodporuje opakované platby
1319 nemožno založiť platbu, problém na strane banky
1399 neočakávaný výsledok z databázy
1400 chybná otázka
1500 neočakávaná chyba

message
required
string
transId
string

Unikátny alfanumerický identifikátor (kód) transakcie, ktorý bude zobrazený Platiteľmi v rôznych fázach platby.

redirect
string

URL stránka, kam má byť Platiteľ presmerovaný na realizáciu platby.

Request samples

Content type
application/json
{
  • "test": true,
  • "country": "string",
  • "price": 1000,
  • "curr": "CZK",
  • "label": "Product 123",
  • "refId": "order445566",
  • "method": "ALL",
  • "account": "string",
  • "email": "platce@email.com",
  • "phone": "string",
  • "fullName": "Jan Novák",
  • "billingAddrCity": "string",
  • "billingAddrStreet": "string",
  • "billingAddrPostalCode": "string",
  • "billingAddrCountry": "string",
  • "delivery": "HOME_DELIVERY",
  • "homeDeliveryCity": "string",
  • "homeDeliveryStreet": "string",
  • "homeDeliveryPostalCode": "string",
  • "homeDeliveryCountry": "string",
  • "category": "PHYSICAL_GOODS_ONLY",
  • "name": "string",
  • "lang": "string",
  • "preauth": true,
  • "initRecurring": true,
  • "verification": true,
  • "expirationTime": "string",
  • "dynamicExpiration": true,
  • "url_paid": "string",
  • "url_cancelled": "string",
  • "url_pending": "string",
  • "chargeUnregulatedCardFees": true,
  • "enableApplePayGooglePay": true,
  • "threeDSPreference": "string"
}

Response samples

Content type
application/json
{}

cancel

Storno platby
V prípade, že bola objednávka v e-shope stornovaná a transakcia nemá byť platcom dokončená, je možné využiť storno platby. Na rozdiel od refundácie musí byť platba v stave očakávaná (pending).
Vzhľadom na rýchlosť zaplatenia platieb môže byť platba už v stave zaplatená, v takom prípade sa zobrazí chyba a je nutné využiť metódu refundácie.

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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 cancel stavu (platba nenájdená, platba nie je v stave pending, neoprávnený prístup)

message
required
string

Request samples 

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

Response samples

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

status

Získanie stavu platby na pozadí
Analogická funkcia pre odovzdanie výsledku platby na pozadí, iba iniciovaná Obchodom. Nenahrádza však odovzdanie stavu platby na pozadí, jej implementácia je stále povinná.
Odpoveď endpointu môže obsahovať aj ďalšie polia zodpovedajúce parametrom špecifikovaným pri vytváraní platby (/create).

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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á otázka
1500 neočakávaná chyba

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

test
required
string

Hodnota 'true' znamená, že platba bola založená ako testovacia, hodnota 'false' znamená produkčnú verziu.

price
required
string

cena za výrobok v centoch alebo halieroch

curr
required
string

kód meny podľa ISO 4217

label
required
string

krátky popis produktu (1 – 16 znakov)

refId
required
string

referencia platby v systéme e-shopu

payerId
string

identifikátor Platiteľa v systéme e-shopu

method
string

použitá metóda platby, z tabuľky platobných metód

account
string

identifikátor bankového účtu e-shopu, na ktorý Comgate prevedie peniaze

email
required
string

kontaktný email na Platiteľa

name
string

Identifikátor produktu - podľa tejto položky je potom možné sa zorientovať v štatistikách platieb Comgate platobného systému.

phone
string

Telefonska številka plačnika, če je na voljo

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

payerName
string

odovzdanie mena účtu patriacemu Platiteľovi

payerAcc
string

odovzdanie čísla účtu Platiteľa

fee
string

ak má e-shop nastavené automatické strhávanie poplatku za platbu, bude v tomto poli spočítaný poplatok za transakciu v centoch alebo halieroch, inak bude pole nadobúdať hodnotu 'unknown'

vs
string

variabilný symbol platby (nie je vždy k dispozícii)

cardValid
string

expirácia karty platiteľa dostupná pri opakovaných iniciačných platbách okrem Apple Pay a Google Pay

cardNumber
string

čiastočné číslo karty platiteľa dostupné pri opakovaných iniciačných platbách

appliedFee
integer

Výška príplatku aplikovaná za neregulované typy kariet.

appliedFeeType
string

Typ príplatku aplikovaného za neregulované typy kariet ako je 'EU_UNREGULATED', 'NON_EU_BUSINESS', 'NON_EU_CONSUMER' aj nepríplatkový 'EU_CONSUMER'.

paymentErrorReason
string

Dôvod zamietnutia platby, ak je k dispozícii. V prípade viacerých pokusov platiteľa o vykonaní platby sa vracia dôvod zamietnutia posledného pokusu. Možné hodnoty:
'CUSTOMER_CLICK' - Zrušené platcom
'FRAUD_SUSPECTED' - Podozrenie na podvod
'ESHOP_CANCELLED' - Zrušené obchodníkom
'PROVIDER_REPORT' - Zrušené poskytovateľom
'PROVIDER_TIMEOUT' - Vypršal časový limit poskytovateľa
'CUSTOMER_TIMEOUT' - Vypršal časový limit
'ACS_TIMEOUT' - Vypršal časový limit na overenie
'INVALID_CARDNO_EXPIRY' - Nesprávne zadané číslo karty alebo dátum platnosti karty
'INVALID_CVC' - Nesprávne zadaný CVC / CVV kód
'LIMIT_EXCEEDED' - Limit karty bol prekročený
'NO_FUNDS' - Na účte nie je dostatočný zostatok
'REJECTED_BY_BANK' - Platba bola zamietnutá bankou
'3DS_AUTH_FAIL' - Overenie platby nebolo úspešné
'BANK_TIMEOUT' - Vypršal časový limit na vykonanie platby
'BANK_FORBIDDEN' - Plátca neudelil prístup k svojim účtom
'TRANSACTION_CANCELLED' - Plátca zrušil overenie platby
'3RDPART_APP_LIMIT_EXCEEDED' - Prekročený limit transakcií pre tretie strany
'UNAVAILABLE' - Platobná metóda je dočasne nedostupná
'BAD_ACCOUNT_TYPE' - Typ účtu platiteľa nepodporuje túto platbu
'NOT_SPECIFIED' - Nešpecifikované

threeDSPreference
string

Preferencia 3D Secure uplatnená na platbu. Vracia sa iba pri kartových platbách, ak je nastavenie Dynamické riadenie 3DS pre e-shop zapnuté. Možné hodnoty: 'AUTO' (štandardné 3D Secure), 'FAST' (preferované menej náročné/frictionless 3D Secure), 'NOT_ALLOWED' (parameter bol zaslaný v /create, ale nastavenie Dynamické riadenie 3DS nie je pre e-shop zapnuté).

threeDSApplied
boolean

Informácia, či bolo na platbu skutočne uplatnené 3D Secure overenie. Vracia sa spolu s threeDSPreference pri kartových platbách, ak je nastavenie Dynamické riadenie 3DS pre e-shop zapnuté.

Request samples 

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

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "test": "false",
  • "price": "10000",
  • "curr": "CZK",
  • "label": "Beatles - Help",
  • "refId": "2010102600",
  • "payerId": "string",
  • "method": "ALL",
  • "account": "string",
  • "email": "platce@email.com",
  • "name": "string",
  • "phone": "string",
  • "transId": "AB12-CD34-EF56",
  • "status": "PAID",
  • "payerName": "string",
  • "payerAcc": "string",
  • "fee": "string",
  • "vs": "string",
  • "cardValid": "string",
  • "cardNumber": "string",
  • "appliedFee": 0,
  • "appliedFeeType": "string",
  • "paymentErrorReason": "string",
  • "threeDSPreference": "string",
  • "threeDSApplied": true
}

recurring

Opakované platby, zapamätanie kartových údajov
Platobná brána umožňuje zadávanie opakovaných platieb, t.j. platieb na jedno kliknutie. Prvá (iniciačná) platba sa uskutočňuje štandardným procesom s presmerovaním na platobnú bránu, nasledujúce platby sa už uskutočňujú kompletne na pozadí. Systém tak umožňuje platcovi zaplatiť v priebehu niekoľkých sekúnd bez nutnosti vypĺňať informácie o platobnej karte.
Táto funkcia je dostupná na vyžiadanie. V prípade opakovaných platieb na začiatku zakladáme iniciačnú platbu, ktorá sa zakladá ako bežná platba, len sa v požiadavke nachádza navyše parameter 'initRecurring' - metóda create. Následné opakované platby sú už zakladané metódou recurring a sú viazané na Comgate ID iniciačnej transakcie. Toto ID musí byť v systéme Klienta viazané na konkrétneho Platiteľa.
Po založení opakovanej platby nedochádza k presmerovaniu platcu na platobnú bránu, pretože celý proces sa uskutočňuje na pozadí, Klientovi je len odovzdaný stav založenia platby a ten následne zobrazí tento stav platcovi.

Nasledujúce opakované platby
Založenie druhej a nasledujúcej opakované platby do platobnej brány je možné len pri akceptácii kariet pre e-shopy, ktoré majú službu povolenú. Prvá (iniciačná) platba sa uskutočňuje štandardnou cestou (pozri Založenie platby). Proces založenia druhej a každej ďalšej platby sa uskutočňuje kompletne na pozadí, tieto platby sú viazané na iniciačné cez Comgate ID iniciačné platby. Toto ID sa musí nachádzať v požiadavke v parametri 'initRecurringId'. Platiteľovi je v systéme e-shopu ako výsledok zobrazený stav platby.

Všetky parametre sú urlencoded, rovnako ako v prípade HTTP requestu na založenie štandardnej platby. V odpovedi sa nachádza parameter 'code', podľa ktorého e-shop určí, aký výsledok zobrazí platcovi. code = 0 znamená úspech, platba bola vytvorená a zaplatená, akýkoľvek iný kód znamená chybu a teda nezaloženie platby.

Rekurentné platby (recurring)
Rekurentné platby, tzn. opakované platby, pri ktorých si obchodník prostredníctvom API sám určuje sumu aj časový rozostup jednotlivých platieb, je možné realizovať pomocou služby Opakované platby popísanej vyššie. Správu opakovaných platieb (sumu a periodicitu) vykonáva obchodník na svojej strane.
Testovacie opakované platby (okrem iniciačných) vytvorené pomocou e-mailu 'recurring.cancelled@comgate.cz' budú automaticky označené ako CANCELLED (nezaplatené)

header Parameters
authorization
required
string

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

Request Body schema: application/json
test
boolean

Hodnota 'true' znamená, že platba bude založená ako testovacia, hodnota 'false' znamená, že platba bude založená ako produkčná verzia. Ak parameter chýba, založí sa platba ako produkčná.

price
required
integer <int32>

Cena za výrobok v centoch alebo halieroch. Musí byť min. 10 CZK (vrátane), max. neobmedzene.

curr
required
string

kód meny podľa ISO 4217, štandardne 'CZK'

label
required
string

krátky popis produktu (1 – 16 znakov)

refId
required
string

Referencia platby v systéme e-shopu (nemusí byť unikátna, tzn. možno založiť viac platieb s rovnakým refid).

account
string

Identifikátor bankového účtu e-shopu, na ktorý Comgate prevedie peniaze. Ak parameter nevyplníte, použije sa predvolený účet e-shopu. Zoznam účtov e-shopu nájdete na https://portal.comgate.cz/

name
string

Identifikátor produktu - podľa tejto položky je potom možné sa zorientovať v štatistikách platieb Comgate platobného systému.

initRecurringId
required
string

Comgate ID iniciačnej platby

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1102 zadaný jazyk nie je podporovaný
1103 nesprávne zadaná metóda
1104 nemožno načítať platbu
1200 databázová chyba
1301 neznámy e-shop
1303 prepojenie alebo jazyk chýba
1304 neplatná kategória
1305 chýba popis produktu
1308 vybraný spôsob platby nie je povolený
1309 nesprávna čiastka
1310 neznáma mena
1311 neplatný identifikátor bankového účtu e-shopu
1316 e-shop nemá povolené opakované platby
1317 neplatná metóda - nepodporuje opakované platby
1318 iniciačná platba nebola nájdená
1319 nemožno založiť platbu, problém na strane banky
1320 neplatný email pre opakovanú platbu
1399 neočakávaný výsledok z databázy
1400 chybná otázka
1500 neočakávaná chyba

message
required
string
transId
string

unikátny alfanumerický identifikátor (kód) transakcie, ktorý bude zobrazený Platiteľmi v rôznych fázach platby

Request samples

Content type
application/json
{
  • "test": true,
  • "price": 10000,
  • "curr": "CZK",
  • "label": "string",
  • "refId": "2010102600",
  • "account": "string",
  • "name": "string",
  • "initRecurringId": "AB12-CD34-EF56"
}

Response samples

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

refund

Refundácia platby
Metóda pre refundáciu je určená pre už založené a preplatené platby. Stav platby musí byť zaplatená (paid). Je možné vykonať ako čiastočnú (refundovaná suma je nižšia ako suma platby), tak plnú refundáciu (suma refundácie je rovnaká ako suma platby). Daná čiastka bude prevedená späť na účet platiteľa.
Ak platba nebola dokončená a je v stave pending, je možné využiť metódu storno platby.

header Parameters
authorization
required
string

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

Request Body schema: application/json

Vrátenie platby

transId
required
string

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

amount
required
integer <int32>

čiastka refundácie - môže byť v plnej alebo čiastočnej výške transakcie. Suma refundácie sa zadáva v centoch alebo halieroch. Pre menu HUF nie je možné zadať sumu s desatinnými miestami. V tomto prípade musí suma vždy končiť 00.

test
boolean

Hodnota 'true' znamená, že refundácia bude založená ako testovacia. Refundácia a platba bude preverená štandardnou cestou, len nedôjde k refundácii pôvodnej platby.
Ak je vyplnené 'false' alebo je parameter prázdny, je založená ostrá refundácia.
Testovacie transakcie môžu byť refundované iba testovacími refundáciami.

refId
string

Parameter vhodný na zadanie identifikačného čísla refundácie na strane Klienta (nemusí byť unikátna, tzn. možno založiť viac refundácií s rovnakým refid); v Klientskom portáli v sekcii refundácií a denných csv pri refundácii je parameter označený ako ID Klienta. V prípade, že tento parameter na refundáciu nie je pripojený, k platbe sa zobrazí pôvodná refid založenej platby.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1200 databázová chyba
1400 chybná otázka
1401 refundovaná platba je v stave CANCELLED
1402 čiastka prevyšuje povolenú výšku
1500 neočakávaná chyba

message
required
string

Request samples

Content type
application/json
{
  • "transId": "AB12-CD34-EF56",
  • "amount": 10000,
  • "test": true,
  • "refId": "string"
}

Response samples

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

refundPos

Refundácia terminálovej platby
Metóda pre refundáciu je určená pre už založené a preplatené terminálové platby. Stav platby musí byť zaplatená (paid). Je možné vykonať ako čiastočnú (refundovaná suma je nižšia ako suma platby), tak plnú refundáciu (suma refundácie je rovnaká ako suma platby). Daná čiastka bude prevedená späť na účet platiteľa.
Ak platba nebola dokončená a je v stave pending, je možné využiť metódu storno platby. Serverové API nemusia mať záznam o platbe ihneď k dispozícii. Preto je vhodné najskôr zavolať refundáciu z pokladne na termináli. A volanie API využiť v prípade, že nemožno refundáciu zavolať z pokladne na termináli.
Pre využitie tejto metódy je nutné najskôr v Klientskom portáli nastaviť v sekcii Nastavenie obchodu - Terminály pri danom termináli povolenej IP adresy, z ktorých sa budú refundácie vykonávať.

header Parameters
authorization
required
string

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

Request Body schema: application/json

Refundácia terminálovej platby

vs
required
string

variabilný symbol platby

amount
required
integer <int32>

čiastka refundácie - môže byť v plnej alebo čiastočnej výške transakcie

date
required
string

dátum vykonania transakcie

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1200 databázová chyba
1400 chybná otázka
1401 refundovaná platba je v stave CANCELLED
1402 čiastka prevyšuje povolenú výšku
1500 neočakávaná chyba

message
required
string

Request samples

Content type
application/json
{
  • "vs": "7654321",
  • "amount": 10000,
  • "date": "2000-02-22"
}

Response samples

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

capturePreauth

V prípade, že e-shop založil platbu s požiadavkou na predautorizáciu platby kartou (s využitím parametra 'preauth = true'), vyvolaním tejto funkcie vyžiada strhnutie peňazí, ktoré boli v rámci predautorizácie zablokované. Je možné vykonať ako čiastočné strhnutie transakcie (predautorizovaná suma je nižšia ako suma platby), tak plné strhnutie (suma strhnutia je rovnaká ako suma platby). Volanie možno použiť len na platby, pri ktorých bol ohlásený stav Authorized.

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. Secret je heslo.

Request Body schema: application/json

Potvrdenie predbežnej autorizácie

amount
integer <int32>

čiastka predautorizácie, ktorá má byť z karty strhnutá - môže byť v plnej alebo čiastočnej výške transakcie

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1104 nemožno načítať platbu
1200 databázová chyba
1301 neznámy e-shop
1303 prepojenie alebo jazyk chýba
1399 neočakávaný výsledok z databázy
1400 chybná otázka
1500 neočakávaná chyba

message
required
string

Request samples

Content type
application/json
{
  • "amount": 10000
}

Response samples

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

cancelPreauth

V prípade, že e-shop založil platbu s požiadavkou na predautorizáciu platby kartou (s využitím parametra 'preauth = true'), vyvolaním tejto funkcie dáva najavo, že peniaze, ktoré boli v rámci predautorizácie zablokované, nechce inkasovať a peniaze sa na karte môžu opäť uvoľniť. Volanie možno použiť len na platby, pri ktorých bol ohlásený stav Authorized.

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. Secret je heslo.

Responses

Response Schema: application/json
code
required
integer

Návratový kód metódy a popis chyby:
0 OK
1100 neznáma chyba
1104 nemožno načítať platbu
1200 databázová chyba
1301 neznámy e-shop
1303 prepojenie alebo jazyk chýba
1399 neočakávaný výsledok z databázy
1400 chybná otázka
1500 neočakávaná chyba

message
required
string

Request samples 

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

Response samples

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

transferList

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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
[
  • {
    }
]

singleTransfer

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
integer
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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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
[
  • {
    }
]

csvSingleTransfer

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
integer
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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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"
}

aboSingleTransfer

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
integer
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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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"
}

csvDownload

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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'

aboDownload

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 identifikátor e-shopu v systéme Comgate - nájdete v Klientskom portáli v sekcii Nastavenie obchodov - Prepojenie obchodu. 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'

methods

Získanie povolených metód
Metóda na získanie nastavenia, ktoré má e-shop povolené v Comgate Platobnom Systéme. Touto metódou možno získať zoznam dostupných platobných metód na realizáciu platieb.
V odpovedi sa nachádza XML alebo JSON, podľa zvoleného parametra. Obidva formáty majú rovnakú úroveň zanorenia.

query Parameters
lang
string

Výber, v akom jazyku budú popisy metód. Povolené hodnoty sú 'bg', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'hr', 'hu', 'it', 'lt', 'lv', 'nl', 'no', 'pl', 'pt', 'ro', 'ru', 'sl', 'sk', 'sv', 'uk', 'vi'. Pokiaľ nebude vyplnené, použije sa 'cs'.

curr
string

Vyplnením parametra na hodnoty CZK alebo EUR dôjde k vráteniu metód, ktoré podporujú zadanú menu (CZK, EUR, PLN, HUF, USD, GBP, RON, NOK, SEK).

country
string

Kód krajiny ('AT', 'BE', 'CY', 'CZ', 'DE', 'EE', 'EL', 'ES', 'FI', 'FR', 'GB', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV', 'MT', 'NL', 'NO', 'PL', 'PT', 'RO', 'SL', 'SK', 'SE', 'US'), parameter slúži na obmedzenie výberu možných spôsobov pre zadanú krajinu.

price
integer

Cena za výrobok v centoch alebo halieroch. Pre menu HUF nemôžete zadať cenu s desatinnými miestami. V tomto prípade musí cena vždy končiť 00.
Musí byť min. 1 CZK; 0,1 EUR; 1 PLN; 100 HUF; 1 USD; 1 GBP; 5 RON; 0,5 NOK; 0,5 SEK.
Max. 1 000 000 CZK; 40 000 EUR; 170 000 PLN; 12 500 000 HUF; 45 000 USD; 35 000 GBP; 190 000 RON; 400 000 NOK; 390 000 SEK.

initRecurring
boolean

Príznak pre iniciačnej transakcie pre opakované platby. Len pre Klientov, ktorí majú službu povolenú.

verification
boolean

Parameter overovacej platby, v prípade požiadavky na založenie overovacej platby (hodnota ‘true’) nie je nutné posielať parameter ‘initRecurring’.

preauth
boolean

V prípade požiadavky na predautorizáciu platby kartou nastavte na ‘true’. V prípade normálnej platby vyplňte ‘false’ alebo parameter nepoužívajte. Len na platby kartou.

expirationTime
string

Dĺžka expirácie platby. Povolená hodnota je celé číslo nasledované písmenom zvolenej časovej jednotky: 'm' (minúty), 'h' (hodiny) alebo 'd' (dni). Napríklad '30m' (30 minút) alebo '10h' (10 hodín) alebo '2d' (2 dni). Jednotky nemožno kombinovať. Výsledná dĺžka musí byť v rozmedzí 30 minút až 7 dní.

embedded
boolean

Parameter 'embedded' slúži na filtrovanie metód v prípade, že sa brána bude zobrazovať v iframe. Dôjde k odfiltrovaniu platobných metód, ktoré nie je možné na platobnej bráne v iframe zobraziť. Pokiaľ zobrazujete platobnú bránu v iframe, použite 'embedded=true'.

userAgent
string

Parameter 'userAgent' slúži na identifikáciu webového prehliadača zákazníka. Odfiltruje platobné metódy nekompatibilné s daným zariadením.

chargeUnregulatedCardFees
boolean

Pomocou tohto parametra zapnete alebo vypnete prenos poplatkov na platiteľa pri platbe neregulovanou kartou a zároveň vypnete metódu Apple Pay a Google Pay (ak nie je parametrom 'enableApplePayGooglePay' nastavené inak). Povolené hodnoty sú 'true' alebo 'false'.
Použitie tohto parametra je možné len po schválení a zapnutí zo strany Comgate. Nie všetky e-commerce riešenia tento parameter podporujú.

Viac informácií o prenesení poplatkov nájdete na stránke podpory.

enableApplePayGooglePay
boolean

Nastavte na 'false' pre vypnutie platobnej metódy Apple Pay a Google Pay pre konkrétnu platbu, aj keď sú tieto metódy vo vašom nastavení účtu povolené.
Nastavte na 'true' pre zapnutie platobnej metódy Apple Pay a Google Pay pre konkrétnu platbu, aj keď je použitý parameter 'chargeUnregulatedCardFees'.
Ak je použitý parameter 'chargeUnregulatedCardFees', tak je predvolená hodnota parametra 'enableApplePayGooglePay' 'false'. V opačnom prípade je predvolená hodnota 'true'.

header Parameters
authorization
required
string

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

Responses

Response Schema:
required
Array of objects

Dostupné metódy

Array
id
string

ID metódy

group
string

Skupina metódy

groupLabel
string

Popis skupiny metódy

name
string

Názov metódy

name_short
string

Krátky názov metódy

description
string

Popis metódy

logo
string

Logo metódy

logo_120c
string

Centrované logo metódy

logo_240
string

240px logo metódy

logo_240c
string

Centrované väčšie logo metódy

logo_150s
string

Štvorcové väčšie logo metódy

logo_100s
string

Štvorcové logo metódy

Request samples 

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

Response samples

Content type
{
  • "methods": [
    ]
}

appleDomainAssociation

Stiahnutie obsahu validačného súboru na overenie domény v Apple Pay pre Comgate Checkout SDK. Systém automaticky určí správny súbor podľa aktívnej kartovej metódy obchodníka. Viac informácií v implementačnom manuáli Checkout SDK.

query Parameters
currency
string

Mena použitá na určenie validačného súboru. Hodnota je vo formáte ISO 4217.

header Parameters
authorization
required
string

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

Responses

Response Schema: application/json
fileContent
string

Request samples 

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

Response samples

Content type
application/json
{
  • "fileContent": "APPLE_DOMAIN_ASSOCIATION_FILE_CONTENT_PLACEHOLDER"
}

config

Konfigurácia
Endpoint slúži na konfiguráciu konkrétneho prepojenia obchodu. Umožňuje nastaviť vizuálnu podobu platobnej brány, napríklad logo, farby alebo pozadie, a zároveň definovať URL adresy na presmerovanie platiteľa po dokončení platby. Podrobnosti nájdete v sprievodcovi konfiguráciou.

header Parameters
authorization
required
string

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

Request Body schema: application/json

Nastavenie konfigurácie

gateway_logo
string

Logo v hlavičke platobnej brány

gateway_background
string

Obrázok v pozadí brány v kódovaní Base64

gateway_color_page
string

HEX kód farby pozadia stránky platobnej brány

gateway_color_header
string

HEX kód farby hlavičky platobnej brány

gateway_signature
string

Textový popis v pätičke platobnej brány

url_paid
string

Návratová URL adresa po zaplatení platby

url_cancelled
string

URL adresa pre zrušenú platbu

url_pending
string

Návratová URL pre čakajúcu platbu

url_push
string

URL adresa pre odovzdanie výsledku platby

ip_addresses
string

Povolené IP adresy

active
boolean or null

Parameter slúži na deaktiváciu prepojenia obchodu.

Responses

Response Schema: application/json
code
integer

Návratový kód metódy

message
string

Návratová správa metódy

merchant
string

identifikátor e-shopu v systéme Comgate

secret
string

heslo pre komunikáciu na pozadí

gateway_logo
string

Logo v hlavičke platobnej brány

gateway_background
string

Obrázok v pozadí brány v kódovaní Base64

gateway_color_page
string

HEX kód farby pozadia stránky platobnej brány

gateway_color_header
string

HEX kód farby hlavičky platobnej brány

gateway_signature
string

Textový popis v pätičke platobnej brány

url_paid
string

Návratová URL adresa po zaplatení platby

url_cancelled
string

URL adresa pre zrušenú platbu

url_pending
string

Návratová URL pre čakajúcu platbu

url_push
string

URL adresa pre odovzdanie výsledku platby

ip_addresses
string

Povolené IP adresy

active
boolean or null

Parameter slúži na deaktiváciu prepojenia obchodu.

Request samples

Content type
application/json
{
  • "gateway_logo": "data:image/png;base64,...",
  • "gateway_background": "data:image/png;base64,...",
  • "gateway_color_page": "#C2E7FF",
  • "gateway_color_header": "#f2c7af",
  • "gateway_signature": "string",
  • "url_paid": "string",
  • "url_cancelled": "string",
  • "url_pending": "string",
  • "url_push": "string",
  • "ip_addresses": "{1.1.1.1/1,2.2.2.2/2}",
  • "active": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "OK",
  • "merchant": 123123,
  • "secret": "secret",
  • "gateway_logo": "data:image/png;base64,...",
  • "gateway_background": "data:image/png;base64,...",
  • "gateway_color_page": "#C2E7FF",
  • "gateway_color_header": "#f2c7af",
  • "gateway_signature": "string",
  • "url_paid": "string",
  • "url_cancelled": "string",
  • "url_pending": "string",
  • "url_push": "string",
  • "ip_addresses": "{1.1.1.1/1,2.2.2.2/2}",
  • "active": ""
}