A payment order can be created via the REST API in the standard way, using an HTTP operation PUT or POST on the /c/{firma}/prikaz-k-uhrade record.

Creating an order

Example of creating an order in XML format — the first item is entered manually (account number, amount, sort code), the second one pays a specific document:

<?xml version="1.0"?>
<winstrom version="1.0">
  <!-- Příkazy k úhradě -->
  <prikaz-k-uhrade>
    <banka>code:BANKOVNÍ ÚČET</banka>
    <polozky>
      <!-- Položky -->
      <prikaz-k-uhrade-polozka>
        <buc>123456</buc>
        <castka>1200.0</castka>
        <smerKod>code:0100</smerKod>
      </prikaz-k-uhrade-polozka>
      <!-- Položka uhrazující zadaný doklad -->
      <prikaz-k-uhrade-polozka>
        <doklFak>code:PF1478/2020</doklFak>
      </prikaz-k-uhrade-polozka>
    </polozky>
  </prikaz-k-uhrade>
</winstrom>

ℹ️ A list of all header and item attributes can be found in the prikaz-k-uhrade and prikaz-k-uhrade-polozka records. Only documents signed for payment can be included in the order, if the company has this setting enabled — see Payment Signature via REST API.

Advanced operations

Method	URL	Description
`GET`	`/c/{firma}/prikaz-k-uhrade/{id}/stazeni` optionally `?dat-splat-z-hlavicky=true\|false`	Retrieves a file with an electronic description of the payment order, suitable for sending to the bank. The `dat-splat-z-hlavicky` parameter can be used to affect the due date option setting from the order header.
`GET`	`/c/{firma}/prikaz-k-uhrade/{id}/odeslani-fio` optionally `?dat-splat-z-hlavicky=true\|false`	Performs an online submission of the payment order — Fio Bank with online connection only. The `dat-splat-z-hlavicky` parameter can be used to affect the due date option setting from the order header.
`PUT` / `POST`	`/c/{firma}/prikaz-k-uhrade/{id}/zrusit-odeslani`	Cancels the order's submission status.

Payment Order

Creating an order

Advanced operations

Related