TAG_api_title

Scroll down for code samples, example requests and responses. Select a programming language for code samples and language for the documentation itself from the tabs above or the mobile navigation menu.Posuňte se dolů, kde najdete ukázky kódu, příklady požadavků a odpovědí. Na kartách nahoře nebo v mobilní navigační nabídce vyberte programovací jazyk pro ukázky kódu a jazyk pro samotnou dokumentaci.Posuňte sa nižšie, kde nájdete ukážky kódu, príklady požiadaviek a odpovedí. Vyberte si programovací jazyk pre ukážky kódu a jazyk pre samotnú dokumentáciu z kariet vyššie alebo z mobilného navigačného menu.

SDK

SDK dostupný na https://github.com/comgate-payments/sdk-php

Open-source řešení: https://help.comgate.cz/docs/en/open-source-solution

Specifikace protokolu

Využívá HTTP POST. Propojení mezi e-shopem a platební branou Comgate je realizované pomocí přesměrování plátce z e-shopu na platební bránu. Po provedení platby je plátce přesměrován zpět do e-shopu. Zároveň na pozadí probíhá komunikace mezi serverem e-shopu a serverem platební brány (server – server). Detailní popis komunikačního protokolu naleznete níže na této stránce. Další související informace naleznete na stránkách, které popisují proces platby z pohledu uživatele a e-shopu, počáteční nastavení v klientském portálu nebo doporučený způsob testování integrace platební brány.

Pro snadnou implementaci platební brány můžete použít tento PHP SDK (instalace přes composer).

Průběh platby

Založení platby – volitelné

Krok založení platby je volitelný, je však vhodné ho implementovat v případě, kdy požadujete jistotu zabezpečeného založení platby. Vynechání implementace tohoto kroku je možné v případě, kdy jednotlivé platby nepotřebujete v systému identifikovat, ale stačí vám informace, že vám někdo zaplatil určitou částku. Je to vhodné například při implementaci dárcovských příspěvků nebo dobíjení prostředků na virtuální účet zákazníka, kdy vás zajímá jen, kdo dobíjel a jakou částku, ale nepotřebujete rozlišovat jednotlivá dobití zákazníka nebo dobití omezovat na minimální částku atd. Postup je detailně popsán v odstavci Jednoduchá integrace - bez založení platby.

Pro klasický e-shop, kde nakupující platí za konkrétní zboží, je krok založení platby důležitý, jeho vynechání nedoporučujeme.

Platbu e-shop zakládá HTTP požadavkem na server platební brány. Parametry platby, včetně unikátního referenčního čísla platby, jsou předány jako POST parametry HTTP protokolu. Tato komunikace probíhá mezi serverem Klienta a serverem platební brány. Plátce ji nevidí a nemůže měnit parametry platby. Server platební brány vrátí Klientovi unikátní identifikátor transaction ID (identifikátor v Comgate platebním systému) a URL adresu, na kterou má přesměrovat Plátce.

Příklad založení platby na pozadí – HTTP request pomocí cURL

curl -X POST -i --data "merchant=123456&price=10000&curr=CZK&label=Beatles%20-0%Help&refId=2010102600&method=ALL&prepareOnly=true&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y" https://payments.comgate.cz/v1.0/create

Příklad založení platby na pozadí – HTTP response:

HTTP/2 200 OK
content-type: application/x-www-form-urlencoded; charset=UTF-8
code=0&message=OK&transId=AB12-CD34-EF56&redirect=https%3A%2F%2Fpayments.comgate.cz%2Fclient%2Finstructions%2Findex%3Fid%3DAB12-CD34-EF56

Komunikace mezi systémem Klienta a platební bránou je zabezpečena pomocí hesla a IP whitelistu (přístup je povolen pouze z IP adres systému Klienta). Nezbytné je použití protokolu HTTPS, který znemožňuje prozrazení hesla při případném odposlouchávání komunikace. Heslo je předáváno jako POST parametr (nikoliv GET parametr) proto, aby se neukládalo v logu komunikace webového serveru.

Přesměrování na platební bránu

Po založení platby na pozadí obdrží e-shop platební URL pro zobrazení platební brány. Platební brána může být zobrazena dvěma způsoby. První způsobem je přesměrování plátce na adresu, kterou obdržel e-shop v HTTP odpovědi. Přesměrování se obvykle provádí odesláním HTTP odpovědi 302:

HTTP odpověď 302

HTTP/2 302 Found
Location: https://payments.comgate.cz/client/instructions/index?id=AB12-CD34-EF56

Druhou možností je zobrazení platební brány přímo na stránce e-shopu pomocí iframu. Pro tuto variantu je potřeba vygenerovat platební URL standardním způsobem, ale místo přesměrování zákazníka na bránu se zobrazí na stránce e-shopu iframe s platební URL.

Jednoduchá integrace – bez založení platby

Platební brána umožňuje vynechání prvního kroku založení platby na pozadí. V tomto případě je Plátce přesměrován na platební bránu bez předchozího založení platby. Přesměrování může proběhnout buď z odesláním formuláře metodou POST nebo přímým linkem pomocí metody GET. Doporučujeme způsob s použitím formuláře.

Příklad jednoduché integrace – odeslání formuláře (POST)

<form method="POST" action="https://payments.comgate.cz/v1.0/create">

    <input type="hidden" name="merchant" value="XXXX" /> <!-- identifikátor e-shopu v systému Comgate -->

    <input type="hidden" name="price" value="100" /> <!-- 100 = 1,00 Kč -->

    <input type="hidden" name="curr" value="CZK" />

    <input type="hidden" name="label" value="Moje služba" />

    <input type="hidden" name="refId" value="123456" />

    <input type="hidden" name="method" value="ALL" />

    <input type="hidden" name="country" value="CZ" />

    <button type="submit">Zakoupit</button>

</form>

Příklad jednoduché integrace - přesměrování pomocí linku (GET)

<a href="https://payments.comgate.cz/v1.0/create?merchant=XXXX&price=100&curr=CZK&label=Moje%20slu%C5%BEba&refId=10980891&method=ALL&country=CZ" rel="nofollow">Zaplatit</a>

V parametrech hypertextového odkazu zachovejte parametr rel="nofollow".

Předání výsledku platby na pozadí

Implementace této části vám zajistí automatické předání informace o stavu každé platební transakce přímo na váš server v okamžiku, kdy je stav platby známý. Předávání výsledku platby na pozadí je povinné.

Výsledek platby je Klientovi předán HTTP požadavkem ze serveru platební brány na server Klienta. Identifikátory a výsledek platby jsou předány jako POST parametry HTTP protokolu. Tato komunikace probíhá na pozadí.

Plátce je přesměrován na webové stránky Klienta a identifikátory platby jsou předány jako GET parametry HTTP protokolu. Odeslání zboží nebo služby Plátci musí být vázáno na předání výsledku platby na pozadí, nikoliv na výsledné přesměrování Plátce na webové stránky Klienta, protože informace předané přesměrováním může Plátce snadno podvrhnout.

Parametry volání

Parametry odpovědí

Příklad předání výsledku platby na pozadí – HTTP request pomocí cURL

curl -X POST -i --data "merchant=merchant_com&test=false&price=10000&curr=CZK&label=Beatles%20-%20Help&refId=2010102600&method=CARD&email=info%40customer.com&phone=%2B420123456789&transId=AB12-EF34-IJ56&secret=ZXhhbXBsZS5jb206QUJDeHl6&status=PAID" https://example.com/handler.php

Příklad předání výsledku platby na pozadí – HTTP response

HTTP/2 200 OK
content-type: application/x-www-form-urlencoded; charset=UTF-8

Komunikace mezi systémem Klienta a serverem platební brány je zabezpečena pomocí hesla a IP whitelistu. Přístup musí být povolen pouze z IP adresy serveru platební brány. Rozsahy IP adres jsou definovány v sekci Zabezpečení. Je povinné použít protokol HTTPS, který znemožňuje prozrazení hesla při případném odposlouchávání komunikace. Heslo je předáváno jako POST parametr (nikoliv GET parametr) proto, aby se neukládalo v logu komunikace webového serveru.

E-shop na svojí straně zajistí, že zboží (služba) poskytnuté v rámci zaplacené transakce (identifikované pomocí unikátního transaction ID) bude vydáno Plátci pouze jednou (i při opakovaném předání výsledku stejné platby na server Klienta).

Přesměrování Plátce na web Klienta

Plátce je na základě stavu platby přesměrován na jedno ze tří URL, které e-shop zvolil při aktivaci služby. Identifikátory platby jsou předány jako GET parametry HTTP protokolu. Systém klienta musí být schopen ošetřit dvě základní situace:

• Při přesměrování Plátce na web Klienta výsledek platby ještě není známý. Platba je ve stavu PENDING. Tato situace je naprosto běžná a e-shop ji nesmí Plátci prezentovat jako chybu. Systém čeká buď na připsání platby na bankovní účet, nebo na potvrzení od Poskytovatele platby. Konečný výsledek platby se e-shop dozví později buď předáním výsledku platby na pozadí, nebo emailem, nebo v klientském portálu.
• Pokud se platební brána dozví výsledek platby okamžitě po provedení platby Plátcem, pak je Plátce směrován na příslušné URL (PAID nebo CANCELLED). Jestliže eshop implementoval předávání výsledku platby na pozadí, pak se přesměrování na web Klienta provede až po úspěšném předání výsledku platby na pozadí. Plátci nelze odeslat zboží nebo službu, kterou objednal, pouze na základě URL použité pro přesměrování, protože Plátce by mohl výsledek platby podvrhnout změnou URL ve webovém prohlížeči.

Příklad přesměrování Plátce na web Klienta – HTTP request

GET /result_ok.php?refId=2010102600&transId=AB12-EF34-IJ56 HTTP/2
Host: eshop.com

Platební brána v e-shopu (iframe)

Platební brána umožňuje zobrazení optimalizované pro iframe. Tato funkcionalita je vhodná v případě, že nechcete plátce přesměrovávat na platební bránu, ale zobrazit ji v rámci svého systému. Aby se platební brána zobrazila v iframu, je potřeba při založení platby použít parametr "embedded" = true. Platební URL je vygenerována standardním způsobem, ale místo přesměrování zákazníka na bránu se zobrazí na stránce e-shopu iframe s platební URL.

Pro zobrazení jsou dvě možnosti. Jednak je možné platební bránu zobrazit přímo v košíku nebo pomocí vyskakovacího okna nad vaší webovou stránkou. Implementace iframu vyžaduje znalost webových technologií. Iframe je možné použít pouze pro platbu kartou. U ostatních platebních metod dojde vždy k přesměrování plátce na novou stránku.

Pro správné zobrazení platební brány v iframu na webové stránce doporučujeme provést následující úpravu vašich webových stránek.

Nastavení zobrazení platební brány

HTML kód

<div id="comgate-container">
    <iframe id='comgate-iframe' allow="payment" src="[platební URL]" frameborder="0px"></iframe>
</div>

CSS styly

#comgate-container {
    display: none;
    position:absolute;
    z-index: 9999;
    left: 50%;
    top: 30px;
    overflow: auto;
    margin-left: -250px;
}
#comgate-iframe {
    width: 504px;
    height: 679px;
}
@media (max-height: 700px) {
    #comgate-iframe {
        top: 0px;
    }
}

Javascriptový kód

// funkce pro otevření iframu s bránou
function comgateOpen() {
    let comgate_container = document.getElementById("comgate-container");
    comgate_container.style.display = "block";
}
// funkce pro zavření iframu s bránou
function comgateClose() {
    let comgate_container = document.getElementById("comgate-container");
    comgate_container.style.display = "none";
}

Pro zobrazení iframu je třeba zavolat funkci comgateOpen(). Například navázáním na uživatelskou akci (kliknutí na tlačítko apod.). Funkce comgateClose() pak slouží pro případné skrytí iframu.

Příklad zavolání funkce pro zobrazení iframu kliknutím na tlačítko “Zaplatit”:

HTML kód

<button id="comgate-open" onclick="comgateOpen()">Zaplatit</button>

Přesměrování zákazníka po dokončení platby

