Platby

Platby

Tato kapitola popisuje konfiguraci platebních metod, kterými lze uhradit objednávky.

Zkopírovat odkaz na sekciPříklad konfigurace

xml
1 <order>2    <payment>3        <availablePayments>4            <cash/>5            <cashOnDelivery/>6            <transfer/>7            <invoice/>8            <proformaInvoice/>9            <payU>10                <payGates>11                    <payGate>12                        <configCode/>13                        <confirmPaymentOnOrderState/>14                        <refundPaymentOnOrderCancel/>15                        <treatAuthorizedAsPaid/>16                    </payGate>17                </payGates>18            </payU>19            <gpWebPay>20                <payGates>21                    <payGate>22                        <configCode/>23                        <confirmPaymentOnOrderState/>24                        <refundPaymentOnOrderCancel/>25                        <treatAuthorizedAsPaid/>26                    </payGate>27                </payGates>28            </gpWebPay>29            <csob>30                <payGates>31                    <payGate>32                        <configCode/>33                        <confirmPaymentOnOrderState/>34                        <refundPaymentOnOrderCancel/>35                        <treatAuthorizedAsPaid/>36                    </payGate>37                </payGates>38            </csob>39            <goPay>40                <payGates>41                    <payGate>42                        <configCode/>43                        <confirmPaymentOnOrderState/>44                        <refundPaymentOnOrderCancel/>45                        <treatAuthorizedAsPaid/>46                    </payGate>47                </payGates>48            </goPay>49            <comgate>50                <payGates>51                    <payGate>52                        <configCode/>53                        <confirmPaymentOnOrderState/>54                        <refundPaymentOnOrderCancel/>55                        <treatAuthorizedAsPaid/>56                    </payGate>57                </payGates>58            </comgate>59            <essox>60                <payGates>61                    <payGate>62                        <configCode/>63                        <confirmPaymentOnOrderState/>64                        <refundPaymentOnOrderCancel/>65                        <treatAuthorizedAsPaid/>66                    </payGate>67                </payGates>68            </essox>69            <pays>70                <payGates>71                    <payGate>72                        <configCode/>73                        <confirmPaymentOnOrderState/>74                        <refundPaymentOnOrderCancel/>75                        <treatAuthorizedAsPaid/>76                    </payGate>77                </payGates>78            </pays>79            <stripe>80                <payGates>81                    <payGate>82                        <configCode/>83                        <confirmPaymentOnOrderState/>84                        <refundPaymentOnOrderCancel/>85                        <treatAuthorizedAsPaid/>86                    </payGate>87                </payGates>88            </stripe>89            <twisto>90                <payGates>91                    <payGate>92                        <configCode/>93                        <confirmPaymentOnOrderState/>94                        <refundPaymentOnOrderCancel/>95                        <treatAuthorizedAsPaid/>96                    </payGate>97                </payGates>98            </twisto>99        </availablePayments>100        <catalogSpecific>101            <catalogCode/>102            <availablePayments>103                <cash/>104                <cashOnDelivery/>105                <transfer/>106                <invoice/>107                <proformaInvoice/>108                <payU>109                    <payGates>110                        <payGate>111                            <configCode/>112                            <confirmPaymentOnOrderState/>113                            <refundPaymentOnOrderCancel/>114                            <treatAuthorizedAsPaid/>115                        </payGate>116                    </payGates>117                </payU>118                <gpWebPay>119                    <payGates>120                        <payGate>121                            <configCode/>122                            <confirmPaymentOnOrderState/>123                            <refundPaymentOnOrderCancel/>124                            <treatAuthorizedAsPaid/>125                        </payGate>126                    </payGates>127                </gpWebPay>128                <csob>129                    <payGates>130                        <payGate>131                            <configCode/>132                            <confirmPaymentOnOrderState/>133                            <refundPaymentOnOrderCancel/>134                            <treatAuthorizedAsPaid/>135                        </payGate>136                    </payGates>137                </csob>138                <goPay>139                    <payGates>140                        <payGate>141                            <configCode/>142                            <confirmPaymentOnOrderState/>143                            <refundPaymentOnOrderCancel/>144                            <treatAuthorizedAsPaid/>145                        </payGate>146                    </payGates>147                </goPay>148                <comgate>149                    <payGates>150                        <payGate>151                            <configCode/>152                            <confirmPaymentOnOrderState/>153                            <refundPaymentOnOrderCancel/>154                            <treatAuthorizedAsPaid/>155                        </payGate>156                    </payGates>157                </comgate>158                <essox>159                    <payGates>160                        <payGate>161                            <configCode/>162                            <confirmPaymentOnOrderState/>163                            <refundPaymentOnOrderCancel/>164                            <treatAuthorizedAsPaid/>165                        </payGate>166                    </payGates>167                </essox>168                <pays>169                    <payGates>170                        <payGate>171                            <configCode/>172                            <confirmPaymentOnOrderState/>173                            <refundPaymentOnOrderCancel/>174                            <treatAuthorizedAsPaid/>175                        </payGate>176                    </payGates>177                </pays>178                <stripe>179                    <payGates>180                        <payGate>181                            <configCode/>182                            <confirmPaymentOnOrderState/>183                            <refundPaymentOnOrderCancel/>184                            <treatAuthorizedAsPaid/>185                        </payGate>186                    </payGates>187                </stripe>188                <twisto>189                    <payGates>190                        <payGate>191                            <configCode/>192                            <confirmPaymentOnOrderState/>193                            <refundPaymentOnOrderCancel/>194                            <treatAuthorizedAsPaid/>195                        </payGate>196                    </payGates>197                </twisto>198            </availablePayments>199        </catalogSpecific>200    </payment>201</order>

