API metody platby (1.0)

Hodnota 'true' znamená, že platba bude založena jako testovací, hodnota 'false' znamená produkční verzi. Pokud parametr chybí, založí se platba jako produkční.

Možné hodnoty: 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. Pro ostatní země použijte ALL. Pokud parametr chybí, použije se automaticky 'CZ'. Parametr slouží k omezení výběru platebních metod na platební bráně. Je potřeba aby byla zvolena správná kombinace parametrů 'country' a 'curr' (měna) pro daný region. Například pro zobrazení českých tlačítek a platby kartou v měně CZK zvolte kombinaci country=CZ a curr=CZK. U slovenských bankovních tlačítek a platby kartou v EUR zvolte country=SK a curr=EUR. Pro polská bankovní tlačítka a platbu kartou v PLN zvolte country=PL a curr=PLN. Pro ostatní cizí měny můžete použít parametr country=ALL nebo další kód země, který platební brána přijímá.

Cena za produkt v centech nebo haléřích. U měny HUF nelze zadat cenu s desetinnými místy. V tomto případě musí cena vždy končit 00.
Musí být 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 měny dle ISO 4217. K dispozici jsou měny: CZK, EUR, PLN, HUF, USD, GBP, RON, NOK, SEK.

Krátký popis produktu (1-16 znaků) – dle této položky je možné filtrovat platby v Klientském portálu.

Parametr vhodný k zadaní variabilního symbolu nebo čísla objednávky na straně Klienta (nemusí být unikátní, tzn., že lze založit více plateb se stejným refId). V Klientském portálu a denním csv. je parametr označen jako ID Klienta.

Metoda platby z tabulky platebních metod, hodnota 'ALL' v případě, že si má metodu vybrat plátce, nebo jednoduchý výraz s výběrem metod.
Více zde: https://apidoc.comgate.cz/metody-platebni-brany

Identifikátor bankovního účtu Klienta, na který Comgate převede peníze. Pokud parametr nevyplníte, použije se výchozí účet Klienta. Seznam účtů Klienta najdete na https://portal.comgate.cz/.

Kontaktní email plátce. Povinný je pouze jeden z údajů emailová adresa nebo telefonní číslo.

Telefonní číslo plátce v mezinárodním formátu +420777112233. Povinný je pouze jeden z údajů emailová adresa nebo telefonní číslo.

Jméno a příjmení plátce, např. Josef Novák.

Fakturační adresa - město. (např. Hradec Králové).

Fakturační adresa - ulice. (např. Jiráskova 115).

Fakturační adresa - PSČ. (např. 50304).

Fakturační adresa - země, ve formátu ISO 3166 alpha-2 (např. CZ, SK, US, GB).

Způsob doručení - jedna z dostupných možností: HOME_DELIVERY, PICKUP, ELECTRONIC_DELIVERY. Varianta PICKUP znamená všechna výdejní místa, výdejní boxy apod.

Doručovací adresa - město. Vyplňuje se pouze v případě delivery=HOME_DELIVERY (např. Hradec Králové).

Doručovací adresa - ulice. Vyplňuje se pouze v případě delivery=HOME_DELIVERY (např. Štefanikova 421).

Doručovací adresa - PSČ. Vyplňuje se pouze v případě delivery=HOME_DELIVERY (např. 50341).

Doručovací adresa - země, ve formátu ISO 3166 alpha-2. Vyplňuje se pouze v případě delivery=HOME_DELIVERY (např. CZ, SK, US, GB).

Kategorie produktu v košíku - jedna z dostupných možností, která nejvíce popisuje košík: PHYSICAL_GOODS_ONLY, OTHER. Varianta OTHER zahrnuje i dárkové karty, vouchery nebo služby.

Identifikátor produktu – tato položka se nachází v denním csv. Klienta pod názvem Produkt.

Kód jazyka (ISO 639-1), ve kterém budou Plátci zobrazeny instrukce pro dokončení platby, standardně 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'), pokud parametr chybí, použije se 'cs', v případě požadavku na další jazyk, kontaktujte podpora@comgate.cz.

V případě požadavku na předautorizaci platby kartou nastavte na 'true'. V případě normální platby vyplňte 'false' nebo parametr nepoužívejte. Pouze pro platby kartou.

Příznak pro založení iniciační transakce pro opakované platby. Pouze pro Klienty, kteří mají službu povolenou.

Parametr ověřovací platby, v případě požadavku na založení ověřovací platby (hodnota 'true') není nutné posílat parametr '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. Více o dynamické expiraci najdete v článku zde.