Po dokončení platby zákazníkem dochází k jeho přesměrování do e-shopu na URL, kterou jste nastavili v klientském portálu. Doporučujeme provést jednu z následujících úprav, která zajistí, že zákazník bude přesměrován přímo na návratovou URL a nezůstane tak uvnitř iframu.

První možností je přesměrovat vnější stránku na vámi určenou URL. Tím dojde k obnovení celé stránky.

Javascriptový kód pro vnitřní stránku

window.top.location = window.self.location

Druhou možností je ze stránky uvnitř iframu poslat zprávu vnější stránce a na vnější stránce tuto událost zpracovat. Nemusí tedy dojít k obnovení celé stránky.

Pozor, skutečný výsledek platby je třeba získat na pozadí standardním způsobem. Z bezpečnostních důvodů nelze spoléhat na výsledek předaný zprávou z iframu.

Javascriptový kód pro vnitřní stránku, který pošle vnější stránce zprávu s ID platby a stavem platby, např. pro zaplacenou platbu:

window.parent.postMessage('[id platby]|PAID', '*');

Javascriptový kód pro vnější stránku, který zpracuje příchozí zprávu z iframu:

// odchycení zprávy poslané z iframu pomocí postMessage
if (window.addEventListener) {
    window.addEventListener('message', function (e) {
        // přijde mi id a výsledek platby, oddělovač je “roura”
        let message = e.data.split('|', 2);
        let message_id =  message[0];
        let message_result =  message[1];
        let result = '';
        if (message_result === 'PAID') {
            // obsloužení stavu PAID
            [...]
        } else {
            // obsloužení dalších stavů, atd ...
            [...]
        }
    }, false);
}

Platební brána v iframu z pohledu plátce

Platební brána Comgate umožňuje uživatelům opakovat platbu, pokud se jim nepodařilo dokončit platbu napoprvé. Zobrazení platební brány v iframu uživateli je závislé na zvolené platební metodě a také, zda se výběr platebních metod nachází na straně e-shopu nebo na straně Comgate.

V případě, že je výběr platebních metod na straně e-shopu a platba je tak založena již s platební metodou, musí být pro zobrazení iframu zvolena metoda platby kartou. Pokud se uživateli nepodařilo platbu napoprvé dokončit, je mu pro další pokus opět zobrazena pouze metoda platby kartou. Tato verze je doporučována.

V případě, že e-shop nezakládá platbu s již vybranou platební metodou, je uživateli v iframu zobrazen výběr platebních metod. Zde je následně potřeba zvolit platbu kartou. Pokud se uživateli nepodařilo platbu dokončit, je mu pro další pokus opět zobrazen výběr platebních metod v iframu.

Pokud dojde v jakémkoliv kroku platebního procesu k vybrání jiné metody než platby kartou, dojde k přesměrování plátce na novou stránku. Uživatel se již zpět do iframu nevrátí.

Vzor pro zobrazení brány v e-shopu

Pro snadnou implementaci naší platební brány do vašeho e-shopu, můžete využít níže dostupné vzorové implementace.

HTML kód

<!doctype html>

<html lang="cs">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>Comgate :: práce s iframem</title>

    <style>
        body,html {
            background: #fff;
            padding:0;
            margin:0;
            width: 100%;
            height: 100%;
        }
        .page {
            width: 100%;
            background: #eee;
            margin: 0 auto;
            max-width: 800px;
        }
        .page .header h1 {
            text-align: center;
            margin: 0;
            padding: 25px 15px;
            font-size: 25px;
        }
        #comgate-iframe-box {
            width: 450px; /* šířka je pomocí media automaticky nastavena na 100 % šířky obrazovky v případě malého displaye  */
            height: 700px; /* výšku je pro novou bránu možné dynamicky přizpůsobit Vašim potřebám */
            margin: 0 auto;
        }
        #comgate-iframe-box .iframe {
            width: 100%;
            height: 100%;
        }
        @media (max-width: 450px) {
            #comgate-iframe-box {
                width: 100%;
            }
        }

    </style>
</head>

<body>
<div class="page">
    <div class="header">
        <h1>Ukázka práce s&nbsp;iframem</h1>
    </div>
    <div id="comgate-iframe-box">
        <!--
            V konfiguraci iframu:
                pro novou bránu použít scrolling="off"
                pro starou bránu použít scrolling="on"
            Pozor: URL adresa (src) založené platby se může měnit.
                   Vždy použijte adresu, kterou vám vrátí API, a nijak do ní nezasahujte.
         -->
        <iframe
            class="iframe"
            src="https://pay2.comgate.cz/init?id=XXXX-XXXX-XXXX"
            allow="payment"
            frameborder="0px"
            scrolling="off">
        </iframe>
    </div>
</div>
</body>
</html>

Stavy plateb

• PENDING – Platba byla založená, finální výsledek platby zatím není známý.
• PAID – Plátce úspěšně dokončil platbu – je možné vydat zboží, resp. zpřístupnit službu.
• CANCELLED – Platba nebyla zaplacena, zboží nebude vydáno, resp. služba nebude poskytnuta.

Platbu lze považovat za zaplacenou pouze ve stavu PAID. Stav PENDING není koncový a může po něm následovat stav CANCELLED.

API protokol - platební brána Comgate

Zabezpečení

Komunikace mezi Comgate platebním systémem a e-shopem probíhá třemi způsoby.

• Serverová část e-shopového řešení se jako klient připojuje k serverové části platební brány a volá metody pro založení platby, získání stavu platby na pozadí, potvrzení předautorizace, zrušení předautorizace a získání seznamu platebních metod.
• Serverová část platební brány se jako klient připojuje k serverové části e-shopového řešení a volá metodu pro předání výsledku platby na pozadí.
• Prohlížeč plátce (uživatele) je přesměrován z e-shopu na platební bránu a následně z platební brány zpět do e-shopu.

Ve všech třech případech je nezbytné použití šifrovaného protokolu HTTPS. Platební brána podporuje pouze bezpečné nastavení TLS/SSL protokolu s následujícími povolenými šiframi: https://github.com/cloudflare/sslconfig/blob/master/conf

V případě komunikace server – server je komunikace zabezpečena pomocí hesla (secret) a nastavení IP whitelistu. Nastavení těchto parametrů je možné provést v prostředí klientského portálu.

Zakládaní plateb je předřazena služba Cloudflare. Seznam povolených IP adres Cloudflare naleznete zde: https://www.cloudflare.com/ips-v4

Rozsah IP adres používaný systémem Comgate je definován jako 89.185.236.55/32. Tento rozsah se používá pouze pro předání výsledku platby na pozadí.

Metody platební brány

Platební tlačítka

Zrychlené bankovní převody (platební tlačítka) poskytujeme od všech významných bank v Česku, Polsku a na Slovensku. Seznam dostupných bank najdete v číselnících. V případě platebních tlačítek je možné využít funkcionalit, jako jsou refundace a storno platby. Platební tlačítko není možné zobrazit přímo v e-shopu (iframe). Plátce je vždy přesměrován do banky.

Platba kartou

Platební brána akceptuje platby kartou VISA, VISA Electron, Mastercard, Maestro. Platby jsou dostupné v měnách CZK, EUR, GBP, USD, PLN, HUF RON, NOK a SEK. Je k dispozici ve 14 jazycích - v češtině, slovenštině, angličtině, němčině, francouzštině, polštině, maďarštině, chorvatštině, slovinštině, rumunštině, norštině, španělštině, italštině a švédštině.

V rámci platby kartou je možné využít mnoho funkcionalit. Mezi ně patří refundace platby, storno nedokončené platby, opakované platby (například pro předplatné s pravidelným strháváním prostředků z karty plátce) nebo předautorizace. Platbu kartou lze také zobrazit přímo v e-shopu (iframe).

Apple Pay a Google Pay

Služby Apple Pay i Google Pay jsou součástí platební brány Comgate. Pro zobrazení služeb zákazníkovi stačí mít povolenou metodu platby kartou CARD_CZ_COMGATE nebo CARD_CZ_CSOB_2.

V rámci služby není možné použít funkcionalitu opakované a verifikační platby. Ostatní funkcionality jsou k dispozici.

Zobrazení služeb

Zobrazení služb Apple Pay i Google Pay se odvíjí podle toho, zda se výběr platebních metod nachází v košíku e-shopu nebo e-shop využívá výběru metod od Comgate. Dále je potřeba rozlišit, zda má dojít k přesměrování plátce na karetní bránu nebo se Apple Pay či Google Pay zobrazí přímo v prostředí košíku e-shopu.

Rozlišujeme tedy tři možnosti zobrazení:

1. Tlačítko v karetní bráně - V případě, že se výběr platebních metod nachází na straně Comgate, není pro zobrazení služeb třeba žádných úprav. Stačí mít povolenou metodu platby kartou CARD_CZ_COMGATE nebo CARD_CZ_CSOB_2. Po výběru jedné z těchto metod ze strany plátce probíhá platba standardním procesem s přesměrováním na platební bránu, kde se služby zobrazí automaticky. Zde je zároveň plátci umožněno ručně zadat číslo karty. Pokud se na bránu dostane plátce ze zařízení či prohlížeče, které některou ze služeb nepodporují, bude plátce moci provést alespoň úhradu platební kartou.

2. Tlačítko v košíku e-shopu s přesměrování plátce na karetní bránu - Pokud je výběr platebních metod na straně e-shopu, platba se zakládá jako běžná platba, v požadavku je však třeba volat metodu APPLEPAY_REDIRECT či GOOGLEPAY_REDIRECT. Následně dojde k přesměrování plátce na platební bránu pomocí získaného platebního odkazu. Tlačítka Apple Pay i Google Pay se poté zobrazí na karetní bráně automaticky. Proces platby z pohledu plátce je následně shodný s první variantou. Doporučujeme dodržovat naše zásady pro zobrazení tlačítek Google Pay a Apple Pay, které jsou dostupné níže.

3. Tlačítko součástí košíku e-shopu, bez přesměrování na karetní bránu V této variantě integrace nedochází k přesměrování plátce na karetní bránu a platba je kompletně zpracována přímo v prostředí e-shopu. Implementace tohoto chování je náročnější, než obě výše zmíněné varianty. K tomuto účelu musíte použít námi připravenou JavaScriptovou knihovnu Checkout SDK. Detailní informace k postupu integrace naleznete v části dokumentace věnované Checkout SDK.

Pokud obchodník nedělá kontrolu dostupnosti Apple Pay a Google Pay na své straně, nemusí být tato metoda ve výsledku dostupná, i když si ji plátce vybral v košíku e-shopu. Plátci je následně nabídnuta standardní platba kartou s opisem údajů.

Zásady zobrazení tlačítek

Apple Pay v košíku e-shopu

Služba Apple Pay je dostupná pouze uživatelům, kteří mají k dispozici webový prohlížeč Safari a vlastní zařízení od společnosti Apple, které disponuje Touch ID nebo Face ID. K těmto zařízením patří MacBook, iPhone, iPad a stolní Mac. Z tohoto důvodu doporučujeme službu zobrazovat v objednávce pouze klientům, kteří platit s Apple Pay mohou. Návod najdete přímo na stránkách Apple pro vývojáře.

Nejsnadněji, jak tuto skutečnost ověřit lze pomocí:

if (window.ApplePaySession) {
   // Apple Pay JS API je dostupné => jsme na podporovaném zařízení

   window.ApplePaySession.canMakePayments()
     .then((result) => {
         // zařízení je schopné provádět platby pomocí Apple Pay
     })
}

Dále je potřeba dodržet nekolik náležitostí vyžadovaných společností Apple:

• Marketingové pokyny
• Zobrazení tlačítka Apple Pay
• Návod na použití vestavěných CSS stylů

Google Pay v košíku e-shopu

Pro Google Pay je potřeba dodržet náležitosti vyžadované společností Google:

• Zobrazení tlačítka Google Pay
• UX osvedčené postupy

Případy, kdy se Apple Pay nezobrazí

Může se stát, že Apple Pay plátci zobrazeno nebude, pokud Apple Pay knihovna vyhodnotí, že není možné platbu na daném zařízení realizovat.