Zkopírovat odkaz na sekciPopis

Zkopírovat odkaz na sekciorder/payment

Konfigurace platebních metod objednávky.

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinná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.

-

-

Zkopírovat odkaz na sekciavailablePayments

Seznam typů platebních metod, které lze vytvořit v AR a poté použít k uhrazení objednávky.

VlastnostPopisHodnotaPovinná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.

payU

-

-

gpWebPay

Platební brána GpWebPay.

Tato platební metoda vyžaduje zapnutý modul GpWebPay platební brány.

gpWebPay

-

-

csob

ČSOB Platební brána.

Tato platební metoda vyžaduje zapnutý modul ČSOB platební brány.

csob

-

-

goPay

GoPay platební brána.

Tato platební metoda vyžaduje zapnutý modul GoPay platební brány.

goPay

-

-

comgate

ComGate platební brána.

Tato platební metoda vyžaduje zapnutý modul ComGate platební brány.

comgate

-

-

essox

Platba ESSOX.

Tato platební metoda vyžaduje zapnutý modul Essox platební brány.

essox

-

-

pays

Pays platební brána.

Tato platební metoda vyžaduje zapnutý modul Pays platební brány.

pays

-

-

stripe

Stripe platební brána.

Tato platební metoda vyžaduje zapnutý modul Stripe platební brány.

stripe

-

-

twisto

Twisto platební brána.

Tato platební metoda vyžaduje zapnutý modul Twisto platební brány.

twisto

-

-

Zkopírovat odkaz na sekcipayU

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcigpWebPay

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcicsob

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcigoPay

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcicomgate

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekciessox

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcipays

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcistripe

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false

Zkopírovat odkaz na sekcitwisto

VlastnostPopisHodnotaPovinná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ý configCode) pro dva různé katalogy.

List: payGates/payGate

-

-

Zkopírovat odkaz na sekcipayGates/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.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
configCode

Unikátní kód konfigurace konkrétní platební brány definované v rámci PayGateModule.

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 .

String

-

none

refundPaymentOnOrderCancel

Určuje jestli má zrušení objednávky automaticky refundovat zaplacenou částku na platební bráně.

boolean

-

true

treatAuthorizedAsPaid

Určuje jestli se má autorizace platby zapsat do objednávky jako zaplacená.

boolean

-

false