Platby
Tato kapitola popisuje konfiguraci platebních metod, kterými lze uhradit objednávky.
Příklad konfigurace
<order> <payment> <availablePayments> <cash/> <cashOnDelivery/> <transfer/> <invoice/> <proformaInvoice/> <payU> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </payU> <gpWebPay> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </gpWebPay> <csob> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </csob> <goPay> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </goPay> <comgate> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </comgate> <essox> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </essox> <pays> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </pays> <stripe> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </stripe> <twisto> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </twisto> </availablePayments> <catalogSpecific> <catalogCode/> <availablePayments> <cash/> <cashOnDelivery/> <transfer/> <invoice/> <proformaInvoice/> <payU> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </payU> <gpWebPay> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </gpWebPay> <csob> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </csob> <goPay> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </goPay> <comgate> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </comgate> <essox> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </essox> <pays> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </pays> <stripe> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </stripe> <twisto> <payGates> <payGate> <configCode/> <confirmPaymentOnOrderState/> <refundPaymentOnOrderCancel/> <treatAuthorizedAsPaid/> </payGate> </payGates> </twisto> </availablePayments> </catalogSpecific> </payment></order>
Popis
order/payment
Konfigurace platebních metod objednávky.
Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| availablePayments | Seznam typů platebních metod, které lze vytvořit v AR a poté použít k uhrazení objednávky. | List: availablePayments |
|
|
| catalogSpecific | Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde. |
|
|
availablePayments
Seznam typů platebních metod, které lze vytvořit v AR a poté použít k uhrazení objednávky.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| cash | Platba hotově předem. | String |
|
|
| cashOnDelivery | Platba při převzetí (dobírka). | String |
|
|
| transfer | Platba předem bankovním převodem. Pro tento typ platby lze definovat bankovní účty, kam lze uhradit objednávku. | String |
|
|
| invoice | Platba na fakturu se splatností. Zboží se odesílá před uhrazením. | String |
|
|
| proformaInvoice | Platba zálohovou fakturou. Tento typ platby vyžaduje zálohovou fakturu, která se v rámci notifikace posílá zákazníkovi. Zboží se odesílá až po zaplacení. | String |
|
|
| payU | Platební brána PayU. Tato platební metoda vyžaduje zapnutý modul PayU platební brány. |
|
| |
| gpWebPay | Platební brána GpWebPay. Tato platební metoda vyžaduje zapnutý modul GpWebPay platební brány. |
|
| |
| csob | ČSOB Platební brána. Tato platební metoda vyžaduje zapnutý modul ČSOB platební brány. |
|
| |
| goPay | GoPay platební brána. Tato platební metoda vyžaduje zapnutý modul GoPay platební brány. |
|
| |
| comgate | ComGate platební brána. Tato platební metoda vyžaduje zapnutý modul ComGate platební brány. |
|
| |
| essox | Platba ESSOX. Tato platební metoda vyžaduje zapnutý modul Essox platební brány. |
|
| |
| pays | Pays platební brána. Tato platební metoda vyžaduje zapnutý modul Pays platební brány. |
|
| |
| stripe | Stripe platební brána. Tato platební metoda vyžaduje zapnutý modul Stripe platební brány. |
|
| |
| twisto | Twisto platební brána. Tato platební metoda vyžaduje zapnutý modul Twisto platební brány. |
|
|
payU
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
gpWebPay
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
csob
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
goPay
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
comgate
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
essox
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
pays
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
stripe
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
twisto
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| payGates/payGate | Seznam povolených platebních bran. Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody. Platební brány se definují v rámci modulu platebních bran. Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný | List: payGates/payGate |
|
|
payGates/payGate
Seznam povolených platebních bran.
Tato hodnota je nepovinná pokud existuje pouze jedna platební brána pro daný typ platební metody.
Platební brány se definují v rámci modulu platebních bran.
Pozn.: Jedna brána může být použita pouze pro jeden katalog. Tedy není možné použít stejnou platební bránu (přesněji stejný configCode) pro dva různé katalogy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| configCode | Unikátní kód konfigurace konkrétní platební brány definované v rámci | String |
|
|
| confirmPaymentOnOrderState | Určuje při jakém stavu objednávky se má při pouhé předautorizaci platby vyvolat potvrzení platby na platební bráně. Výchozí hodnota je "none", tedy, že se potvrzení neprovede nikdy. Jinak lze použít stavy z com.fg.cps.eshop.order.dto.EshopOrderCommonState. | String |
|
|
| refundPaymentOnOrderCancel | Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně. | boolean |
|
|
| treatAuthorizedAsPaid | Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená. | boolean |
|
|
