Generování platebních příkazů v QR kódu do obrázku nebo PDF souboru

Generování platebních příkazů do obrázku

Webová služba GenerateCBA_QR_ToImage umožňuje generování QR čárových kódů obsahujících data pro platební příkaz do obrázku nebo PDF souboru. Tyto QR kódy splňují standard ČBA pro sdílení údajů v rámci tuzemského platebního styku. Jako vstupní data metody jsou použité údaje o platebním příkazu, ze kterého pak webová služba vygeneruje QR kód a postará se o správné formátování.

Popis služby GenerateCBA_QR_ToImage včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je umístěn na http://localhost/ltd/ltd.asmx?op=GenerateCBA_QR_ToImage.

Parametr "localhost" je název používaný pro lokální počítač; namísto něj zapište jméno/IP adresu LTD serveru (dle nastavení v IIS).

Požadavek

POST /ltd/ltd.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/longtermdocs/GenerateCBA_QR_ToImage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GenerateCBA_QR_ToImage xmlns="http://software602.com/longtermdocs/">
      <Flags>string</Flags>
      <Data>
        <account_num>string</account_num>
        <recipient_msg>string</recipient_msg>
        <recipient_name>string</recipient_name>
        <amount>string</amount>
        <currency>string</currency>
        <date>string</date>
        <alternate_account_num>string</alternate_account_num>
        <reference>string</reference>
        <sender_name>string</sender_name>
        <payment_type>string</payment_type>
        <notification_type>string</notification_type>
        <notification_data>string</notification_data>
        <crc_32>string</crc_32>
        <X_Repeat_Period>string</X_Repeat_Period>
        <X_Var_Symbol>string</X_Var_Symbol>
        <X_Specific_Symbol>string</X_Specific_Symbol>
        <X_Constant_Symbol>string</X_Constant_Symbol>
        <X_Payment_ID>string</X_Payment_ID>
        <X_URL>string</X_URL>
      </Data>
    </GenerateCBA_QR_ToImage>
  </soap:Body>
</soap:Envelope>

<Flags>
[nepovinný element]

Vstup Popis

String

Dodatečná nastavení. V případě QR kódu možno nastavit kódování ("numeric","alphanumeric","byte" nebo "binary","kanji") a chybovou korekci ("l","m","q","h").

Parametry se oddělují ";", formátují se ve tvaru "encoding=[hodnota]" a "correction=[hodnota].

<Data>
[povinný element]

Vstup Popis

Struct

Struktura reprezentující údaje pro elektronickou platbu přes QR kód.

account_num je povinný parametr.
Název Popis

account_num

číslo účtu

recipient_msg

zpráva pro příjemce

recipient_name

jméno příjemce

amount

částka na zaplacení

currency

měna platby

date

datum splatnosti

alternate_account_num

alternativní číslo účtu

reference

referenční číslo

sender_name

jméno plátce

payment_type

typ platby

notification_type

typ notifikace (E=Email, P=Phone)

notification_data

data notifikace

crc_32

CRC32 součet

X_Repeat_Period

datum opakování platby

X_Var_Symbol

variabilní symbol

X_Specific_Symbol

specifický symbol

X_Constant_Symbol

konstantní symbol

X_Payment_ID

ID platby

X_URL

URL k platbě

Odpověď

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GenerateCBA_QR_ToImageResponse xmlns="http://software602.com/longtermdocs/">
      <GenerateCBA_QR_ToImageResult>int</GenerateCBA_QR_ToImageResult>
      <OutputImage>base64Binary</OutputImage>
      <ErrorMessage>string</ErrorMessage>
    </GenerateCBA_QR_ToImageResponse>
  </soap:Body>
</soap:Envelope>

<GenerateCBA_QR_ToImageResult>

Návratová hodnota Popis

Int

Číselná reprezentace výsledku metody GenerateCBA_QR_ToImage.

0 = v pořádku. Jinak viz kapitola Návratové kódy.

<OutputImage>

Návratová hodnota Popis

Base64Binary

Base64Binary Data výstupního obrázku ve formátu PNG v kódování.

<ErrorMessage>

Návratová hodnota Popis

String

Když nastane chyba při generování, obsahuje podrobnější údaje o chybě.

Generování platebních příkazů do PDF souboru

Popis služby GenerateCBA_QR_ToPDF včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je umístěn na http://localhost/ltd/ltd.asmx?op=GenerateCBA_QR_ToPDF.

Parametr "localhost" je název používaný pro lokální počítač; namísto něj zapište jméno/IP adresu LTD serveru (dle nastavení v IIS).

