Technická specifikace Platební brána IBS

Transkript

1 Technická specifikace Platební brána IBS Verze 1 Strana 1 z 6

2 1. Obecné Platební brána je určena k platbě za zboží nebo služby nakoupené v internetovém obchodě, kdy uživatel je přesměrován na přihlašovací obrazovku do internetového bankovnictví RB (IB) a po úspěšné autentizaci mu systém nabídne předvyplněný formulář pro založení platebního příkazu (PP). Uživatelé zastupující internetový obchod mají možnost stáhnout si pomocí URL odkazu soubor s přehledem příchozích plateb za zvolené období. 2. Platební brána 2.1 Specifikace Aplikace IB bude mít v případě, že je na ní přistupováno pomocí http requestu na platební bránu toto chování: 1. Odlišný design login stránky od standardní login stránky. 2. Ve vlastní aplikaci bude dostupná funkčnost platebního příkazu a funkčnost obsažená v menu Nastavení, ostatní funkčnosti nebudou dostupné. 3. Parametr shopname musí obsahovat identifikační řetězec obchodníka, který je zaregistrován v systému banky a je ve statusu aktivní. 4. Kód banky (parametr creditbank ) a číslo účtu (parametr creditaccount ) se musí rovnat hodnotám, které má obchodník zaregistrován v systému banky. V případě, že některá z validací odhalí chybu, systém požadavek odmítne. 5. Struktura URL odkazu je atd 6. V rámci URL odkazu mohou být předány následující parametry: Název Popis Povinný Poznámka parametr shopname Identifikační řetězec obchodníka. Atribut, který slouží k identifikaci plateb při dotazech obchodníků na přehled příchozích plateb creditaccount Číslo účtu obchodníka (kreditní účet) creditbank Kód banky obchodníka (RB) amount Částka platby curcode Kód měny platby Vždy CZK credittext Zpráva pro příjemce varsymbol VS constsymbol specsymbol KS SS validfrom Den splatnosti Bude plněn datem splatnosti. URL obchodníka Odkaz, na který bude klient přesměrován po ukončení práce na platebním příkazu. V rámci URL budou odeslány tyto parametry: completed : v případě, že PP URL parametr je využit v případě, že nejsou vyplněny parametry URLsuccess a URLfail Verze 1 Strana 2 z 6