Apple Pay se nezobrazí, když:

• plátce je v jiném prohlížeči než Safari (to samé platí pro “in App” browser na iOS ).

pokud je plátce v podporovaném prohlížeči Safari, tak se Apple Pay nezobrazí, když:

• platba probíhá v iframe,
• plátce nemá v Apple Wallet vloženou žádnou kartu,
• zařízení nepodporuje Apple Pay (například neaktualizované zařízení),
• knihovna Apple Pay z nějakého důvodu vyhodnotí, že platbu nelze provést (důvody nejsou sdělovány),
• není povoleno používat metodu Apple Pay na obchodě (například pro Shopify),
• obchod nepoužívá ke zpracování karetních transakcí metodu CARD_CZ_COMGATE ani CARD_CZ_CSOB_2,
• se jedná o opakovanou platbu (založená s parametrem initRecurring=true),
• se jedná o verifikační platbu (založená s parametrem verification=true),
• se jedná o opakovanou iniciační platbu.

Případy, kdy se Google Pay nezobrazí

Může se stát, že Google Pay plátci zobrazeno nebude, pokud Google Pay knihovna vyhodnotí, že není možné platbu na daném zařízení realizovat.

Google Pay se nezobrazí, když:

• knihovna Google Pay z nějakého důvodu vyhodnotí, že platbu nelze provést (důvody nejsou sdělovány),
• plátce používá nepodporovaný prohlížeč (seznam dostupných prohlížečů),
• není povoleno používat metodu Google Pay na obchodě (například pro Shopify),
• obchod nepoužívá ke zpracování karetních transakcí metodu CARD_CZ_COMGATE ani CARD_CZ_CSOB_2,
• se jedná o opakovanou platbu (založená s parametrem initRecurring=true),
• se jedná o verifikační platbu (založená s parametrem verification=true),
• se jedná o opakovanou iniciační platbu.

Odložená platba

Odložená platba umožňuje zákazníkům e-shopu odložit úhradu nákupu až o několik dnů. E-shop své peníze ale obdrží ve standardní době.

Pro zobrazení metody plátci (zákazníkovi e-shopu) je potřeba při založení platby volat metodu platby LATER_ALL. V případě, že se výběr platebních metod nachází na straně Comgate, plátci jsou zobrazeny všechny dostupné metody odložené platby. V případě, že má e-shop výběr platebních metod u sebe v košíku, doporučujeme jako název metody pro plátce uvést tento text: “Odložená platba”. Text popisku platební metody je “Nakupte hned, zaplaťte později.”

Tato metoda je dostupná pouze pro měnu CZK a občany České republiky.

Platba na třetiny

Platba na třetiny umožňuje zákazníkům e-shopu rozložit platbu za nákup na tři měsíční splátky. E-shop obdrží potvrzení o zaplacení ihned a ve standardní době mu poukážeme také hodnotu nákupu.

Pro zobrazení metody plátci (zákazníkovi e-shopu) je potřeba při založení platby volat metodu platby PART_ALL. V případě, že se výběr platebních metod nachází na straně Comgate, plátci je platba na splátky zobrazena vždy s hodnotou platby rovnou nebo vyšší 1500 CZK pro PART_TWISTO a 3000 CZK pro PART_SKIPPAY.

Tato metoda je dostupná pouze pro měnu CZK a občany České republiky.

SDK

SDK available at https://github.com/comgate-payments/sdk-php

Open-source solution: https://help.comgate.cz/docs/en/open-source-solution

Protocol Specification

Utilizes HTTP POST. The connection between the e-shop and the Comgate payment gateway is implemented through redirecting the payer from the e-shop to the payment gateway. After making a payment, the payer is redirected back to the e-shop. Meanwhile, communication between the e-shop server and the payment gateway server (server-to-server) is ongoing in the background. A detailed description of the communication protocol can be found further down this page. More related information can be found on pages that describe the payment process from the user and e-shop perspective, initial setup in the client portal, or the recommended method of testing the payment gateway integration.

For easy implementation of the payment gateway, you can use this PHP SDK (installation via composer).

Payment Process

Payment Setup – Optional

The payment setup step is optional, but it’s advisable to implement it when you require assurance of secure payment initiation. Omitting the implementation of this step is possible when you don’t need to identify individual payments in the system, but just need information that someone has paid you a certain amount. This is suitable for example when implementing donation contributions or topping up customer virtual account funds, when you only care about who topped up and how much, but don’t need to distinguish individual top-ups or limit them to a minimum amount etc. The procedure is detailed in the Simple Integration - Without Payment Setup section.

For a traditional e-shop, where the buyer pays for specific goods, the payment setup step is important, and its omission is not recommended.

The e-shop initiates the payment with an HTTP request to the payment gateway server. Payment parameters, including a unique payment reference number, are passed as POST parameters of the HTTP protocol. This communication takes place between the client’s server and the payment gateway server. The payer does not see this and cannot change the payment parameters. The payment gateway server returns to the client a unique transaction ID (identifier in the Comgate payment system) and a URL to which the payer should be redirected.

Example of Background Payment Setup – HTTP request using cURL

curl -X POST -i --data "merchant=123456&price=10000&curr=CZK&label=Beatles%20-0%Help&refId=2010102600&method=ALL&prepareOnly=true&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y" https://payments.comgate.cz/v1.0/create

Example of Background Payment Setup – HTTP response:

HTTP/2 200 OK
content-type: application/x-www-form-urlencoded; charset=UTF-8
code=0&message=OK&transId=AB12-CD34-EF56&redirect=https%3A%2F%2Fpayments.comgate.cz%2Fclient%2Finstructions%2Findex%3Fid%3DAB12-CD34-EF56

The communication between the client’s system and the payment gateway is secured using a password and IP whitelist (access is allowed only from the client’s system IP addresses). It is essential to use the HTTPS protocol, which prevents the revelation of the password in case the communication is intercepted. The password is passed as a POST parameter (not a GET parameter) so that it does not get stored in the web server’s communication log.

Redirect to the Payment Gateway

After setting up the payment in the background, the e-shop receives a payment URL to display the payment gateway. The payment gateway can be displayed in two ways. The first method is by redirecting the payer to the address received by the e-shop in the HTTP response. The redirect is usually performed by sending an HTTP 302 response:

HTTP response 302

HTTP/2 302 Found
Location: https://payments.comgate.cz/client/instructions/index?id=AB12-CD34-EF56

The second option is to display the payment gateway directly on the e-shop page using an iframe. For this option, you need to generate a payment URL in the standard way, but instead of redirecting the customer to the gateway, an iframe with the payment URL is displayed on the e-shop page.

Simple Integration – Without Payment Initiation

The payment gateway allows for skipping the first step of initiating payment in the background. In this case, the Payer is redirected to the payment gateway without prior payment initiation. The redirection can be done either by submitting a form using the POST method or a direct link using the GET method. We recommend the method of using a form.

Example of Simple Integration – Form Submission (POST)

<form method="POST" action="https://payments.comgate.cz/v1.0/create">

    <input type="hidden" name="merchant" value="XXXX" /> <!-- Identifier of the e-shop in the Comgate system -->

    <input type="hidden" name="price" value="100" /> <!-- 100 = 1.00 CZK -->

    <input type="hidden" name="curr" value="CZK" />

    <input type="hidden" name="label" value="My service" />

    <input type="hidden" name="refId" value="123456" />

    <input type="hidden" name="method" value="ALL" />

    <input type="hidden" name="country" value="CZ" />

    <button type="submit">Purchase</button>

</form>

Example of Simple Integration - Redirection Using Link (GET)

<a href="https://payments.comgate.cz/v1.0/create?merchant=XXXX&price=100&curr=CZK&label=My%20service&refId=10980891&method=ALL&country=CZ" rel="nofollow">Pay</a>

In the hyperlink parameters, keep the rel="nofollow" parameter.

Back-end Payment Result Transfer

Implementing this part will ensure you automatic transmission of the status of each payment transaction directly to your server at the moment the payment status is known. Back-end payment result transfer is mandatory.

The payment result is transmitted to the Client via an HTTP request from the payment gateway server to the Client’s server. Identifiers and the payment result are passed as POST parameters of the HTTP protocol. This communication runs in the background.

The Payer is redirected to the Client’s website and the payment identifiers are passed as GET parameters of the HTTP protocol. Sending the goods or services to the Payer must be tied to the back-end payment result transfer, not to the final redirection of the Payer to the Client’s website, because the Payer can easily falsify information passed by redirection.

Call parameters

Response Parameters

Example of payment result transmission in the background – HTTP request using cURL

curl -X POST -i --data "merchant=merchant_com&test=false&price=10000&curr=CZK&label=Beatles%20-%20Help&refId=2010102600&method=CARD&email=info%40customer.com&phone=%2B420123456789&transId=AB12-EF34-IJ56&secret=ZXhhbXBsZS5jb206QUJDeHl6&status=PAID" https://example.com/handler.php

Example of payment result transmission in the background – HTTP response

HTTP/2 200 OK
content-type: application/x-www-form-urlencoded; charset=UTF-8

Communication between the Client’s system and the payment gateway server is secured using a password and IP whitelist. Access must be allowed only from the IP address of the payment gateway server. IP address ranges are defined in the Security section. It is mandatory to use the HTTPS protocol, which prevents the password from being revealed if the communication is possibly intercepted. The password is passed as a POST parameter (not a GET parameter) so it is not stored in the communication log of the web server.

The e-shop on its side ensures that the goods (service) provided as part of the paid transaction (identified by a unique transaction ID) will be issued to the Payer only once (even when the result of the same payment is repeatedly transmitted to the Client’s server).

Redirecting the Payer to the Client’s website

Based on the payment status, the payer is redirected to one of three URLs that the e-shop selected when activating the service. Payment identifiers are passed as GET parameters of the HTTP protocol. The client’s system must be able to handle two basic situations:

• When redirecting the Payer to the client’s website, the payment result is not yet known. The payment is in PENDING status. This situation is absolutely normal and the e-shop should not present it as an error to the Payer. The system is waiting either for the payment to be credited to the bank account or for confirmation from the Payment Provider. The e-shop will find out the final result of the payment later, either by transmitting the payment result in the background, by email, or in the client portal.
• If the payment gateway learns the result of the payment immediately after the payment is made by the Payer, the Payer is directed to the appropriate URL (PAID or CANCELLED). If the e-shop has implemented the background payment result transmission, the redirection to the client’s website will be carried out only after the successful transmission of the payment result in the background. It is not possible to send the goods or service ordered by the Payer based solely on the URL used for redirection, because the Payer could forge the payment result by changing the URL in the web browser.

Example of redirecting the Payer to the client’s website - HTTP request

GET /result_ok.php?refId=2010102600&transId=AB12-EF34-IJ56 HTTP/2
Host: eshop.com

Payment gateway in the e-shop (iframe)

The payment gateway allows display optimized for iframe. This functionality is suitable in case you do not want to redirect the payer to the payment gateway, but display it within your system. To display the payment gateway in an iframe, you need to use the "embedded" = true parameter when creating the payment. The payment URL is generated in the standard way, but instead of redirecting the customer to the gateway, an iframe with the payment URL is displayed on the e-shop page.

There are two display options. Either you can display the payment gateway directly in the cart or using a pop-up window over your website. Implementing an iframe requires knowledge of web technologies. Iframe can only be used for card payment. For other payment methods, the payer will always be redirected to a new page.

For the correct display of the payment gateway in an iframe on the web page, we recommend making the following modification to your web pages.

Setting the display of the payment gateway

HTML code

<div id="comgate-container">
    <iframe id='comgate-iframe' allow="payment" src="[payment URL]" frameborder="0px"></iframe>
</div>

CSS styles

#comgate-container {
    display: none;
    position:absolute;
    z-index: 9999;
    left: 50%;
    top: 30px;
    overflow: auto;
    margin-left: -250px;
}
#comgate-iframe {
    width: 504px;
    height: 679px;
}
@media (max-height: 700px) {
    #comgate-iframe {
        top: 0px;
    }
}

JavaScript code

