API metódy platby (1.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

V prípade zakladania platby na pozadí vyplňte 'true'. Pri zakladaní platby presmerovaním vyplňte buď 'false' alebo parameter nepoužívajte. Aký povolený spôsob založenia platby máte nastavený, zistíte v Klientskom portáli v sekcii Integrácia - Prepojenie obchodu.

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

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

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

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

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

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

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

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

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

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

krátky opis produktu (1 – 16 znakov)

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

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

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

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

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

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

variabilný symbol platby

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

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

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

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

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

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

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

Formát vrátených dát ('xml' alebo 'json'). Pokiaľ nebude vyplnené, použije sa 'xml'.

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

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

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

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

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

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

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

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

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