3 byl úspěšně zadán tak bude mít hodnotu Y, jinak N. orderid : bude obsahovat vstupní parametr varsymbol URLsuccess Odkaz, na který bude klient přesměrován po úspěšném zadání PP. V rámci URL budou odeslány tyto parametry: orderid : bude obsahovat vstupní parametr varsymbol URLfail Odkaz, na který bude klient přesměrován po neúspěšném zadání PP. V rámci URL budou odeslány tyto parametry: orderid : bude obsahovat vstupní parametr varsymbol 7. Parametry korespondující se vstupními poli formuláře pro zadání PP budou využity pro jeho předvyplnění. Žádný z předvyplněných parametrů nebude možné editovat. 8. Nebude-li datum splatnosti vyplněno (parametr validfrom ), systém doplní datum na nejbližší možné datum splatnosti. Pole nebude možné editovat. 9. Po úspěšné front-end validaci a založení požadavku na PP bude na ovou adresu předanou v parametrech URL odkazu zaslán informační o provedené platbě. 10. Přesměrování klienta po zadání PP na specifické URL Po úspěšném založení požadavku na PP bude ukončena session v IB a klient bude přesměrován na URL dle pravidla: Byl-li v předávaných parametrech pro PP vyplněn parametr URLsuccess, tak na URLsuccess (v rámci Jinak: Byl-li v předávaných parametrech pro PP definován parametr URL, tak na URL (v rámci Jinak: Na URL, ze které byl klient odkázán na platební bránu. Po neúspěšném založení požadavku na PP z důvodů nalezení chyby front-end kontrolou bude ukončena session v IB (klient nebude informován, ve kterém vstupním poli je problém) a klient bude přesměrován na URL dle pravidla: Byl-li v předávaných parametrech pro PP vyplněn parametr URLfail, tak na URLfail (v rámci Jinak: Byl-li v předávaných parametrech pro PP definován parametr URL, tak na URL (v rámci Jinak: Na URL, ze které byl klient odkázán na platební bránu. Na případy, kdy nedojde k založení požadavku na PP z jiných důvodů, než je popsáno v bode 2. (např. klientovi se nepodaří autentizovat, klient zavře okno prohlížeče apod.), nebude systém žádným přesměrováním reagovat. Verze 1 Strana 3 z 6

4 3. Přehled příchozích plateb 1. Pomocí https rozhraní budou mít uživatelé provozující e-shopy možnost dotázat se na přehled příchozích plateb. 2. Uživatel si bude moci vybrat formát vráceného souboru (pomocí parametru v URL dotazu). Budou podporovány tyto formáty: OLD data jsou vložena do řádků (co platba to řádek) a sloupce jsou odděleny středníkem, řádky jsou odděleny tagem <BR> HTML formát HTML PLAIN každá platba je uvozena tagem <PRE>. Sloupce jsou odděleny středníkem, např. <PRE>sloupec 1; sloupec 2; </PRE>. 3. Struktura URL odkazu je atd 4. V rámci URL dotazu na přehled plateb budou posílány tyto parametry (slouží pro výběr požadovaných dat a jejich formátu): Název Popis Povinný parametr Parametr pro výběr dat Poznámka shopname password Identifikační řetězec obchodníka Heslo pro autentizaci do systému Slouží k identifikaci uživatele. debitaccount Číslo účtu kupujícího debitbank Kód banky kupujícího creditaccount Číslo účtu obchodníka (kreditní účet) creditbank Kód banky obchodníka (RB) amountfrom Minimální hodnota platby Formát XXXXXXXXX.XX amountto Maximální hodnota platby Formát XXXXXXXXX.XX curcode Kód měny platby Vždy CZK varsymbol VS constsymbol KS validfrom První den splatnosti Formát DD.MM.YYYY validto Poslední den splatnosti Formát DD.MM.YYYY paidfrom První den připsání plateb Formát DD.MM.YYYY Verze 1 Strana 4 z 6

5 paidto Poslední den připsání plateb Formát DD.MM.YYYY showaccname Název účtu kupujícího. Hodnota N znamená, že se název v přehledu nevrátí, jinak (hodnota Y nebo jiná) se vždy vrátí. showspecsymbol SS Hodnota N znamená, že se symbol v přehledu nevrátí, jinak (hodnota Y nebo jiná) se vždy vrátí. showid Číselný identifikátor transakce Hodnota N znamená, že se identifikátor v přehledu nevrátí, jinak (hodnota Y nebo jiná) se vždy vrátí. listtype Formát přehledu Není-li vyplněn nebo je vyplněn neplatně, pak se vrátí formát OLD. 5. Nejsou-li vyplněny parametry validfrom a validto, je přehled plateb implicitně vrácen pro platby s datem splatnosti v intervalu posledních 31 dnů 6. Vrácený přehled bude obsahovat tyto informace (pořadí sloupců je závazné): Pořadí Obsah sloupce Poznámka 1. První den splatnosti Bude plněno datem splatnosti (value date) 2. Poslední den splatnosti Bude plněno datem splatnosti (value date) 3. Předepsaná částka Stejná jako převedená částka 4. Třímístný kód předepsané měny 5. Převedená částka 6. Datum převodu Bude plněno datem zúčtování (posting date) 7. Číslo účtu plátce (debetní účet) 8. Kód banky plátce 9. Číslo účtu partnera (účet obchodníka - kreditní) 10. Kód banky partnera 11. VS 12. KS 13. Zpráva pro příjemce 14. Stav platby Může nabývat hodnot 0 (nezrealizováno), 2 (zrealizováno) a 4 (ukončeno) 15. Název debetního účtu 16. SS 17. Číselný identifikátor transakce Jednoznačný identifikátor požadavku v rámci GEMINI systému. Verze 1 Strana 5 z 6

6 7. Stav platby bude určen následovně: 0 (nezrealizováno) požadavek na PP čeká na zpracování (čeká na autorizaci nebo na datum splatnosti) 2 (zrealizováno) požadavek na PP byl úspěšně proveden - byla zaúčtována transakce. 4 (ukončeno) požadavek na PP nebyl přijat bankovním systémem, zpracování skončilo neúspěšně Verze 1 Strana 6 z 6