// function to open iframe with gateway
function comgateOpen() {
    let comgate_container = document.getElementById("comgate-container");
    comgate_container.style.display = "block";
}
// function to close iframe with gateway
function comgateClose() {
    let comgate_container = document.getElementById("comgate-container");
    comgate_container.style.display = "none";
}

To display the iframe, you need to call the comgateOpen() function. For example, by binding to a user action (clicking a button, etc.). The comgateClose() function then serves to possibly hide the iframe.

Example of calling the function to display the iframe by clicking the “Pay” button:

HTML code

<button id="comgate-open" onclick="comgateOpen()">Pay</button>

Redirecting the customer after completing the payment

After the payment is completed by the customer, they are redirected back to the e-shop on the URL that you have set in the client portal. We recommend performing one of the following modifications, which will ensure that the customer is redirected directly to the return URL and does not stay inside the iframe.

The first option is to redirect the external page to the URL you specified. This will refresh the entire page.

Javascript code for the internal page

window.top.location = window.self.location

The second option is to send a message from the page inside the iframe to the external page and process this event on the external page. This way, the entire page does not have to be refreshed.

Please note, the actual payment result needs to be obtained in the background in the usual way. For security reasons, it is not possible to rely on the result passed by a message from the iframe.

Javascript code for the internal page, which sends the external page a message with the payment ID and payment status, e.g., for a paid payment:

window.parent.postMessage('[payment id]|PAID', '*');

Javascript code for the external page, which processes the incoming message from the iframe:

// capture a message sent from the iframe using postMessage
if (window.addEventListener) {
    window.addEventListener('message', function (e) {
        // I get the id and payment result, the separator is a “pipe”
        let message = e.data.split('|', 2);
        let message_id =  message[0];
        let message_result =  message[1];
        let result = '';
        if (message_result === 'PAID') {
            // handling the PAID state
            [...]
        } else {
            // handling other states, etc ...
            [...]
        }
    }, false);
}

Payment gateway in the iframe from the payer’s perspective

The Comgate payment gateway allows users to repeat the payment if they failed to complete the payment the first time. The display of the payment gateway in the iframe to the user depends on the chosen payment method and also whether the selection of payment methods is on the e-shop side or the Comgate side.

If the selection of payment methods is on the e-shop side and the payment is therefore created with a payment method already selected, the card payment method must be chosen to display the iframe. If the user failed to complete the payment the first time, only the card payment method is displayed again for the next attempt. This version is recommended.

If the e-shop does not create a payment with an already selected payment method, the user is shown a selection of payment methods in the iframe. Here, it is necessary to choose card payment. If the user failed to complete the payment, the selection of payment methods in the iframe is shown again for the next attempt.

If a method other than card payment is chosen at any step of the payment process, the payer is redirected to a new page. The user will not return to the iframe.

Template for displaying the gateway in the e-shop

For easy implementation of our payment gateway into your e-shop, you can use the available template implementations below.

HTML code

<!doctype html>

<html lang="cs">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>Comgate :: working with iframe</title>

    <style>
        body,html {
            background: #fff;
            padding:0;
            margin:0;
            width: 100%;
            height: 100%;
        }
        .page {
            width: 100%;
            background: #eee;
            margin: 0 auto;
            max-width: 800px;
        }
        .page .header h1 {
            text-align: center;
            margin: 0;
            padding: 25px 15px;
            font-size: 25px;
        }
        #comgate-iframe-box {
            width: 450px; /* width is set automatically to 100% of screen width for small displays */
            height: 700px; /* for the new gateway, you can dynamically adjust the height according to your needs */
            margin: 0 auto;
        }
        #comgate-iframe-box .iframe {
            width: 100%;
            height: 100%;
        }
        @media (max-width: 450px) {
            #comgate-iframe-box {
                width: 100%;
            }
        }

    </style>
</head>

<body>
<div class="page">
    <div class="header">
        <h1>Demonstration of working with&nbsp;iframe</h1>
    </div>
    <div id="comgate-iframe-box">
        <!--
            In iframe configuration:
                use scrolling="off" for the new gateway
                use scrolling="on" for the old gateway
            Note: The URL address (src) of the established payment can change.
                  Always use the address returned by the API, and do not interfere with it.
         -->
        <iframe
            class="iframe"
            src="https://pay2.comgate.cz/init?id=XXXX-XXXX-XXXX"
            allow="payment"
            frameborder="0px"
            scrolling="off">
        </iframe>
    </div>
</div>
</body>
</html>

Payment statuses

• PENDING – The payment has been initiated, the final result is not yet known.
• PAID – The payer successfully completed the payment – goods can be issued, or the service can be made available.
• CANCELLED – The payment was not made, the goods will not be issued, and the service will not be provided.

A payment can only be considered paid in the PAID status. The PENDING status is not final and may be followed by the CANCELLED status.

API protocol - Comgate payment gateway

Security

Communication between the Comgate payment system and the e-shop takes place in three ways.

• The server part of the e-shop solution connects as a client to the server part of the payment gateway and calls methods for establishing payment, obtaining payment status in the background, confirming preauthorization, cancelling preauthorization, and obtaining a list of payment methods.
• The server part of the payment gateway connects as a client to the server part of the e-shop solution and calls a method to transfer the payment result in the background.
• The payer’s (user’s) browser is redirected from the e-shop to the payment gateway and then back to the e-shop from the payment gateway.

In all three cases, the use of the encrypted HTTPS protocol is necessary. The payment gateway only supports secure TLS/SSL protocol settings with the following allowed ciphers: https://github.com/cloudflare/sslconfig/blob/master/conf

In the case of server-to-server communication, communication is secured using a password (secret) and IP whitelist settings. These parameters can be set in the client portal environment.

Cloudflare service precedes the payment initiation. You can find the list of allowed IP addresses of Cloudflare here: https://www.cloudflare.com/ips-v4

The IP address range used by the Comgate system is defined as 89.185.236.55/32. This range is only used for transferring the payment result in the background.

Payment Gateway Methods

Payment Buttons

Fast bank transfers (payment buttons) are provided from all major banks in the Czech Republic, Poland, and Slovakia. You can find a list of available banks in our data tables. In the case of payment buttons, you can utilize features such as refunds and cancellation of payments. It is not possible to display the payment button directly in the e-shop (iframe). The payer is always redirected to the bank.

Card Payment

The payment gateway accepts VISA, VISA Electron, Mastercard, Maestro card payments. Payments are available in currencies CZK, EUR, USD, GBP, PLN, HUF RON, NOK and SEK. It is available in 14 languages - Czech, Slovak, English, German, French, Polish, Hungarian, Croatian, Slovenian, Romanian, Norwegian, Spanish, Italian and Swedish.

Within card payment, you can use many features. These include refunding payment, canceling unfinished payment, recurring payments (for example, for subscriptions with regular deduction of funds from the payer’s card), or preauthorization. Card payment can also be displayed directly in the e-shop (iframe).

Apple Pay and Google Pay

Both Apple Pay and Google Pay services are part of the Comgate payment gateway. To view customer services, you only need to have the CARD_CZ_COMGATE or CARD_CZ_CSOB_2 card payment method enabled.

Recurring and verification payment functionality cannot be used within the service. Other functionalities are available.

Displaying services

The display of both Apple Pay and Google Pay services depends on whether the selection of payment methods is in the e-shop cart or the e-shop uses the selection of methods from Comgate. It is also necessary to distinguish whether the payer should be redirected to the card gate or Apple Pay or Google Pay will be displayed directly in the e-shop cart.

We therefore distinguish three possibilities of displaying:

1. The button in the card gateway - If the choice of payment methods is on the Comgate side, no modifications are required to display the services. It is sufficient to have the card payment method CARD_CZ_COMGATE or CARD_CZ_CSOB_2 enabled. After the payer has selected one of these methods, the payment is made through the standard process with redirection to the payment gateway, where the services are displayed automatically. Here, the payer is also allowed to manually enter the card number. If the payer reaches the gateway from a device or browser that does not support any of the services, the payer will be able to make at least a payment by credit card.

2. The button in the e-shop’s cart with the redirection of the payer to the card gateway - If the choice of payment methods is on the side of the e-shop, the payment is based as a regular payment, however, in the request you need to call the APPLEPAY_REDIRECT or GOOGLEPAY_REDIRECT method. Subsequently, the payer is redirected to the payment gateway using the obtained payment link. Both Apple Pay and Google Pay buttons will then appear automatically on the card gateway. Subsequently, the payment process from the payer’s point of view is identical to the first option. We recommend that you follow our Google Pay and Apple Pay Button Display Policy, which are available below.

3. The button in the e-shop’s cart with the redirection of the payer to the card gateway This integration option does not redirect the payer to the card gateway and the payment is completely processed directly in the e-shop environment. Implementation of this behavior is more challenging than both of the above mentioned options. For this purpose, you must use our prepared JavaScript library Checkout SDK. Detailed information on the integration process can be found in Checkout SDK documentation section.

If the merchant does not check the availability of Apple Pay and Google Pay on their side, this method may not be available as a result, even if the payer chose it in the e-shop cart. The payer is then offered a standard payment by card with a copy of the data.

Button display policy

Apple Pay in shopping cart

Apple Pay is only available to users who have a Safari web browser and a custom Apple device that has a Touch ID or Face ID. These devices include MacBook, iPhone, iPad and desktop Mac. For this reason, we recommend that you display the service in your order only to clients who can pay with Apple Pay. Instructions can be found directly at Apple’s developer site.

The easiest way to verify this is through:

if (window.ApplePaySession) {
   // Apple Pay JS API is available => we are on a supported device

   window.ApplePaySession.canMakePayments()
     .then((result) => {
         // device is able to make payments using Apple Pay
     })
}

There are also several requirements required by Apple:

• Marketing guidelines
• Apple Pay Button Display
• Instructions for using built-in CSS styles

Google Pay in shopping cart

For Google Pay, you need to comply with the requirements required by Google:

• Google Pay Button Display
• UX best practices

Cases when Apple Pay does not appear

It may happen that Apple Pay will not be shown to the payer if the Apple Pay library evaluates that it is not possible to make the payment on the device.

Apple Pay does not appear when:

• payer is in a different browser than Safari (the same applies to “in App” browser on iOS ).

if the payer is in a supported Safari browser, then Apple Pay will not appear when:

• payment is processed in iframe,
• the payer has no card inserted in Apple Wallet,
• the device does not support Apple Pay (for example, non-updated device),
• the Apple Pay library evaluates for some reason that the payment cannot be made (reasons not disclosed),
• it is not allowed to use the Apple Pay method on the store (for example for Shopify),
• the store does not use the CARD_CZ_COMGATE or CARD_CZ_CSOB_2 method to process card transactions,
• it is a recurring payment (established with the initRecurring=true parameter),
• it is a verification payment (established with the verification=true parameter),
• it is a repeated initiation payment.,

Cases when Google Pay does not appear

It may happen that Google Pay will not be shown to the payer if the Google Pay library evaluates that it is not possible to make the payment on the device.

Google Pay does not appear when:

• the Google Pay library evaluates for some reason that the payment cannot be made (reasons not disclosed),
• payer uses unsupported browser (list of supported browsers),
• it is not allowed to use the Apple Pay method on the store (for example for Shopify),
• the store does not use the CARD_CZ_COMGATE or CARD_CZ_CSOB_2 method to process card transactions,
• it is a recurring payment (established with the initRecurring=true parameter),
• it is a verification payment (established with the verification=true parameter),
• it is a repeated initiation payment.,

Deferred payment

Deferred payment allows e-shop customers to delay the payment for a purchase by several days. However, the e-shop receives its money in the standard time.

To display the method to the payer (the e-shop customer), it is necessary to call the LATER_ALL payment method when initiating the payment. If the selection of payment methods is on the side of Comgate, all available methods of deferred payment are displayed to the payers. If the e-shop has the selection of payment methods in its cart, we recommend using this text as the method name for the payer: “Deferred payment”. The text of the payment method description is “Shop now, pay later.”

This method is only available for the CZK currency and citizens of the Czech Republic.

Pay in Thirds