Požadavek

POST /ltd/ltd.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/longtermdocs/GenerateCBA_QR_ToPDF"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GenerateCBA_QR_ToPDF xmlns="http://software602.com/longtermdocs/">
      <InputPDF>base64Binary</InputPDF>
      <Page>int</Page>
      <coords>
        <bottom_left_x>int</bottom_left_x>
        <top_right_x>int</top_right_x>
        <bottom_left_y>int</bottom_left_y>
        <top_right_y>int</top_right_y>
      </coords>
      <Flags>string</Flags>
      <Data>
        <account_num>string</account_num>
        <recipient_msg>string</recipient_msg>
        <recipient_name>string</recipient_name>
        <amount>string</amount>
        <currency>string</currency>
        <date>string</date>
        <alternate_account_num>string</alternate_account_num>
        <reference>string</reference>
        <sender_name>string</sender_name>
        <payment_type>string</payment_type>
        <notification_type>string</notification_type>
        <notification_data>string</notification_data>
        <crc_32>string</crc_32>
        <X_Repeat_Period>string</X_Repeat_Period>
        <X_Var_Symbol>string</X_Var_Symbol>
        <X_Specific_Symbol>string</X_Specific_Symbol>
        <X_Constant_Symbol>string</X_Constant_Symbol>
        <X_Payment_ID>string</X_Payment_ID>
        <X_URL>string</X_URL>
      </Data>
    </GenerateCBA_QR_ToPDF>
  </soap:Body>
</soap:Envelope>

<InputPDF>
[povinný element]

Vstup Popis

Base64Binary

Data vstupního PDF souboru v kódování Base64Binary.

<Page>
[nepovinný element]

Vstup Popis

Int

Číslo stránky, na kterou se má vložit QR kód.

<Coords>
[povinný element]

Vstup Popis

Int[]

Pole obsahující X a Y souřadnice na které se má vykreslit QR kód. Souřadnice se zapisují ve tvaru:

* bottom_left_x – levý spodní roh čtverce na X souřadnici.

* top_right_x – pravý vrchní roh čtverce na X souřadnici.

* bottom_left_y – levý spodní roh čtverce na Y souřadnici.

* top_right_y – pravý vrchní roh čtverce na Y souřadnici.

<Flags>
[nepovinný element]

Vstup Popis

String

Dodatečná nastavení. Možno nastavit ignorování minimální velikosti QR kódu (ignoresize), kódování ("numeric","alphanumeric","byte" nebo "binary","kanji") a chybovou korekci ("l","m","q","h").

Parametry se oddělují ";", formátují se ve tvaru "encoding=[hodnota]" a "correction=[hodnota].

<Data>
[povinný element]

Vstup Popis

Struct

Struktura reprezentující údaje pro elektronickou platbu přes QR kód.

account_num je povinný parametr:
Název Popis

account_num

číslo účtu

recipient_msg

zpráva pro příjemce

recipient_name

jméno příjemce

amount

částka na zaplacení

currency

měna platby

date

datum splatnosti

alternate_account_num

alternativní číslo účtu

reference

referenční číslo

sender_name

jméno plátce

payment_type

typ platby

notification_type

typ notifikace (E=Email, P=Phone)

notification_data

data notifikace

crc_32

CRC32 součet

X_Repeat_Period

datum opakování platby

X_Var_Symbol

variabilní symbol

X_Specific_Symbol

specifický symbol

X_Constant_Symbol

konstantní symbol

X_Payment_ID

ID platby

X_URL

URL k platbě

Odpověď

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GenerateCBA_QR_ToPDFResponse xmlns="http://software602.com/longtermdocs/">
      <GenerateCBA_QR_ToPDFResult>int</GenerateCBA_QR_ToPDFResult>
      <OutputPDF>base64Binary</OutputPDF>
      <ErrorMessage>string</ErrorMessage>
    </GenerateCBA_QR_ToPDFResponse>
  </soap:Body>
</soap:Envelope>

<GenerateCBA_QR_ToPDFResult>

Návratová hodnota Popis

Int

Číselná reprezentace výsledku metody GenerateCBA_QR_ToPDF. 0 = v pořádku.

Jinak viz kapitola Návratové kódy.

<OutputPDF>

Návratová hodnota Popis

Base64Binary

Data výstupního PDF souboru v kódování Base64Binary.

<ErrorMessage>

Návratová hodnota Popis

String

Když nastane chyba při generování, obsahuje podrobnější údaje o chybě.