Technická příručka aplikace Popis API ernetového bankovnictví Českomoravská záruční a rozvojová banka, a.s. Jeruzalémská 964/4, 110 00 Praha 1 Tel.: +420 255 721 111 E-mail: info@cmzrb.cz www: http://www.cmzrb.cz 1 z 26 Verze 1.0 ČMZRB, a.s.
Obsah 1 Úvod... 3 2 Právní rámec... 3 3 Aplikační programové rozhraní (API)... 3 3.1 Služby... 3 3.1.1 WKClientLogonService... 3 3.1.2 WKClientService... 3 3.1.3 Souhrn použití metod služeb... 4 3.2 Bezpečnostní token... 4 3.3 SOAP hlavička... 5 3.4 Ošetření chyb... 5 3.5 Identifikace a ověření poskytovatele služby... 6 3.6 Identifikace a ověření uživatele... 7 3.6.1 Autentizace... 7 3.6.2 Autorizace... 10 3.7 Metody služby API... 11 3.7.1 Výběr aktuálního účtu... 11 3.7.2 Příkaz k úhradě... 12 3.7.3 Zahraniční platba... 15 3.7.4 Informace o účtu... 18 3.7.5 Datové typy (Entity)... 20 3.7.6 Výčtové typy... 26 2 z 26 Verze 1.0 ČMZRB, a.s.
1 Úvod Předmětem toho dokumentu je popis aplikačního programového rozhraní API pro přístup k funkcím ernetového bankovnictví ČMZRB. 2 Právní rámec Tato technická příručka reaguje na povinnosti ČMZRB vyplývající ze Směrnice Evropského parlamentu a Rady (EU) 2015/2366 o platebních službách na vnitřním trhu a Zákona č. 370/2017 o platebním styku. Dokument je určen licencovaným tzv. třetím stranám dle výše uvedené směrnice. Internetové bankovnictví ČMZRB poskytuje služby těmto poskytovatelům služeb: - PIS (Payment Initiation Service resp. Služba iniciování platby), - AIS (Account Information Service resp. Služba informování o účtu), - CPS (Card-based Payment Service resp. Služba platby kartou). V aplikaci ernetového bankovnictví je možné pracovat jen a pouze s platebními účty klienta, které budou mít ve smluvní dokumentaci s ČMZRB potvrzen souhlas s tímto přístupem. 3 Aplikační programové rozhraní (API) Internetové bankovnictví ČMZRB poskytuje aplikační programové rozhraní (API) pomocí technologie webových služeb WCF (Windows Communication Foundation) založených na zasílání zpráv protokolu SOAP (Simple Object Access Protocol) 3.1 Služby 3.1.1 WKClientLogonService Služba poskytující metody pro identifikaci a ověření uživatele Služba poskytuje popis rozhraní pomocí WSDL. 3.1.2 WKClientService Služba poskytující metody pro získání informací o účtech a zpracování bankovních transakcí Služba poskytuje popis rozhraní pomocí WSDL. 3 z 26 Verze 1.0 ČMZRB, a.s.
3.1.3 Souhrn použití metod služeb Předpokladem pro použití metod popsaných v kapitole Metody služby API je úspěšná autentizace uživatele pomocí metod služby popsané v kapitole Identifikace a ověření uživatele a nastavení aktivního účtu pro další operace pomocí metody Výběr aktuálního účtu. 3.1.3.1 Metody pro všechny poskytovatele služeb Autentizace pomocí bezpečnostního tokenu Autentizace pomocí certifikátu Autentizace pomocí ověřovacího kódu SMS Výběr aktuálního účtu 3.1.3.2 Metody pro poskytovatele Služby informování o účtu Informace o účtu Dotaz na dostatek prostředků na účtu pro uskutečnění transakce Přehled příkazů k úhradě Přehled platebních příkazů do zahraničí Přehled pohybů na účtu Přehled zůstatků na účtu 3.1.3.3 Metody pro poskytovatele Služby platby kartou Dotaz na dostatek prostředků na účtu pro uskutečnění transakce 3.1.3.4 Metody pro poskytovatele Služby iniciování platby Zadání jednorázového příkazu k úhradě Autorizace příkazu k úhradě Zrušení příkazu k úhradě Zadání platebního příkazu do zahraničí Autorizace platebního příkazu do zahraničí Zrušení platebního příkazu do zahraničí 3.2 Bezpečnostní token Aplikace používá systém kryptograficky generovaných, časově omezených bezpečnostních tokenů (tiketů) platných vždy pro právě jednu následující operaci. Při volání metody je vždy 4 z 26 Verze 1.0 ČMZRB, a.s.
vrácen nový bezpečnostní token pro další volání webové služby. První bezpečnostní token je vrácen po prvotní úspěšné autentizaci uživatele. V případě použití neplatného tokenu je další volání následné operace znemožněno a je nutné provést opětovně autentizaci uživatele. Bezpečnostní token se předává aplikaci pomocí speciální SOAP hlavičky viz dále. 3.3 SOAP hlavička Každé volání webové metody služby musí obsahovat speciální SOAP hlavičku, do které je nutné vždy vložit, kromě dalších údajů, bezpečnostní token získaný během autentizace uživatele nebo z předchozího volání některé metody webové služby. Na základě ověření bezpečnostního tokenu (tiketu) je identifikován aktuální uživatel (účet) v jehož kontextu se provádí požadovaná operace AccessRoles Account ApplicationId BalanceView System.Globalization.CultureInfo Culture HasAccount HostAddress HostName System.Guid? IdsSessionId ThumbPr Otisk autentizačního certifikátu uživatele System.Globalization.CultureInfo UICulture byte [] UserIdentification VerificationTicket Bezpečnostní token (tiket) 3.4 Ošetření chyb V případě že při komunikaci klientské aplikace s webovou službou dojde k nějaké výjimce a požadavek není možné zpracovat, dojde je k výjimce vrácena informace ve formě SOAP Fault. SOAP Fault LoginFault Popis Výjimka vyvolaná v případě neúspěšné autentizace uživatele Třída obsahuje atribut Message, ve kterém je upřesnění chybného stavu: 5 z 26 Verze 1.0 ČMZRB, a.s.
SOAP Fault AuthorizationFault Popis Výjimka vyvolaná v případě, neúspěšné autorizace Třída obsahuje atribut Message, ve kterém je upřesnění chybného stavu: SecurityTicketFault Výjimka vyvolaná v případě neplatného bezpečnostního tokenu Třída obsahuje atribut Message, ve kterém je upřesnění chybného stavu: ServiceFault Výjimka vyvolaná z důvodu vzniku neočekávaného stavu aplikace Třída obsahuje atribut Message, ve kterém je upřesnění chybného stavu: ValidationFault Výjimka vyvolaná v případě chyby vzniklé v průběhu validace vstupních parametrů Třída obsahuje atribut Message, ve kterém je upřesnění chybného stavu: 3.5 Identifikace a ověření poskytovatele služby Podmínkou pro použití aplikačního programového rozhraní (API) pro komunikaci poskytovatele služby s ernetovým bankovnictvím ČMZRB je jednoznačná identifikace poskytovatele služby prostřednictvím klientského certifikátu vydaného na základě registrace poskytovatele služby. Vlastní komunikace s API probíhá výhradě pomocí zabezpečeného protokolu https. 6 z 26 Verze 1.0 ČMZRB, a.s.
3.6 Identifikace a ověření uživatele Podmínkou provádění aktivních i pasivních operací s účtem je úspěšná identifikace uživatele prostřednictvím bezpečnostních prvků dvou-faktorové autentizace. Aplikace využívá dva způsoby ověření identity uživatele. Buď pomocí klientského certifikátu nebo autentizační SMS zprávy. Identifikační prvky uživatele při přihlášení certifikátem: klientský certifikát vydaný schválenou certifikační autoritou (slouží k prokázání identity uživatele) bezpečnostní heslo Identifikační prvky uživatele při přihlášení pomocí SMS autentizace: identifikátor uživatele je bezvýznamový identifikátor jehož hodnota se nastavuje v procesu aktivace webového bankovnictví. bezpečnostní heslo autentizační SMS kód je kód, který je doručen uživateli na jeho mobilní telefon po ověření identifikátoru uživatele a bezpečnostního hesla. Aplikace rozlišuje mezi výchozím heslem (které klient obdržel během procesu aktivace webového bankovnictví) a běžným heslem nastaveným uživatelem. Výchozí heslo slouží pouze k prvotnímu přihlášení (během kterého je nezbytné si nastavit nové běžné heslo pro plnohodnotný přístup k účtu), nebo k odblokování účtu. Toto heslo není možné použít pro autentizaci uživatele při komunikace s webovou službou. 3.6.1 Autentizace 3.6.1.1 Použití metody služby Metody jsou nutné pro: poskytovatele Služby iniciování platby poskytovatele Služby informování o účtu poskytovatele Služby platby kartou 3.6.1.2 Autentizace pomocí bezpečnostního tokenu Uživatel pro přihlášení použije standardní přihlašovací formulář aplikace 7 z 26 Verze 1.0 ČMZRB, a.s.
Po úspěšném přihlášení je vrácen jednorázový bezpečnostní token pro další komunikaci s webovou službou ve formě cookie s názvem TOKEN, který se následně použije jako vstupní parametr pro metodu Login 3.6.1.2.1 Metoda Login( token); token 3.6.1.2.2 Parametry token Jednorázový bezpečnostní token [] 3.6.1.2.3 Návratové hodnoty Příznak úspěchu či neúspěchu operace 3.6.1.3 Autentizace pomocí certifikátu 3.6.1.3.1 Metoda Login(byte[] password, out isdefaultpassword); byte[] password 3.6.1.3.2 Parametry out isdefaultpassword byte[] password heslo uživatele out isdefaultpassword příznak zda bylo použito výchozí heslo [] 3.6.1.3.3 Návratové hodnoty 8 z 26 Verze 1.0 ČMZRB, a.s.
Příznak úspěchu či neúspěchu operace out isdefaultpassword příznak zda bylo použito výchozí heslo 3.6.1.4 Autentizace pomocí ověřovacího kódu SMS Před ověření uživatele 3.6.1.4.1 Metoda LoginByPassword (byte[] username, byte[] password, out isdefaultpassword) 3.6.1.4.2 Parametry byte[] username byte[] password out isdefaultpassword byte[] username Identifikátor uživatele byte[] password heslo uživatele out isdefaultpassword příznak zda bylo použito výchozí heslo [] 3.6.1.4.3 Návratové hodnoty Příznak úspěchu či neúspěchu operace out isdefaultpassword příznak zda bylo použito výchozí heslo Výsledkem úspěšného před ověření je získání bezpečnostního tokenu pro následné operace Zaslání ověřovacího kódu SMS 3.6.1.4.4 Metoda void SendAuthenticateSms(byte[] username) 3.6.1.4.5 Parametry byte[] username byte[] username Identifikátor uživatele void 3.6.1.4.6 Návratové hodnoty Ověření uživatele 9 z 26 Verze 1.0 ČMZRB, a.s.
3.6.1.4.7 Metoda LoginBySmsCode (byte[] username, smscode, isdefaultpassword) 3.6.1.4.8 Parametry byte[] username smscode isdefaultpassword byte[] username Identifikátor uživatele smscode Ověřovací kód SMS out isdefaultpassword příznak zda bylo použito výchozí heslo [] 3.6.1.4.9 Návratové hodnoty Příznak úspěchu či neúspěchu operace out isdefaultpassword příznak zda bylo použito výchozí heslo 3.6.2 Autorizace Všechny bankovní transakce podléhají autorizaci ze strany klienta. Autorizace probíhá pomocí sestavení a zaslání kryptograficky generovaného kódu na nastavený autorizační prostředek klienta (SMS terminál) a jeho následnému ověření před vlastním zpracováním požadované bankovní transakce. Klientská aplikace si vyžádá zaslání autorizačního kódu pro příslušnou bankovní transakci (Na nastavený autorizační prostředek klienta bude zaslán autorizační kód pro požadovanou transakci). Zaslaný autorizační kód je nutné následně předat do příslušné metody pro zpracování transakce. 3.6.2.1 Použití metod služby Metody jsou nutné pro: poskytovatele služby nepřímého dání platebního příkazu 3.6.2.2 Získání autorizačního kódu pro jednu transakci 3.6.2.2.1 Metoda void SendAuthorizationCode(AuthorizationOperation OperationId, System.Data.Objects.DataClasses.EntityObject entityitem) 3.6.2.2.2 Parametry AuthorizationOperation OperationId System.Data.Objects.DataClasses.EntityObject entityitem AuthorizationOperation OperationId Identifikátor operace 10 z 26 Verze 1.0 ČMZRB, a.s.
System.Data.Objects. entityitem DataClasses.EntityObject Entita s parametry jedné bankovní transakce typu TRAN_PRUH TRAN_PRUH_TRVALY TRAN_PRUH_ZAHR void 3.6.2.2.3 Návratové hodnoty 3.6.2.3 Získání autorizačního kódu pro více transakcí 3.6.2.3.1 Metoda void SendMultipleAuthorizationCode(AuthorizationOperation OperationId, System.Data.Objects.DataClasses.EntityObject[] entityitems) 3.6.2.3.2 Parametry AuthorizationOperation OperationId System.Data.Objects.DataClasses.EntityObject[] entityitems AuthorizationOperation OperationId Identifikátor operace System.Data.Objects. DataClasses.EntityObject[] entityitem Pole entit s parametry bankovních transakcí typu TRAN_PRUH TRAN_PRUH_TRVALY TRAN_PRUH_ZAHR void 3.6.2.3.3 Návratové hodnoty 3.7 Metody služby API 3.7.1 Výběr aktuálního účtu Metoda je nutná pro: poskytovatele Služby iniciování platby poskytovatele Služby informování o účtu poskytovatele Služby platby kartou Metoda pro výběr účtu, na kterém se budou provádět další operace pomocí ostatních metod služby. Aktivní účet se následně metodám předává pomocí SOAP hlavičky popsané v kapitole SOAP hlavička 3.7.1.1.1.1 Metoda 11 z 26 Verze 1.0 ČMZRB, a.s.
ZMOCOSO_UCET SetCurrentUserAccount( idzmocosoucet) 3.7.1.1.1 Parametry idzmocosoucet idzmocosoucet Identifikátor účtu zmocněné osoby 3.7.1.1.1.1 Návratové hodnoty ZMOCOSO_UCET ZMOCOSO_UCET Datová entita vybraného účtu 3.7.2 Příkaz k úhradě Příkaz k úhradě slouží k jednorázovému zaslání platby na účet příjemce, který je vedený v ČMZRB, a.s. nebo v ostatních bankách v České republice. 3.7.2.1 Zadání jednorázového příkazu k úhradě Zadání jednorázového tuzemského příkazu k úhradě s autorizací Metoda je vhodná pro poskytovatele služby nepřímého dání platebního příkazu 3.7.2.1.1.1 Metoda [] ProcessPaymentOrders( authorizationcode, AuthorizationOperation authorizationoperation, TRAN_PRUH[] paymentorders, DataObjectOperation dataobjectoperation) 3.7.2.1.1.2 Parametry authorizationcode AuthorizationOperation authorizationoperation TRAN_PRUH[] paymentorders DataObjectOperation dataobjectoperation authorizationcode Autorizační kód AuthorizationOperation authorizationoperation Typ autorizační operace AuthorizationOperation. AuthorizationSingle AuthorizationOperation. Authorization TRAN_PRUH[] paymentorders Datová struktura příkazu k úhradě DataObjectOperation dataobjectoperation Typ operace s datovým objektem DataObjectOperation.Insert 3.7.2.1.1.3 Návratové hodnoty [] 12 z 26 Verze 1.0 ČMZRB, a.s.
Pole řetězců k předání identifikátorů transakcí nově vytvořených záznamů zpět volajícímu klientovi [] Seznam identifikátorů transakcí 3.7.2.2 Autorizace příkazu k úhradě Metoda pro autorizaci příkazu k úhradě Metoda je vhodná pro poskytovatele služby nepřímého dání platebního příkazu 3.7.2.2.1.1 Metoda [] ProcessPaymentOrders( authorizationcode, AuthorizationOperation authorizationoperation, TRAN_PRUH[] paymentorders, DataObjectOperation dataobjectoperation) 3.7.2.2.1.2 Parametry authorizationcode AuthorizationOperation authorizationoperation TRAN_PRUH[] paymentorders DataObjectOperation dataobjectoperation authorizationcode Autorizační kód AuthorizationOperation authorizationoperation Typ autorizační operace AuthorizationOperation. AuthorizationSingle AuthorizationOperation. Authorization TRAN_PRUH[] paymentorders Datová struktura příkazu k úhradě DataObjectOperation dataobjectoperation Typ operace s datovým objektem DataObjectOperation.Insert 3.7.2.2.1.3 Návratové hodnoty [] Pole řetězců k předání identifikátorů transakcí nově vytvořených záznamů zpět volajícímu klientovi [] Seznam identifikátorů transakcí 3.7.2.3 Přehled příkazů k úhradě Metoda pro získání seznamu tuzemských příkazů k úhradě Metoda je vhodná pro: poskytovatele Služby iniciování platby 13 z 26 Verze 1.0 ČMZRB, a.s.
poskytovatele Služby informování o účtu 3.7.2.3.1.1 Metoda TRAN_PRUH[] GetPaymentOrders( from, count, sortexpression, XElement whereexpression) 3.7.2.3.1.2 Parametry from count sortexpression XElement whereexpression from Pořadové číslo počátečního záznamu count Počet záznamů sortexpression Třídící řetězec XElement whereexpression Filtrační podmínka typu Expression<Func<TRAN_PRUH, >> 3.7.2.3.1.3 Návratové hodnoty TRAN_PRUH[] TRAN_PRUH[] Pole příkazů k úhradě 3.7.2.4 Zrušení příkazu k úhradě Metoda pro zrušení zadaného příkazu k úhradě Metoda je vhodná pro: poskytovatele Služby iniciování platby 3.7.2.4.1.1 Metoda [] ProcessPaymentOrders( authorizationcode, AuthorizationOperation authorizationoperation, TRAN_PRUH[] paymentorders, DataObjectOperation dataobjectoperation) 3.7.2.4.1.2 Parametry authorizationcode AuthorizationOperation authorizationoperation TRAN_PRUH[] paymentorders DataObjectOperation dataobjectoperation authorizationcode Autorizační kód AuthorizationOperation authorizationoperation Typ autorizační operace AuthorizationOperation.Cancel TRAN_PRUH[] paymentorders Datová struktura příkazu k úhradě 14 z 26 Verze 1.0 ČMZRB, a.s.
DataObjectOperation dataobjectoperation Typ operace s datovým objektem DataObjectOperation.Update 3.7.2.4.1.3 Návratové hodnoty [] Pole řetězců k předání identifikátorů transakcí nově vytvořených záznamů zpět volajícímu klientovi [] Seznam identifikátorů transakcí 3.7.3 Zahraniční platba Platební příkaz do zahraničí slouží k jednorázovému zaslání platby na zahraniční na účet příjemce. 3.7.3.1 Zadání platebního příkazu do zahraničí Metoda pro zadání platebního příkazu do zahraničí s autorizací Metoda je vhodná pro: poskytovatele Služby iniciování platby 3.7.3.1.1.1 Metoda [] ProcessForeignOrders( authorizationcode, AuthorizationOperation authorizationoperation, TRAN_PRUH_ZAHR[] foreignorders, DataObjectOperation dataobjectoperation) 3.7.3.1.1.2 Parametry authorizationcode AuthorizationOperation authorizationoperation TRAN_PRUH_ZAHR[] foreignorders DataObjectOperation dataobjectoperation authorizationcode Autorizační kód AuthorizationOperation authorizationoperation Typ autorizační operace AuthorizationOperation. AuthorizationSingle TRAN_PRUH_ZAHR[] paymentorders Datová struktura trvalého příkazu k úhradě DataObjectOperation dataobjectoperation Typ operace s datovým objektem DataObjectOperation.Insert 3.7.3.1.1.3 Návratové hodnoty [] [] Seznam identifikátorů transakcí 15 z 26 Verze 1.0 ČMZRB, a.s.
3.7.3.2 Autorizace platebního příkazu do zahraničí Metoda pro autorizaci platebního příkazu do zahraničí Metoda je vhodná pro poskytovatele Služby iniciování platby 3.7.3.2.1.1 Metoda [] ProcessForeignOrders( authorizationcode, AuthorizationOperation authorizationoperation, TRAN_PRUH_ZAHR[] foreignorders, DataObjectOperation dataobjectoperation) 3.7.3.2.1.2 Parametry authorizationcode AuthorizationOperation authorizationoperation TRAN_PRUH_ZAHR[] foreignorders DataObjectOperation dataobjectoperation authorizationcode Autorizační kód AuthorizationOperation authorizationoperation Typ autorizační operace AuthorizationOperation. AuthorizationSingle TRAN_PRUH_ZAHR[] paymentorders Datová struktura trvalého příkazu k úhradě DataObjectOperation dataobjectoperation Typ operace s datovým objektem DataObjectOperation.Insert 3.7.3.2.1.3 Návratové hodnoty [] [] Seznam identifikátorů transakcí 3.7.3.3 Přehled platebních příkazů do zahraničí Metoda pro získání seznamu platebních příkazů do zahraničí Metoda je vhodná pro: poskytovatele Služby iniciování platby poskytovatele Služby informování o účtu 3.7.3.3.1.1 Metoda TRAN_PRUH_ZAHR[] GetForeignOrders( from, count, sortexpression, XElement whereexpression) 3.7.3.3.1.2 Parametry from count sortexpression 16 z 26 Verze 1.0 ČMZRB, a.s.
XElement whereexpression from Pořadové číslo počátečního záznamu count Počet záznamů sortexpression Třídící řetězec XElement whereexpression Filtrační podmínka typu Expression<Func< TRAN_PRUH_ZAHR, >> 3.7.3.3.1.3 Návratové hodnoty TRAN_PRUH_ZAHR[] TRAN_PRUH_ZAHR[] Pole trvalých příkazů k úhradě 3.7.3.4 Zrušení platebního příkazu do zahraničí Metoda pro zrušení zadaného platebního příkazu do zahraničí Metoda je vhodná pro: poskytovatele Služby iniciování platby 3.7.3.4.1.1 Metoda [] ProcessForeignOrders( authorizationcode, AuthorizationOperation authorizationoperation, TRAN_PRUH_ZAHR[] foreignorders, DataObjectOperation dataobjectoperation) 3.7.3.4.1.2 Parametry authorizationcode AuthorizationOperation authorizationoperation TRAN_PRUH_ZAHR[] foreignorders DataObjectOperation dataobjectoperation authorizationcode Autorizační kód AuthorizationOperation authorizationoperation Typ autorizační operace AuthorizationOperation.Cancel TRAN_PRUH_ZAHR[] paymentorders Datová struktura trvalého příkazu k úhradě DataObjectOperation dataobjectoperation Typ operace s datovým objektem DataObjectOperation.Update 3.7.3.4.1.3 Návratové hodnoty [] [] Seznam identifikátorů transakcí 17 z 26 Verze 1.0 ČMZRB, a.s.
3.7.4 Informace o účtu Metody pro získání informací o účtu a stavu transakcí 3.7.4.1 Informace o účtu Metoda pro získání obecných informací o účtu Metoda je vhodná pro: poskytovatele Služby informování o účtu 3.7.4.1.1.1 Metoda POHYBY_UCET_INFO GetClientAccountInformation() 3.7.4.1.1 Parametry 3.7.4.2 Dotaz na dostatek prostředků na účtu pro uskutečnění transakce Metoda pro ověření stavu prostředků na účtu Metoda služby je vhodná pro: poskytovatele Služby informování o účtu poskytovatele Služby platby kartou 3.7.4.2.1.1 Metoda IsPaymentAllowed (decimal amount) 3.7.4.2.1.2 Parametry decimal amount decimal amount Částka k ověření možnosti uskutečnění transakce 3.7.4.2.1.3 Návratové hodnoty Příznak povolení zákazu uskutečnění transakce True Ano False Ne 3.7.4.3 Přehled pohybů na účtu Metoda pro získání přehledu pohybů na účtu Metoda je vhodná pro: poskytovatele Služby informování o účtu 18 z 26 Verze 1.0 ČMZRB, a.s.
3.7.4.3.1.1 Metoda POHYBY_UCET_TRAN[] GetClientAccountTransactions( from, count, sortexpression, XElement whereexpression 3.7.4.3.1.2 Parametry from count sortexpression XElement whereexpression from Pořadové číslo počátečního záznamu count Počet záznamů sortexpression Třídící řetězec XElement whereexpression Filtrační podmínka typu Expression<Func< POHYBY_UCET_TRAN, >> 3.7.4.3.1.3 Návratové hodnoty POHYBY_UCET_TRAN[] POHYBY_UCET_ZUST[] Pole pohybů na účtu 3.7.4.4 Přehled zůstatků na účtu Metoda pro získání přehledu zůstatků na účtu Metoda je vhodná pro: poskytovatele Služby informování o účtu 3.7.4.4.1.1 Metoda POHYBY_UCET_ZUST[] GetClientAccountBalances( from, count, sortexpression, XElement whereexpression) 3.7.4.4.1.2 Parametry from count sortexpression XElement whereexpression from Pořadové číslo počátečního záznamu count Počet záznamů sortexpression Třídící řetězec 19 z 26 Verze 1.0 ČMZRB, a.s.
XElement whereexpression Filtrační podmínka typu Expression<Func< POHYBY_UCET_ZUST, >> 3.7.4.4.1.3 Návratové hodnoty POHYBY_UCET_TRAN[] POHYBY_UCET_ZUST[] Pole zůstatků na účtu 3.7.5 Datové typy (Entity) 3.7.5.1 Příkaz k úhradě TRAN_PRUH Entita pro Příkaz k úhradě AUTORIZACE [] AUTORIZACE Bool? AVIZO Decimal CASTKA System.DateTime? DATUM_AUT System.DateTime? DATUM_EDIT System.DateTime? DATUM_OVERENO System.DateTime? DATUM_SCHVALENI System.DateTime DATUM_SPLATNOSTI System.DateTime? DATUM_VER System.DateTime DATUM_VYHOTOVENI System.DateTime? DATUM_ZAPISU System.DateTime? DATUM_ZRUSENO ID_IDENTIFIKACE ID_PRUH ID_UCET KLIENT_UCET KLIENT_UCET KOD_MENY KOD_PLATBY KOD_PLATCE KOD_PRIJEMCE KON_SYMBOL POCET_AUTORIZACI POZNAMKA_PRIKAZCE SPE_SYMBOL STATUS_AVIZO STATUS_INTERNI System.DateTime? STATUS_INTERNI_DATUM TRAN_PRUH_SOIB TRAN_PRUH_SOIB Vždy NULL UCET_PLATCE UCET_PLATCE_PREDCISLI UCET_PRIJEMCE UCET_PRIJEMCE_PREDCISLI 20 z 26 Verze 1.0 ČMZRB, a.s.
VAR_SYMBOL VYHOTOVITEL ZAMITNUTO Int? ZAMITNUTO_AUT Int? ZAMITNUTO_VER ZAPSAL ZAPSAL_AUT ZAPSAL_OVERENO ZAPSAL_VER Int? ZDROJ_ID ZRUSIL SimpleOrder Příznak, že se jedná o zadání jednoho PÚ s autorizací MultipleOrders Příznak, že se jedná o hromadné zadání PÚ bez autorizací 3.7.5.2 Trvalý příkaz k úhradě TRAN_PRUH_TRVALY Entita pro Trvalý příkaz k úhradě APPROVED AUTORIZACE [] AUTORIZACE decimal CASTKA_POSLEDNI decimal CASTKA_PRAVIDELNA decimal CASTKA_PRVNI CETNOST CETNOST_CTVRTLETI CETNOST_DEN System.DateTime? DATUM_AUT System.DateTime? DATUM_EDIT System.DateTime? DATUM_OVERENO System.DateTime? DATUM_PLATBY System.DateTime? DATUM_POSLEDNI_PLATBY System.DateTime? DATUM_SCHVALENI System.DateTime? DATUM_UKONCENO System.DateTime? DATUM_VER System.DateTime DATUM_VYHOTOVENI System.DateTime? DATUM_ZAPISU System.DateTime? DATUM_ZRUSENO ID_IDENTIFIKACE ID_TRV_PRUH ID_UCET KLIENT_UCET KLIENT_UCET KOD_MENY KOD_PLATCE KOD_PRIJEMCE KON_SYMBOL? LAST_DATE_MONTH_INPUT? LAST_DATE_YEAR_INPUT System.DateTime? MATURITY_DATE long NEXT_SEND_DATE POCET_AUTORIZACI 21 z 26 Verze 1.0 ČMZRB, a.s.
REF_ID REGULAR_PAYMENT_DAY_I NPUT SENDED SPE_SYMBOL System.DateTime START_DATE START_DATE_MONTH_INPUT START_DATE_YEAR_INPUT TRAN_PRUH_TRVALY_ TRAN_PRUH_TRVALY_SOIB Vždy NULL SOIB UCET_PLATCE UCET_PLATCE_PREDCISLI UCET_PRIJEMCE UCET_PRIJEMCE_PREDCISLI UKONCIL VAR_SYMBOL VYHOTOVITEL Bool ZAMITNUTO? ZAMITNUTO_AUT? ZAMITNUTO_VER ZAPSAL ZAPSAL_AUT ZAPSAL_OVERENO ZAPSAL_VER? ZDROJ_ID ZPRAVA_PRO_KLIENTA ZRUSIL Bool SimpleOrder Příznak, že se jedná o zadání jednoho PÚ s autorizací Bool MultipleOrders Příznak, že se jedná o hromadné zadání PÚ bez autorizací 3.7.5.3 Zahraniční platba TRAN_PRUH_ZAHR Entita pro Zahraniční platbu AUTORIZACE [] AUTORIZACE decimal CASTKA System.DateTime? DATUM_AUT System.DateTime? DATUM_EDIT System.DateTime? DATUM_OVERENO System.DateTime? DATUM_SCHVALENI System.DateTime DATUM_SPLATNOSTI System.DateTime? DATUM_VER System.DateTime DATUM_VYHOTOVENI System.DateTime? DATUM_ZAPISU System.DateTime? DATUM_ZRUSENO ID_IDENTIFIKACE Int ID_UCET Int ID_ZAHR_PRUH KLIENT_UCET KLIENT_UCET 22 z 26 Verze 1.0 ČMZRB, a.s.
KOD_MENY KOD_PLATCE KOD_ZEME_BANKA KOD_ZEME_PRIJEMCE MESTO_BANKA MESTO_PRIJEMCE NAZEV1_PRIJEMCE NAZEV2_PRIJEMCE NAZEV_BANKA_PRIJEMCE PLATEBNI_TITUL Int POCET_AUTORIZACI POPIS_TRANSAKCE POPLATKY STATUS_INTERNI System.DateTime? STATUS_INTERNI_DATUM SWIFT_KOD TRAN_PRUH_ZAHR_SOIB TRAN_PRUH_ZAHR_SOIB Vždy NULL? TYP_PLATBA UCEL_UHRADY UCET_MENA UCET_PLATCE UCET_PLATCE_PREDCISLI UCET_PRIJEMCE ULICE_BANKA ULICE_PRIJEMCE VYHOTOVITEL Bool ZAMITNUTO? ZAMITNUTO_AUT? ZAMITNUTO_VER ZAPSAL ZAPSAL_AUT ZAPSAL_OVERENO ZAPSAL_VER? ZDROJ_ID ZRUSIL Bool SimpleOrder Příznak, že se jedná o zadání jednoho PÚ s autorizací More Bool MultipleOrders Příznak, že se jedná o hromadné zadání PÚ bez autorizací 3.7.5.4 Autorizace AUTORIZACE Entita pro Autorizace bankovní transakce AUTORIZ_OPERACE AUTORIZ_OPERACE CIS_AUTORIZACE CIS_AUTORIZACE System.DateTime DATUM ID_AUTORIZ_OPERACE ID_CIS_AUTORIZACE? ID_TRAN_PRUH? ID_TRAN_PRUH_TRVALY 23 z 26 Verze 1.0 ČMZRB, a.s.
? ID_TRAN_PRUH_ZAHR Id REPLIKOVAT TRAN_PRUH TRAN_PRUH TRAN_PRUH_TRVALY TRAN_PRUH_TRVALY TRAN_PRUH_ZAHR TRAN_PRUH_ZAHR ZAMITNUTO ZAPSAL 3.7.5.5 Klient Účet KLIENT_UCET Entita pro Účet klienta System.DateTime? DATUM_REGISTRACE System.DateTime? DATUM_ZRUSENI ID_KLIENT ID_UCET KLIENT KLIENT KOD_MENY? PORADI TRAN_BUVY [] TRAN_BUVY TRAN_KREDOCEK [] TRAN_KREDOCEK TRAN_PRUH [] TRAN_PRUH TRAN_PRUH_TRVALY [] TRAN_PRUH_TRVALY TRAN_PRUH_ZAHR [] TRAN_PRUH_ZAHR UCET UCET_PREDCISLI ZMOCOSO_UCET [] ZMOCOSO_UCET ZPRAVA_ADRESAT [] ZPRAVA_ADRESAT ZPRAVA_PRECTENO [] ZPRAVA_PRECTENO 3.7.5.6 Účet umocněné osoby ZMOCOSO_UCET Entita pro Účet zmocněné osoby FORMAT_DAVKA ID ID_UCET ID_ZMOCOSO KLIENT_UCET KLIENT_UCET decimal? LIMIT_PRUH decimal? LIMIT_PRUH_SMS decimal? LIMIT_TRVAL decimal? LIMIT_TRVAL_SMS decimal? LIMIT_ZAHR decimal? LIMIT_ZAHR_SMS decimal? OSO_ODCHOZI_LIMIT_EMAIL 24 z 26 Verze 1.0 ČMZRB, a.s.
decimal? OSO_ODCHOZI_LIMIT_SMS OSO_ODCHOZI_PLATBY decimal? OSO_PRICHOZI_LIMIT_EMAIL decimal? OSO_PRICHOZI_LIMIT_SMS OSO_PRICHOZI_PLATBY OSO_ZOBRAZIT_ZUSTATEK short? OVERENI_PRUH short? OVERENI_PRUH_SMS short? OVERENI_TRV_PRUH short? OVERENI_TRV_PRUH_SMS short? OVERENI_ZAHR_PRUH short? OVERENI_ZAHR_PRUH_SMS? PRISTUP? PRISTUP_SMS SABLONA_TRAN_PRUH SABLONA_TRAN_PRUH [] ZMOCOSO ZMOCOSO OSO_ODCHOZI_SMS OSO_ODCHOZI_EMAIL OSO_ODCHOZI_NONE OSO_PRICHOZI_SMS OSO_PRICHOZI_EMAIL OSO_PRICHOZI_NONE OSO_ZUSTATEK_SKRYT OSO_ZUSTATEK_ON_HOVER OSO_ZUSTATEK_ZOBRAZIT SMS_TERMINAL NASTAVIT_OSTATNI_UCTY 3.7.5.7 Pohyby na účtu POHYBY_UCET_TRAN Entita pro Pohyby na účtu Decimal CASTKA CISLO_UCTU CISLO_UCTU_PROTIST System.DateTime DAT_ZAPIS System.DateTime? DAT_ZRUSENO DEBET_KREDIT System.DateTime? EOD ID ID_IDENTIFIKACE KOD_BANKY_PROSTISTR KS POPIS Int POR_CISLO_TRAN PREDCISLI_UCTU PREDCISLI_UCTU_PROSTISTR REVERZNI_TRAN SS TRANSAKCE 25 z 26 Verze 1.0 ČMZRB, a.s.
TRAN_KOD System.DateTime VALUTA VS 3.7.5.8 Zůstatky POHYBY_UCET_ZUST Entita pro Zůstatky na účtech CISLO_UCTU System.DateTime DATUM decimal KON_ZUSTATEK decimal POC_ZUSTATEK 3.7.6 Výčtové typy 3.7.6.1 Typ autorizační operace AuthorizationOperation Výčet typů autorizačních operací transakcí Hodnota Cancel Authorization AuthorizationSingle Decline End LogIn CancelSingle Popis Zrušení/stornování Autorizace (vice transakcí) Autorizace jednoho záznamu (transakce) Zamítnutí Ukončení (trvalého příkazu) Přihlášení uživatele Zrušení/stornování jednoho záznamu 3.7.6.2 Typ operace s datovým objektem DataObjectOperation Výčet typů operací s datovým objektem Hodnota Insert Update Delete Popis Vložení Aktualizace Odstranění 26 z 26 Verze 1.0 ČMZRB, a.s.