Číselníky
Stavy platby
Seznam dostupných stavů platby
paymentState | Enumeration: |
|
|---|---|---|
string | CANCELED | Je plně stornována plátcem nebo obchodníkem. Koncový stav. |
DECLINED | Zamítnuta, plátci nebylo nic strženo. Koncový stav. | |
EXPIRED | Expirovala, plátci nebylo nic strženo. Koncový stav. | |
IN_PROGRESS_UNPAID | Brána má všechny potřebné informace a platbu procesuje. | |
PAID | Zaplacena. | |
PENDING_INFO | Založena, čeká na doplnění chybějích informací plátcem. |
Kategorie produktu
Seznam dostupných produktových kategorií
productCode | Enumeration: |
|
|---|---|---|
string | FOOD | RFU - Jídlo a nealkoholické nápoje. Zatím nepoužívejte. |
LEISURE | Cestování, turistika, kultura, sport, tištěné knihy, vzdělávání. Tento kód prosím použijte i pro zdraví na Slovensku (viz níže). | |
| HEALTH | Zboží nebo služby zdravotního, léčebného, hygienického a obdobného charakteru od zdravotnických zařízení nebo pořízení zdravotnických prostředků na lékařský předpis ( - od API verze 2). Pouze pro Českou republiku! |
| PHARMACY | Lékárenské zboží. |
Benefit Plus potřebuje znát produktovou kategorii nákupu, aby mohl čerpat ze správných rozpočtů a aplikovat na platbu zákonná pravidla.
Měna
Seznam dostupných měn
Currency | Enumeration: |
|
|---|---|---|
string | CZK | Česká koruna |
EUR | Euro |
Návratový kód transakce
Seznam návratových kódů
responseCode |
| Values: | Meaning: |
|---|---|---|---|
integer |
| 0 | Schválena nebo úspěšně provedena |
| 3 | Neplatný obchodník | |
| 5 | Zamítnuta | |
| 9 | Ve zpracování | |
| 13 | Neplatná částka | |
| 14 | Neplatná identita plátce | |
| 17 | Stornována uživatelem | |
| 21 | Neprovedena | |
| 25 | Záznam nenalezen | |
| 30 | Chybný formát | |
| 36 | Blokované zařízení | |
| 51 | Nedostatek prostředků | |
| 57 | Nepovolena | |
| 59 | Podezření na zneužití | |
| 63 | Porušení bezpečnosti | |
| 65 | Překročen limit počtu nebo četnosti | |
| 75 | Překročen počet pokusů o autentizaci plátce | |
| 91 | Nedostupná externí služba | |
| 94 | Duplicitní požadavek | |
| 96 | Systémová chyba |
Hodnoty návratových kódů mohou přibývat a měnit se. Pro e-shop jsou informativní. Rozhodující je vždy stav platby.
Jazyk platební brány
Seznam dostupných jazyků UI brány
language | Enumeration: |
|
|---|---|---|
string | cs | Čeština |
sk | Slovenština | |
en | Angličtina |
Země registrace e-shopu
Seznam dostupných zemí
country | Enumeration: |
|
|---|---|---|
string
| CZ | Česká Republika |
SK | Slovensko |
Rozsah platnosti tokenu
Seznam možných rozsahů platnosti přístupového tokenu.
tokenScope | Enumeration: |
|
|---|
tokenScope | Enumeration: |
|
|---|---|---|
string
| SINGLE_PAYMENT | Provedení jednotlivé platby. |
ESHOP_PAYMENTS | Provedení jiné operace s platbou nebo více platbami - RFU. |