Payment in thirds allows e-shop customers to spread the payment for a purchase over three monthly installments. The e-shop receives a payment confirmation immediately and we will also credit the value of the purchase in the standard time.

To display the method to the payer (the e-shop customer), it is necessary to call the PART_ALL payment method when initiating the payment. If the selection of payment methods is on the side of Comgate, installment payment is always displayed with a payment value equal to or higher than 1500 CZK for PART_TWISTO and 3000 CZK for PART_SKIPPAY.

This method is only available for the CZK currency and citizens of the Czech Republic.

SDK

SDK je k dispozícii na adrese https://github.com/comgate-payments/sdk-php

Riešenie s otvoreným zdrojovým kódom: https://help.comgate.cz/docs/en/open-source-solution

Špecifikácie protokolu

Používa HTTP POST. Prepojenie medzi e-shopom a platobnou bránou Comgate je realizované pomocou presmerovania platiteľa z e-shopu na platobnú bránu. Po vykonaní platby je platca presmerovaný späť do e-shopu. Zároveň na pozadí prebieha komunikácia medzi serverom e-shopu a serverom platobnej brány (server - server). Detailný opis komunikačného protokolu nájdete nižšie na tejto stránke. Ďalšie súvisiace informácie nájdete na stránkach, ktoré opisujú proces platby z pohľadu užívateľa a e-shopu, počiatočné nastavenie v klientskom portáli, odporúčaný spôsob testovania integrácie platobnej brány alebo detailný opis napojenia na EET.

Použijte PHP Software development kit (SDK)

Pre snadnú implementáciu platobnej brány môžete použíť tento PHP SDK (inštalácia cez composer)

Priebeh platby

Založenie platby – voliteľné

Krok založenia platby je voliteľný, je však vhodné ho implementovať v prípade, keď požadujete istotu zabezpečeného založenia platby. Vynechanie implementácie tohto kroku je možné v prípade, kedy jednotlivé platby nepotrebujete v systéme identifikovať, ale stačí vám informácia, že vám niekto zaplatil určitú čiastku.

Je to vhodné napríklad pri implementácii darcovských príspevkov alebo dobíjaní prostriedkov na virtuálny účet zákazníka, kedy vás zaujíma len to, kto dobíja a akú sumu, ale nepotrebujete rozlišovať jednotlivé dobitie zákazníka alebo obmedziť dobitie na minimálnu čiastku atď. Pre klasický e-shop, kde platíte za konkrétny tovar, je však vynechanie tohto kroku nevhodné.

Platbu e-shopu zakladá HTTP požiadavkou na server platobnej brány. Parametre platby, vrátane unikátneho referenčného čísla platby, sú odovzdané ako POST parametre HTTP protokolu. Táto komunikácia prebieha medzi serverom Klienta a serverom platobnej brány. Platiteľ ju nevidí a nemôže meniť parametre platby. Server platobnej brány vráti Klientovi unikátny identifikátor transaction ID (identifikátor v Comgate platobnom systéme) a URL adresu, na ktorú má presmerovať Platiteľ.

Parametre volania

Parametre odpovedí

Príklad založenia platby na pozadí - HTTP request:

curl -X POST -i --data "merchant=123456&price=10000&curr=CZK&label=Beatles%20-0%Help&refId=2010102600&method=ALL&prepareOnly=true&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y" https://payments.comgate.cz/v1.0/create

Príklad založenia platby na pozadí - HTTP response:

HTTP/2 200 OK
content-type: application/x-www-form-urlencoded; charset=UTF-8
code=0&message=OK&transId=AB12-CD34-EF56&redirect=https%3A%2F%2Fpayments.comgate.cz%2Fclient%2Finstructions%2Findex%3Fid%3DAB12-CD34-EF56

Komunikácia medzi systémom Klienta a platobnou bránou je zabezpečená pomocou hesla a IP whitelistu (prístup je povolený len z IP adries systému Klienta). Nevyhnutné je použitie protokolu HTTPS, ktorý znemožňuje prezradenie hesla pri prípadnom odpočúvaní komunikácie. Heslo je odovzdávané ako POST parameter (nie GET parameter) preto, aby sa neukladalo v logu komunikácie webového servera.

Presmerovanie na platobnú bránu

Po založení platby na pozadí dostane e-shop platobné URL na zobrazenie platobnej brány. Platobná brána môže byť zobrazená dvoma spôsobmi. Prvým spôsobom je presmerovanie platiteľa na adresu, ktorú dostal e-shop v HTTP odpovedi. Presmerovanie sa zvyčajne vykonáva odoslaním HTTP odpovede 302:

HTTP odpoveď 302

HTTP/2 302 Found
Location: https://payments.comgate.cz/client/instructions/index?id=AB12-CD34-EF56

Druhou možnosťou je zobrazenie platobnej brány priamo na stránke e-shopu pomocou iframe. Pre tento variant je potrebné vygenerovať platobné URL štandardným spôsobom, ale namiesto presmerovania zákazníka na bránu sa zobrazí na stránke e-shopu iframe s platobnou URL.

V prípade vynechania prvého kroku založenia platby na pozadí je platba založená až pri presmerovaní Platiteľa z webu Klienta na server platobnej brány alebo odoslaní webového formulára z webu Klienta na server platobnej brány. Parametre platby, vrátane unikátneho referenčného čísla platby, sú odovzdané ako GET alebo POST parametre HTTP protokolu.

Príklad založenia platby presmerovaním (odoslaním webového formulára) - HTTP request

curl -X POST -i --data "merchant=123456&price=10000&curr=CZK&label=Beatles%20-20Help&refId=2010102600&method=ALL" https://payments.comgate.cz/v1.0/create

Odovzdanie výsledku platby na pozadí

Implementácia tejto časti vám zaistí automatické odovzdanie informácie o stave každej platobnej transakcie priamo na váš server v okamihu, keď je stav platby známy. Odovzdávanie výsledku platby na pozadí je povinné.

Výsledok platby je Klientovi odovzdaný HTTP požiadavkou zo servera platobnej brány na server Klienta. Identifikátory a výsledok platby sú odovzdané ako POST parametre HTTP protokolu. Táto komunikácia sa uskutočňuje na pozadí.

Platiteľ je presmerovaný na webové stránky Klienta a identifikátory platby sú odovzdané ako GET parametre HTTP protokolu. Odoslanie tovaru alebo služby Platiteľa musí byť viazané na odovzdanie výsledku platby na pozadí, nie na výsledné presmerovanie Platiteľa na webové stránky Klienta, pretože informácie zaslané presmerovaním môže Platiteľ ľahko podstrčiť.

Príklad odovzdania výsledku platby na pozadí - HTTP request

curl -X POST -i --data "merchant=merchant_com&test=false&price=10000&curr=CZK&label=Beatles%20-%20Help&refId=2010102600&method=CARD&email=info%40customer.com&phone=%2B420123456789&transId=AB12-EF34-IJ56&secret=ZXhhbXBsZS5jb206QUJDeHl6&status=PAID" https://example.com/handler.php

Príklad odovzdania výsledku platby na pozadí - HTTP response

HTTP/2 200 OK
content-type: application/x-www-form-urlencoded; charset=UTF-8

Komunikácia medzi systémom Klienta a serverom platobnej brány je zabezpečená pomocou hesla a IP whitelistu. Prístup musí byť povolený iba z IP adresy servera platobnej brány. Rozsahy IP adries sú definované v sekcii Zabezpečenie. Je povinné použiť protokol HTTPS, ktorý znemožňuje prezradenia hesla pri prípadnom odpočúvaní komunikácie. Heslo je odovzdávané ako POST parameter (nie GET parameter) preto, aby sa neukladalo v logu komunikácie webového servera.

E-shop na svojej strane zabezpečí, že tovar (služba) poskytnutý v rámci zaplatenej transakcie (identifikovanej pomocou unikátneho transaction ID) bude vydaný Platiteľom iba raz (aj pri opakovanom odovzdaní výsledku rovnakej platby na server Klienta).

Presmerovanie Platiteľa na web Klienta

Platiteľ je na základe stavu platby presmerovaný na jedno z troch URL, ktoré e-shop zvolil pri aktivácii služby. Identifikátory platby sú odovzdané ako GET parametre HTTP protokolu. Systém klienta musí byť schopný ošetriť dve základné situácie:

• Pri presmerovaní platiteľa na web klienta výsledok platby ešte nie je známy. Platba je v stave PENDING. Táto situácia je úplne bežná a e-shop ju nesmie platiteľovi prezentovať ako chybu. Systém čaká buď na pripísanie platby na bankový účet alebo na potvrdenie od poskytovateľa platby. Konečný výsledok platby sa e-shop dozvie neskôr buď odovzdaním výsledku platby na pozadí alebo e-mailom alebo na klientskom portáli.
• Ak sa platobná brána dozvie výsledok platby okamžite po uskutočnení platby platiteľom, potom je platiteľ smerovaný na príslušné URL (PAID alebo CANCELLED). Ak e-shop implementoval odovzdávanie výsledku platby na pozadí, potom sa presmerovanie na web Klienta vykoná až po úspešnom odovzdaní výsledku platby na pozadí. Platiteľovi nemožno odoslať tovar alebo službu, ktorú objednal, iba na základe URL použitej na presmerovanie, pretože platiteľ by mohol výsledok platby podstrčiť zmenou URL vo webovom prehliadači.

Príklad presmerovania Platiteľa na web Klienta - HTTP request

GET /result_ok.php?refId=2010102600&transId=AB12-EF34-IJ56 HTTP/2
Host: eshop.com

Platobná brána v e-shope (iframe)

Platobná brána umožňuje zobrazenie optimalizované pre iframe. Táto funkcia je vhodná v prípade, že nechcete platiteľa presmerovávať na platobnú bránu, ale zobraziť ju v rámci svojho systému. Aby sa platobná brána zobrazila v iframe, je potrebné pri založení platby použiť parameter „embedded“ = true. Platobné URL je vygenerované štandardným spôsobom, ale namiesto presmerovania zákazníka na bránu sa zobrazí na stránke e-shopu iframe s platobnou URL.

Na zobrazenie sú dve možnosti. Jednak je možné platobnú bránu zobraziť priamo v košíku alebo pomocou vyskakovacieho okna nad vašou webovou stránkou. Implementácia iframu vyžaduje znalosť webových technológií. Iframe je možné použiť len pre platbu kartou. Pri ostatných platobných metód dôjde vždy k presmerovanie platiteľa na novú stránku.

Pre správne zobrazenie platobnej brány v iframe na webovej stránke odporúčame vykonať nasledujúcu úpravu vašich webových stránok.

Nastavenie zobrazenia platobnej brány

HTML kód

<div id="comgate-container">
    <iframe id='comgate-iframe' allow="payment" src="[platební URL]" frameborder="0px"></iframe>
</div>

CSS štýly

#comgate-container {
    display: none;
    position:absolute;
    z-index: 9999;
    left: 50%;
    top: 30px;
    overflow: auto;
    margin-left: -250px;
}
#comgate-iframe {
    width: 504px;
    height: 679px;
}
@media (max-height: 700px) {
    #comgate-iframe {;
        top: 0px;
    }
}

Javascriptový kód

// funkce pro otevření iframu s bránou
function comgateOpen() {
    var comgate_container = document.getElementById("comgate-container");
    comgate_container.style.display = "block";
}
// funkce pro zavření iframu s bránou
function comgateClose() {
    var comgate_container = document.getElementById("comgate-container");
    comgate_container.style.display = "none";
}

Na zobrazenie iframe je potrebné vyvolať funkciu comgateOpen (). Napríklad nadviazaním na akciu užívateľa (kliknutie na tlačidlo a pod.). Funkcia comgateClose () potom slúži na prípadné skrytie iframe.

Príklad vyvolania funkcie na zobrazenie iframe kliknutím na tlačidlo „Zaplatiť“:

HTML kód

<button id="comgate-open" onclick="comgateOpen()">Zaplatit</button>

Presmerovanie zákazníka po dokončení platby