Individuální nastavení pro jednotlivé platby. Např. 'https://www.example.com/result.php?id=${id}&refId=${refId}'

Individuální nastavení pro jednotlivé platby. Např. 'https://www.example.com/result.php?id=${id}&refId=${refId}'

Hodnota 'true' znamená, že platba bude založena jako testovací, hodnota 'false' znamená produkční verzi. Pokud parametr chybí, založí se platba jako produkční.

Cena za produkt v centech nebo haléřích. Musí být min. 10 CZK (včetně), max. neomezeno.

kód měny dle ISO 4217, standardně 'CZK'

krátký popis produktu (1-16 znaků)

Reference platby v systému e-shopu (nemusí být unikátní, tzn., že lze založit více plateb se stejným refId).

Identifikátor bankovního účtu e-shopu, na který Comgate převede peníze. Pokud parametr nevyplníte, použije se výchozí účet e-shopu. Seznam účtů e-shopu najdete na https://portal.comgate.cz/.

Identifikátor produktu - dle této položky je potom možné se zorientovat ve statistikách plateb Comgate platebního systému.

unikátní alfanumerický identifikátor (kód) transakce (transactionId)

částka refundace – může být v plné nebo částečné výši transakce. Částka refundace se zadává v centech nebo haléřích. U měny HUF nelze zadat částku s desetinnými místy. V tomto případě musí částka vždy končit 00.

Hodnota 'true' znamená, že refundace bude založena jako testovací. Refundace a platba bude prověřena standardní cestou, pouze nedojde k refundaci původní platby.
Pokud je vyplněno 'false' nebo je parametr prázdný, je založena ostrá refundace.
Testovací transakce mohou být refundovány pouze testovací refundací.

variabilní symbol platby

částka refundace – může být v plné nebo částečné výši transakce

Pokud není vyplněno, nebo je false, tak vrací data : název souboru a jeho obsah; pokud je true, tak vrací rovnou CSV soubor.

Pokud není vyplněno, nebo je false, tak vrací data : název souboru a jeho obsah; pokud je true, tak vrací rovnou ABO soubor.

parametr 'type' může nabývat hodnot 'v1' a 'v2'. Pod 'v1' získáte ABO verzi s poplatky uvedenými zvlášť ke každé platbě, pod 'v2' pak ABO s poplatkem souhrnným v jednom řádku. Pokud nebude parametr vyplněn, automaticky obdržíte typ 'v1'.

Kódování znaků může mít hodnoty utf8 nebo win1250. Pokud není hodnota vyplněna je hodnota parametru defaultně ve formátu utf8.

parametr 'type' může nabývat hodnot 'v1' a 'v2'. Pod 'v1' získáíte ABO verzi s poplatky uvedenými zvlášť ke každé platbě, pod 'v2' pak ABO s poplatek souhrným v jednom řádku. Pokud nebude parametr vyplněn, automaticky obdržíte typ 'v1'.

Kódování znaků může mít hodnoty utf8 nebo win1250. Pokud není hodnota vyplněna je hodnota parametru defaultně ve formátu utf8.

Výběr, v jakém jazyce budou popisy metod. Povolené hodnoty jsou 'bg', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'hr', 'hu', 'it', 'lt', 'lv', 'nl', 'no', 'pl', 'pt', 'ro', 'si', 'sk', 'sv', 'vi'. Pokud nebude vyplněno, použije se 'cs'.

Vyplněním parametru na hodnoty CZK nebo EUR dojde k vrácení metod, které podporují zadanou měnu (CZK, EUR, PLN, HUF, USD, GBP, RON, NOK, SEK).

Kód země ('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'), parametr slouží k omezení výběru platebních metod pro zadanou zemi.

Cena za produkt v centech nebo haléřích. U měny HUF nelze zadat cenu s desetinnými místy. V tomto případě musí cena vždy končit 00.
Musí být 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.

Příznak pro iniciační transakce pro opakované platby. Pouze pro Klienty, kteří mají službu povolenou.

Parametr ověřovací platby, v případě požadavku na založení ověřovací platby (hodnota ‘true’) není nutné posílat parametr ‘initRecurring’.

V případě požadavku na předautorizaci platby kartou nastavte na ‘true’. V případě normální platby vyplňte ‘false’ nebo parametr nepoužívejte. Pouze pro platby kartou.

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í.

Parametr 'embedded' slouží k filtrování metod v případě, že se brána bude zobrazovat v iframe. Dojde k odfiltrování platebních metod, které není možné na platební bráně v iframe zobrazit. Pokud zobrazujete platební bránu v iframe, použijte 'embedded=true'.