Po dokončení platby zákazníkom dochádza k jeho presmerovaniu do e-shopu na URL, ktorú ste nastavili na klientskom portáli. Odporúčame vykonať jednu z nasledujúcich úprav, ktorá zaistí, že zákazník bude presmerovaný priamo na návratovú URL a nezostane tak vnútri iframe.

Prvou možnosťou je presmerovať vonkajšiu stránku na vami určenú URL. Tým dôjde k obnoveniu celej stránky.

Javascriptový kód pre vnútornú stránku

window.top.location = window.self.location

Druhou možnosťou je zo stránky vnútri iframe poslať správu vonkajšej stránke a na vonkajšej strane túto udalosť spracovať. Nemusí teda dôjsť k obnoveniu celej stránky.

Pozor, skutočný výsledok platby je potrebné získať na pozadí štandardným spôsobom. Z bezpečnostných dôvodov nie je možné spoliehať na výsledok odovzdaný správou z iframe.

Javascriptový kód pre vnútornú stránku, ktorý pošle vonkajšej stránke správu s ID platby a stavom platby, napr. pre zaplatenú platbu:

window.parent.postMessage('[id platby]|PAID', '*');

Javascriptový kód pre vonkajšiu stránku, ktorý spracuje prichádzajúcu správu z iframe:

// odchycení zprávy poslané z iframu pomocí postMessage
if (window.addEventListener ) {
    window.addEventListener('message', function (e) {
        // přijde mi id a výsledek platby, oddělovač je “roura”
        let message = e.data.split('|', 2);
        let message_id = message[0];
        let message_result = message[1];
        let result = '';
        if (message_result === 'PAID') {
            // obsloužení stavu PAID
            [...]
        } else {
            // obsloužení dalších stavů, atd ...
            [...]
        }
    }, false);
}

Platobná brána v iframe z pohľadu platcu

Platobná brána Comgate umožňuje užívateľom opakovať platbu, ak sa im nepodarilo dokončiť platbu na prvýkrát. Zobrazenie platobnej brány v iframe užívateľovi je závislé od zvolenej platobnej metódy a tiež, či sa výber platobných metód nachádza na strane e-shopu alebo na strane Comgate.

V prípade, že je výber platobných metód na strane e-shopu a platba je tak založená už s platobnou metódou, musí byť na zobrazenie iframe zvolená metóda platby kartou. Ak sa užívateľovi nepodarilo platbu na prvýkrát dokončiť, pre ďalší pokus sa mu opäť zobrazí iba metóda platby kartou. Táto verzia je odporúčaná.

V prípade, že e-shop nezakladá platbu s už vybranou platobnou metódou, užívateľovi sa v iframe zobrazí výber platobných metód. Tu je následne potrebné zvoliť platbu kartou. Ak sa užívateľovi nepodarilo platbu dokončiť, pre ďalší pokus sa mu opäť zobrazí výber platobných metód v iframe.

Pokiaľ dôjde v akomkoľvek kroku platobného procesu k vybratiu inej metódy než platby kartou, dôjde k presmerovaniu platiteľa na novú stránku. Užívateľ sa už späť do iframe nevráti.

Stavy platieb

• PENDING – platba bola založená, finálny výsledok platby zatiaľ nie je známy.
• PAID – platiteľ úspešne dokončil platbu - je možné vydať tovar, resp. sprístupniť službu.
• CANCELLED – platba nebola zaplatená, tovar nebude vydaný, resp. služba nebude poskytnutá.

Platbu možno považovať za zaplatenú iba v stave PAID. Stav PENDING nie je koncový a môže po ňom nasledovať stav CANCELLED.

API protokol - platobná brána Comgate

Zabezpečenie

Komunikácia medzi Comgate platobným systémom a e-shopom sa uskutočňuje troma spôsobmi.

• Serverová časť e-shopového riešenia sa ako klient pripojí k serverovej časti platobnej brány a vyvolá metódy na založenie platby, získanie stavu platby na pozadí, potvrdenie predautorizácie, zrušenie predautorizácie a získanie zoznamu platobných metód.
• Serverová časť platobnej brány sa ako klient pripojí k serverovej časti e-shopového riešenia a vyvolá metódu na odovzdanie výsledku platby na pozadí.
• Prehliadač platiteľa (používateľa) je presmerovaný z e-shopu na platobnú bránu a následne z platobnej brány späť do e-shopu.

Vo všetkých troch prípadoch je nevyhnutné použitie šifrovaného protokolu HTTPS. Platobná brána podporuje iba bezpečné nastavenie TLS / SSL protokolu s nasledujúcimi povolenými šiframi: https://github.com/cloudflare/sslconfig/blob/master/conf

V prípade komunikácie server - server je komunikácia zabezpečená pomocou hesla (Secret) a nastavenia IP whitelistu. Nastavenie týchto parametrov je možné vykonať v prostredí klientskeho portálu.

Zakladanie platieb je predradené službe CloudFlare. Zoznam povolených IP adries CloudFlare nájdete tu: https://www.cloudflare.com/ips-v4

Rozsah IP adries používaný systémom Comgate je definovaný ako 89.185.236.55/32. Tento rozsah sa používa iba na odovzdanie výsledku platby na pozadí.

Metódy platobnej brány

Platobné tlačidlá

Zrýchlené bankové prevody (platobné tlačidlá) poskytujeme od všetkých významných bánk v Česku, Poľsku a na Slovensku. Zoznam dostupných bánk nájdete v číselníkoch. V prípade platobných tlačidiel je možné využiť funkcie, ako sú refundácia a storno platby.

Platobné tlačidlo nie je možné zobraziť priamo v e-shope (iframe). Platiteľ je vždy presmerovaný do banky.

Platba kartou

Platobná brána akceptuje platby kartou VISA, VISA Electron, Mastercard, Maestro. Platby sú dostupné v menách EUR, CZK, PLN, HUF, USD, GBP a RON, NOK a SEK. Je k dispozícii v 14 jazykoch - v slovenčine, češtine, angličtine, nemčine, francúzštine, poľštine, maďarčine, chorvátčine, slovinčine, rumunčine, nórčine a švédčine.

V rámci platby kartou je možné využiť mnoho funkcií. Medzi ne patrí refundácia platby, storno nedokončenej platby, opakované platby (napríklad pre predplatné s pravidelným strhávaním prostriedkov z karty platiteľa) alebo predautorizácia. Platbu kartou možno tiež zobraziť priamo v e-shope (iframe).

Apple Pay a Google Pay

Apple Pay aj Google Pay sú súčasťou platobnej brány Comgate. Na zobrazenie týchto služieb stačí, aby mali zákazníci povolenú platobnú metódu CARD_CZ_COMGATE alebo CARD_CZ_CSOB_2.

V rámci služby nie je možné používať funkcie opakovaných a overovacích platieb. Ostatné funkcie sú k dispozícii.

Zobrazenie služieb

Zobrazenie služieb Apple Pay aj Google Pay závisí od toho, či je výber platobných metód v košíku e-shopu alebo či e-shop používa výber metód Comgate. Taktiež je potrebné rozlišovať, či má byť platiteľ presmerovaný na kartovú bránu, alebo či sa Apple Pay alebo Google Pay zobrazuje priamo v prostredí košíka e-shopu.

K dispozícii sú tri možnosti zobrazenia:

1. Tlačidlo v bráne karty - Ak sa výber spôsobov platby nachádza na stránke Comgate, na zobrazenie služieb nie sú potrebné žiadne úpravy. Stačí, ak je zapnutá platobná metóda CARD_CZ_COMGATE alebo CARD_CZ_CSOB_2. Po výbere jednej z týchto metód platiteľom platba prejde štandardným procesom s presmerovaním na platobnú bránu, kde sa služby zobrazia automaticky. Tu môže platiteľ tiež ručne zadať číslo karty. Ak platiteľ pristupuje k platobnej bráne zo zariadenia alebo prehliadača, ktorý nepodporuje niektorú zo služieb, bude môcť vykonať aspoň platbu kreditnou kartou.

3. Tlačidlo v košíku e-shopu s presmerovaním platiteľa na platobnú bránu - Ak je výber platobných metód na strane e-shopu, platba sa nastaví ako bežná platba, ale v požiadavke je potrebné zavolať metódu APPLEPAY_REDIRECT alebo GOOGLEPAY_REDIRECT. Platiteľ je potom presmerovaný na platobnú bránu pomocou získaného platobného odkazu. Na platobnej bráne sa potom automaticky zobrazia tlačidlá Apple Pay aj Google Pay. Proces platby z pohľadu platiteľa je potom totožný s prvou možnosťou. Odporúčame dodržiavať naše zásady zobrazovania tlačidiel Google Pay a Apple Pay, ktoré sú k dispozícii nižšie.

3. Tlačidlo v košíku e-shopu bez presmerovania na platobnú bránu Pri tejto možnosti integrácie nie je platiteľ presmerovaný na kartovú bránu a platba sa kompletne spracuje priamo v prostredí e-shopu. Implementácia tohto správania je náročnejšia ako oba vyššie uvedené varianty. Na tento účel je potrebné použiť našu JavaScriptovú knižnicu Checkout SDK. Podrobné informácie o postupe integrácie nájdete v sekcii dokumentácie Checkout SDK.

Ak obchodník na svojej strane neskontroluje dostupnosť Apple Pay a Google Pay, táto metóda nemusí byť vo výsledku dostupná, aj keď ju platiteľ v košíku e-shopu zvolil. Platiteľovi sa potom ponúkne štandardná platba kartou s kópiou údajov.

Zásady zobrazovania tlačidiel

Apple Pay v košíku e-shopu

Apple Pay je k dispozícii len používateľom s webovým prehliadačom Safari a zariadením Apple s Touch ID alebo Face ID. Medzi tieto zariadenia patria MacBook, iPhone, iPad a stolný Mac. Z tohto dôvodu odporúčame, aby si túto službu v objednávke zobrazovali len klienti, ktorí môžu platiť pomocou služby Apple Pay. Návod nájdete priamo na stránke vývojárov spoločnosti Apple.

Túto skutočnosť si najjednoduchšie overíte tak, že:

if (window.ApplePaySession) {
   // Rozhranie Apple Pay JS API je k dispozícii => sme na podporovanom zariadení

   window.ApplePaySession.canMakePayments()
     .then((result) => {
         // zariadenie dokáže uskutočňovať platby pomocou služby Apple Pay
     })
}

Existuje aj niekoľko požiadaviek vyžadovaných spoločnosťou Apple:

• Marketingové pokyny
• Zobrazenie tlačidla Apple Pay
• Pokyny na používanie vstavaných štýlov CSS

Google Pay v košíku e-shopu

V prípade služby Google Pay musíte splniť formálne požiadavky spoločnosti Google:

• Zobrazenie tlačidla Google Pay
• Nejlepší postupy UX

Prípady, keď sa Apple Pay nezobrazí

Služba Apple Pay sa platiteľovi nemusí zobraziť, ak knižnica Apple Pay vyhodnotí, že platbu nie je možné v zariadení spracovať.

Apple Pay sa nezobrazí, keď:

• Platiteľ je v inom prehliadači ako Safari (to isté platí pre prehliadač “v aplikácii” v systéme iOS).

ak je platiteľ v podporovanom prehliadači Safari, Apple Pay sa nezobrazí, keď:

• platba sa uskutočňuje v iframe,
• platiteľ nemá vloženú kartu v službe Apple Wallet,
• zariadenie nepodporuje Apple Pay (napríklad zariadenie, ktoré nebolo aktualizované),
• knižnica Apple Pay vyhodnotí, že platbu nemožno z nejakého dôvodu uskutočniť (dôvody nie sú zverejnené),
• Apple Pay nie je v online obchode povolené (napríklad pre Shopify),
• obchod nepoužíva na spracovanie kartových transakcií metódu CARD_CZ_COMGATE alebo CARD_CZ_CSOB_2,
• ide o opakovanú platbu (na základe parametra initRecurring=true),
• ide o overovaciu platbu (na základe parametra verification=true),
• ide o opakovanú iniciačnú platbu.

Prípady, v ktorých sa služba Google Pay nezobrazuje

Môže sa stať, že služba Google Pay sa platiteľovi nezobrazí, ak knižnica Google Pay vyhodnotí, že platbu nemožno v zariadení spracovať.

Platba Google sa nezobrazí, keď:

• knižnica Google Pay vyhodnotí, že platbu nemožno z nejakého dôvodu uskutočniť (dôvody nie sú zverejnené),
• platiteľ používa nepodporovaný prehliadač. (zoznam dostupných prehliadačov),
• Google Pay nie je v online obchode povolené (napríklad pre Shopify),
• obchod nepoužíva na spracovanie kartových transakcií metódu CARD_CZ_COMGATE alebo CARD_CZ_CSOB_2,
• ide o opakovanú platbu (na základe parametra initRecurring=true),
• ide o overovaciu platbu (na základe parametra verification=true),
• ide o opakovanú iniciačnú platbu.

Odložená platba

Odložená platba umožňuje zákazníkom e-shopu odložiť úhradu nákupu až o niekoľko dní. E-shop svoje peniaze ale dostane v štandardnom čase.

Na zobrazenie metódy platiteľovi (zákazníkovi e-shopu) je potrebné pri založení platby vyvolať metódu platby LATER_ALL. V prípade, že sa výber platobných metód nachádza na strane Comgate, pre platiteľa sú zobrazené všetky dostupné metódy odloženej platby. V prípade, že má e-shop výber platobných metód pri sebe v košíku, odporúčame ako názov metódy pre platiteľa uviesť tento text: „Odložená platba“. Text opisu platobnej metódy je „Nakúpte hneď, zaplaťte neskôr“.

Táto metóda je dostupná len pre menu CZK a občanov Českej republiky.

TAG_api_payment_methods

create

POST /v1.0/create

Access is protected by IP address validation and the integrity of transmitted data is ensured using the HTTPS protocol. The step of creating payments is optional, but it is advisable to implement it in case you require the certainty of secure payment creation. It is possible to skip the implementation of this step if you do not need to identify individual payments in the system, but only require information that someone has paid you a certain amount. This is suitable, for example, when implementing donations or recharging funds to a customer’s virtual account, where you are only interested in who recharged what amount, but you do not need to differentiate individual recharges or limit recharges to a minimum amount. However, for a classic e-shop, where you pay for specific goods, it is inappropriate to skip this step. The merchant uses HTTP requests to create payment transaction. Payment attributes including unique payment reference numbers are sent as POST parameters via HTTP protocol. Communication is only between the Merchant’s server and the payment gateway server. It is invisible to payer and the payer cannot change the payment parameters. The payment gateway server responds by sending a unique payment transaction identifier – transaction ID (Comgate payments system identifier) and URL to which to redirect the payer

The payment gateway server responds only if the payment is created in a background. All parameters are urlencoded, as in the case of an HTTP request. If the payment is created through redirection (the prepareOnly parameter is ‘false’), then the payment gateway server directly redirects the Payer to the appropriate URL or displays an error message.

Choice of payment method
We recommend to display selection of payment methods to Payer during the purchase process and, based on his choice, create the payment with the method parameter on one specific value (eg payment by card or payment by bank transfer, etc.). Then, the page of the specific payment provider (bank) will be displayed directly.

If the method parameter is not filled in with one specific value, the offer of payment methods will be displayed on the payment gateway. The offer of payment methods can be specified by a simple expression, which is entered in the method parameter. The expression is always evaluated on the basis of the methods that the e-shop has enabled.

Allowed method identifier delimiters are ‘+’ for method addition and ‘-’ for method subtraction from / to selection.

Example:
The payment gateway allows the Payer to have one specific payment method pre-selected when selecting a payment method in the Comgate gateway environment. In this case Payer only needs to be redirected to the payment gateway using the obtained payment link with the added parameter ‘method’ with the selected method.
The payment link can therefore look like this:
https://payments.comgate.cz/client/instructions/index?id=ABCDEFGHIJ&method=CARD_CZ_CS
After getting at the payment gateway, the Payer will already have the CARD_CZ_CS method checked, but the selection of the method will remain on the Payer.

Pre-authorization
The payment gateway allows to enter, confirm and cancel pre-authorizations of card payments. The payment is created in the standard way, it is only necessary to specify the parameter preauth = true. After Payer enters data at the payment gateway, the corresponding amount is reserved on his payment card. Depending on the result of this operation, it goes either to the special AUTHORIZED state or, in the case of rejection, to the CANCELED state. This result is reported in the background according to the usual procedure described above.
In order for the money to be actually withdrawn, the e-shop calls the function to confirm the pre-authorization. If the money is to be released (eg it is not possible to meet the conditions of the purchase contract), the e-shop calls the function to cancel the pre-authorization.Přístup je chráněn validací IP adresy a integrita předávaných dat je zajištěna použitím HTTPS protokolu.

Server platební brány odpovídá pouze v případě, že je platba zakládána na pozadí. Všechny parametry jsou ‘urlencoded’, stejně jako v případě HTTP requestu. Pokud je platba založena přesměrováním (parametr ‘prepareOnly’ je ‘false’), pak server platební brány rovnou přesměruje Plátce na příslušnou URL nebo zobrazí chybovou zprávu.

Výběr platební metody
V rámci nákupního procesu v e-shopu je možné zobrazit plátci výběr platebních metod a na základě jeho výběru založit platbu s vyplněním parametru ‘method’ na jednu konkrétní hodnotu (např. platba kartou nebo platba převodem z ČS apod). Potom dojde k přímému zobrazení stránky poskytovatele konkrétní platby (banka).
V případě, že parametr ‘method’ není vyplněn jednou konkrétní hodnotou, dojde k zobrazení nabídky platebních metod na platební bráně. Nabídka platebních metod může být specifikována jednoduchým výrazem, který se zadává do parametru ‘method’. Výraz se vždy vyhodnocuje na základě metod, které má e-shop povolené.

Předautorizace
Platební brána umožňuje zadávat, potvrzovat a rušit předautorizace plateb kartou. Založení platby probíhá standardně, pouze je potřeba uvést parametr ‘preauth=true’. Poté plátce projde stejným procesem jako v případě normální platby. Poté, co zadá své údaje na platební bráně, je na jeho platební kartě zarezervována příslušná částka. Podle výsledku této operace přechází buď do zvláštního stavu AUTHORIZED, nebo v případě zamítnutí do stavu CANCELLED. Tento stav je ohlášen na pozadí obvyklým postupem popsaným výše.
Aby byly peníze skutečně strženy, volá e-shop funkci pro potvrzení předautorizace. Pokud se peníze mají uvolnit (např. není možné naplnit podmínky kupní smlouvy), volá funkci pro zrušení předautorizace.
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 (parameter ‘prepareOnly’ je ‘false’), potom server platobnej brány rovno presmeruje Platiteľ na príslušnú URL alebo zobrazí chybové hlásenie.

Výber platobnej metódy
Odporúčame v rámci nákupného procesu v e-shope zobraziť platcovi výber platobných metód a na základe jeho výberu založiť platbu s vyplnením parametra ‘method’ na jednu konkrétnu hodnotu (napr. platba kartou alebo platba prevodom z ČS apod). Potom dôjde k priamemu zobrazeniu stránky poskytovateľa konkrétnej platby (banka).
V prípade, že parameter ‘method’ nie je vyplnený jednou konkrétnou hodnotou, dôjde k zobrazeniu ponuky platobných metód na platobnej bráne. Ponuka platobných metód môže byť špecifikovaná jednoduchým výrazom, ktorý sa zadáva do parametra ‘method’. Výraz sa vždy vyhodnocuje na základe metód, ktoré má e-shop povolené.
Povolené oddeľovače identifikátorov metód sú ‘+’ pre pripočítanie metódy a ‘–’ pre odpočítacie metódy z/do výberu.
Príklad:
BANK_ALL + CARD_CZ_CS - BANK_CZ_KB = všetky bankové metódy vrátane platby kartou bez bankového tlačidla Komerční banky.
BANK_CZ_CS_P + BANK_CZ_KB + BANK_CZ_RB = iba bankové tlačidla pri Českej sporiteľni, Komerčnej banke a Reiffeisen Bank (iba tieto 3 na rozdiel od BANK_ALL, ktorý by vybral všetky povolené bankové metódy e-shopu).
Platobná brána umožňuje, aby Platiteľ mal pri výbere platobnej metódy v prostredí brány Comgate predvybranú jednu konkrétnu platobnú metódu. Stačí, aby bol platiteľ presmerovaný na platobnú bránu pomocou získaného platobného odkazu s pridaným parametrom ‘method’ s vybranou metódou.
Platobný odkaz teda môže vyzerať nasledovne:
https://payments.comgate.cz/client/instructions/index?id=ABCDEFGHIJ&method=CARD_CZ_CS
Po príchode na bránu bude mať Platiteľ už zapnutú metódu CARD_CZ_CS, výber metódy ale ďalej zostane na ňom. Táto funkcia má zmysel iba pre platby založené s metódou ALL, BANK_ALL alebo s vlastným výberom metódy.

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.

Body parameter

merchant: "123456"
test: true
country: string
price: "1000"
curr: CZK
label: Product 123
refId: order445566
method: ALL
account: string
email: platce@email.com
name: string
lang: string
prepareOnly: false
secret: gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y
preauth: true
initRecurring: true
verification: true
applePayPayload: string
expirationTime: string
dynamicExpiration: true

Sample OK response

HTTP/2 200 OK
Content-Type: application/x-www-form-urlencoded
code=0&message=OK&transId=AB12-CD34-EF56&redirect=https%3A%2F%2Fpayments.comgate.cz%2Fclient%2Finstructions%2Findex%3Fid%3DAB12-CD34-EF56

Parameters

Responses

Response Schema

Status Code 200

cURLPHPJavaPythonC# Code samples

# You can also use wget
curl -X POST https://payments.comgate.cz/v1.0/create \
--data "&merchant=123456&test=true&price=1000&curr=CZK&label=Product 123&refId=order445566&method=ALL&email=platce@email.com&prepareOnly=false&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y" \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/x-www-form-urlencoded'

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/x-www-form-urlencoded',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_params = [
    "merchant" => "123456",
    "test" => "true",
    "price" => "1000",
    "curr" => "CZK",
    "label" => "Product 123",
    "refId" => "order445566",
    "method" => "ALL",
    "email" => "platce@email.com",
    "prepareOnly" => "false",
    "secret" => "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
];

try {
    $response = $client->request('POST','https://payments.comgate.cz/v1.0/create', array(
        'headers' => $headers,
        'form_data' => $request_params,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

String params = "&merchant=123456&test=true&price=1000&curr=CZK&label=Product 123&refId=order445566&method=ALL&email=platce@email.com&prepareOnly=false&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y";

byte[] postData = params.getBytes();
URL obj = new URL("https://payments.comgate.cz/v1.0/create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setDoOutput(true);
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
con.setRequestProperty("Content-Length", Integer.toString(postData.length));

OutputStream os = con.getOutputStream();
os.write(postData);
os.flush();
os.close();

BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/x-www-form-urlencoded'
}

r = requests.post('https://payments.comgate.cz/v1.0/create', params={
    "merchant": "123456",
    "test": "true",
    "price": "1000",
    "curr": "CZK",
    "label": "Product 123",
    "refId": "order445566",
    "method": "ALL",
    "email": "platce@email.com",
    "prepareOnly": "false",
    "secret": "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
}, headers = headers)

print(r.text)

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.Collections.Generic;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://payments.comgate.cz/v1.0/create";

      var content = new Dictionary<string, string> {
            {"merchant", "123456"},
            {"test", "true"},
            {"price", "1000"},
            {"curr", "CZK"},
            {"label", "Product 123"},
            {"refId", "order445566"},
            {"method", "ALL"},
            {"email", "platce@email.com"},
            {"prepareOnly", "false"},
            {"secret", "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y"},
      };

      await PostAsync(content, url);
    }

    /// Performs a POST Request
    public async Task PostAsync(Dictionary<string, string> content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Dictionary<string, string> content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

cancel

POST /v1.0/cancel

Storno of payment
If the order in the e-shop has been canceled and the transaction is not to be completed by the payer, it is possible to use the storno of payment. Unlike a refund, the payment must be in the pending state.
Due to the speed of payment, the payment may already be paid, in which case an error will be displayed and the refund method must be used.Storno platby
V případě, že byla objednávka v e-shopu stornována a transakce nemá být plátcem dokončena, je možné využít storno platby. Na rozdíl od refundace musí být platba ve stavu očekávaná (pending).
Vzhledem k rychlosti zaplacení plateb může být platba již ve stavu zaplacená, v takovém případě se zobrazí chyba a je nutné využít metodu refundace.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.

Body parameter

merchant: "123456"
transId: AB12-CD34-EF56
secret: gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y

Sample OK response

HTTP/2 200 OK
Content-Type: application/x-www-form-urlencoded
code=0&message=OK

Parameters

Responses

Response Schema

Status Code 200

cURLPHPJavaPythonC# Code samples

# You can also use wget
curl -X POST https://payments.comgate.cz/v1.0/cancel \
--data "&merchant=123456&transId=AB12-CD34-EF56&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y" \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/x-www-form-urlencoded'

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/x-www-form-urlencoded',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_params = [
    "merchant" => "123456",
    "transId" => "AB12-CD34-EF56",
    "secret" => "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
];

try {
    $response = $client->request('POST','https://payments.comgate.cz/v1.0/cancel', array(
        'headers' => $headers,
        'form_data' => $request_params,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

String params = "&merchant=123456&transId=AB12-CD34-EF56&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y";

byte[] postData = params.getBytes();
URL obj = new URL("https://payments.comgate.cz/v1.0/cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setDoOutput(true);
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
con.setRequestProperty("Content-Length", Integer.toString(postData.length));

OutputStream os = con.getOutputStream();
os.write(postData);
os.flush();
os.close();

BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/x-www-form-urlencoded'
}

r = requests.post('https://payments.comgate.cz/v1.0/cancel', params={
    "merchant": "123456",
    "transId": "AB12-CD34-EF56",
    "secret": "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
}, headers = headers)

print(r.text)

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.Collections.Generic;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://payments.comgate.cz/v1.0/cancel";

      var content = new Dictionary<string, string> {
            {"merchant", "123456"},
            {"transId", "AB12-CD34-EF56"},
            {"secret", "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y"},
      };

      await PostAsync(content, url);
    }

    /// Performs a POST Request
    public async Task PostAsync(Dictionary<string, string> content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Dictionary<string, string> content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

recurring

POST /v1.0/recurring

Recurring payments, remembering card details
The payment gateway allows you to enter recurring payments, that is, one-click payments. The first (initial) payment takes place through a standard process with redirection to the payment gateway, subsequent payments already take place completely in the background. The system thus allows the payer to pay within a few seconds without having to fill in information about the payment card.
This functionality is available on request. In the case of recurring payments at the beginning, we create an initial payment, which is created as a regular payment, only the request contains an additional parameter initRecurring - method create. Subsequent recurring payments are already created using the recurring method and are linked to the Comgate ID of the initiating transaction. This ID must be tied to a specific Payer in the Client’s system.
After creating a recurring payment, the Payer is not redirected to the payment gateway, because the whole process takes place in the background, the Client is only given the status of the payment, and he then displays this status to the Payer.

Subsequent recurring payments
Creating a second and subsequent recurring payment to the payment gateway is only possible in the case of accepting cards for e-shops that have the service enabled.The first (initial) payment is made in the standard way (see Creating a payment). The process of creating a second and each subsequent payment takes place completely in the background, these payments are tied to the initiator via the Comgate ID of the initiation payment. This ID must be in the request in the initRecurringId parameter. The payer is shown the payment status in the e-shop system as a result.

All parameters are urlencoded, as in the case of an HTTP request to create a standard payment. The answer contains the code parameter, according to which the e-shop determines what result the payer will display. Code = 0 means success, the payment was created, any other code means an error and therefore no payment was created.

Recurring payments
Recurring payments with a predefined amount and period (eg monthly, weekly, etc.) can be made using the Recurring Payments service, which is described in the previous paragraphsOpakované platby, zapamatování karetních údajů
Platební brána umožňuje zadávání opakovaných plateb, to je plateb na jedno kliknutí. První (iniciační) platba probíhá standardním procesem s přesměrováním na platební bránu, následující platby už probíhají kompletně na pozadí. Systém tak umožňuje plátci zaplatit během několika sekund bez nutnosti vyplňovat informace o platební kartě.
Tato funkcionalita je dostupná na vyžádání. V případě opakovaných plateb na začátku zakládáme iniciační platbu, která se zakládá jako běžná platba, pouze se v požadavku nachází navíc parametr ‘initRecurring’ - metoda create. Následné opakované platby jsou už zakládány metodou recurring a jsou vázány na Comgate ID iniciační transakce. Toto ID musí být v systému Klienta vázáno na konkrétního Plátce.
Po založení opakované platby nedochází k přesměrování Plátce na platební bránu, protože celý proces probíhá na pozadí, Klientovi je pouze předán stav založení platby, a ten následně zobrazí tento stav Plátci.

Následující opakované platby
Založení druhé a následující opakované platby do platební brány je možné pouze při akceptaci karet pro e-shopy, které mají službu povolenou. První (iniciační) platba probíhá standardní cestou (viz Založení platby). Proces založení druhé a každé další platby probíhá kompletně na pozadí, tyto platby jsou vázány na iniciační přes Comgate ID iniciační platby. Toto ID se musí nacházet v požadavku v parametru ‘initRecurringId’. Plátci je v systému e-shopu jako výsledek zobrazen stav platby.

Všechny parametry jsou urlencoded, stejně jako v případě HTTP requestu pro založení standardní platby. V odpovědi se nachází parametr ‘code’, podle kterého e-shop určí, jaký výsledek zobrazí plátci. Code = 0 znamená úspěch, platba byla založena, jakýkoliv jiný kód znamená chybu a tudíž nezaložení platby.

Rekurentní platby (recurring)
Rekurentí platby, tzn. opakované platby s předem definovanou částkou a periodou (např. měsíční, týdenní apod.) lze realizovat pomocí služby Opakované platby, která je popsána v předchozích odstavcích.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 založená, akýkoľvek iný kód znamená chybu a teda nezaloženie platby.

Rekurentné platby (recurring)
Rekurentné platby, tzn. opakované platby s vopred zadefinovanou sumou a periódou (napr. mesačné, týždenné apod.) je možné realizovať pomocou služby Opakované platby, ktorá je opísaná v predchádzajúcich odsekoch.

Body parameter

merchant: "123456"
country: string
test: true
price: "10000"
curr: CZK
label: string
refId: "2010102600"
account: string
email: platce@email.com
name: string
prepareOnly: true
secret: gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y
initRecurringId: AB12-CD34-EF56

Sample OK response

HTTP/2 200 OK
Content-Type: application/x-www-form-urlencoded
code=0&message=OK

Parameters

Responses

Response Schema

Status Code 200

cURLPHPJavaPythonC# Code samples

# You can also use wget
curl -X POST https://payments.comgate.cz/v1.0/recurring \
--data "&merchant=123456&price=10000&curr=CZK&label=string&refId=2010102600&email=platce@email.com&prepareOnly=true&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y&initRecurringId=AB12-CD34-EF56" \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/x-www-form-urlencoded'

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/x-www-form-urlencoded',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_params = [
    "merchant" => "123456",
    "price" => "10000",
    "curr" => "CZK",
    "label" => "string",
    "refId" => "2010102600",
    "email" => "platce@email.com",
    "prepareOnly" => "true",
    "secret" => "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
    "initRecurringId" => "AB12-CD34-EF56",
];

try {
    $response = $client->request('POST','https://payments.comgate.cz/v1.0/recurring', array(
        'headers' => $headers,
        'form_data' => $request_params,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

String params = "&merchant=123456&price=10000&curr=CZK&label=string&refId=2010102600&email=platce@email.com&prepareOnly=true&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y&initRecurringId=AB12-CD34-EF56";

byte[] postData = params.getBytes();
URL obj = new URL("https://payments.comgate.cz/v1.0/recurring");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setDoOutput(true);
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
con.setRequestProperty("Content-Length", Integer.toString(postData.length));

OutputStream os = con.getOutputStream();
os.write(postData);
os.flush();
os.close();

BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/x-www-form-urlencoded'
}

r = requests.post('https://payments.comgate.cz/v1.0/recurring', params={
    "merchant": "123456",
    "price": "10000",
    "curr": "CZK",
    "label": "string",
    "refId": "2010102600",
    "email": "platce@email.com",
    "prepareOnly": "true",
    "secret": "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
    "initRecurringId": "AB12-CD34-EF56",
}, headers = headers)

print(r.text)

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.Collections.Generic;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://payments.comgate.cz/v1.0/recurring";

      var content = new Dictionary<string, string> {
            {"merchant", "123456"},
            {"price", "10000"},
            {"curr", "CZK"},
            {"label", "string"},
            {"refId", "2010102600"},
            {"email", "platce@email.com"},
            {"prepareOnly", "true"},
            {"secret", "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y"},
            {"initRecurringId", "AB12-CD34-EF56"},
      };

      await PostAsync(content, url);
    }

    /// Performs a POST Request
    public async Task PostAsync(Dictionary<string, string> content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Dictionary<string, string> content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

refund

POST /v1.0/refund

Payment refund
The refund method is intended for payments already created and paid. Payment status must be paid. It is possible to make both a partial (refunded amount is lower than the payment amount) and a full refund (the refund amount is equal to the payment amount). The amount will be transferred back to the payer’s account.
If the payment has not been completed and is in a pending state, it is possible to use the payment storno method.Refundace platby
Metoda pro refundaci je určena pro již založené a proplacené platby. Stav platby musí být zaplacená (paid). Je možné provést jak částečnou (refundovaná částka je nižší, než částka platby), tak plnou refundaci (částka refundace je rovna částce platby). Daná částka bude převedena zpět na účet plátce.
Pokud platba nebyla dokončena a je ve stavu pending, je možné využít metodu storno platby.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.

Body parameter

merchant: "123456"
transId: AB12-CD34-EF56
secret: gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y
amount: "10000"
curr: CZK
test: true
refId: string

Sample OK response

HTTP/2 200 OK
Content-Type: application/x-www-form-urlencoded
code=0&message=OK

Parameters

Responses

Response Schema

Status Code 200

cURLPHPJavaPythonC# Code samples

# You can also use wget
curl -X POST https://payments.comgate.cz/v1.0/refund \
--data "&merchant=123456&transId=AB12-CD34-EF56&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y&amount=10000" \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/x-www-form-urlencoded'

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/x-www-form-urlencoded',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_params = [
    "merchant" => "123456",
    "transId" => "AB12-CD34-EF56",
    "secret" => "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
    "amount" => "10000",
];

try {
    $response = $client->request('POST','https://payments.comgate.cz/v1.0/refund', array(
        'headers' => $headers,
        'form_data' => $request_params,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

String params = "&merchant=123456&transId=AB12-CD34-EF56&secret=gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y&amount=10000";

byte[] postData = params.getBytes();
URL obj = new URL("https://payments.comgate.cz/v1.0/refund");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setDoOutput(true);
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
con.setRequestProperty("Content-Length", Integer.toString(postData.length));

OutputStream os = con.getOutputStream();
os.write(postData);
os.flush();
os.close();

BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/x-www-form-urlencoded'
}

r = requests.post('https://payments.comgate.cz/v1.0/refund', params={
    "merchant": "123456",
    "transId": "AB12-CD34-EF56",
    "secret": "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y",
    "amount": "10000",
}, headers = headers)

print(r.text)

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.Collections.Generic;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "https://payments.comgate.cz/v1.0/refund";

      var content = new Dictionary<string, string> {
            {"merchant", "123456"},
            {"transId", "AB12-CD34-EF56"},
            {"secret", "gx4q8OV3TJt6noJnfhjqJKyX3Z6Ych0y"},
            {"amount", "10000"},
      };

      await PostAsync(content, url);
    }

    /// Performs a POST Request
    public async Task PostAsync(Dictionary<string, string> content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Dictionary<string, string> content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}