/
Parametry

Parametry

  • Verified

    • Parametry jsou primárně specifikované v OpenAPI. V této sekci je přepis vybraných parametrů jejichž účel nemusí být úplně zřejmý.

    Headers

    authorization

    string povinný

    Přístupový token získaný při ověření e-shopu v operaci authenticate(). Token pošlete v hlavičce všech dalších operací týkajících se této platby.

    V případě vypršení tokenu musíte e-shop znovu autentizovat.

    Příklad: Bearer UMWZw61rbGFkb3bDvSBKV1QgdG9rZW4u

    x-correlation-id

    string pattern: ^[ -~]{0,128}$

    Párovací identifikátor, který můžete poslat v inicializaci platby. Brána hodnotu vrátí v pozitivních odpovědích pro stejnou platbu.
    Řetězec musí vyhovovat pro jeho předání v HTTP hlavičce. Maximální délka 128 znaků.

    Příklad: 86A42d77

    Path/Query/Body

    amount

    integer int64 povinný

    Celková požadovaná částka platby v halířích/centech požadovaná e-shopem při inicializaci platby.

    Příklad: 1350 (= 13,50 Kč nebo Euro)

    beneficiaryId

    string pattern: ^[A-F0-9]{32}$

    Identifikátor příjemce platby přidělený při registraci obchodníka/partnera. Bude použit při vyúčtování platby s Benefit Plus.

    Příklad: 4324E9CAC82F5F5408BD89FF9D6E4DA8

    amountAuthorized

    integer int64

    Celková schválená částka platby v hálířích/centech. Je vrácena v odpovědi na getPaymentState() pouze pokud platba byla schválena. Do verze 1.

    eshopId

    string pattern: ^[A-F0-9]{32}$

    Identifikátor e-shopu přidělený při registraci obchodníka.

    Příklad: 282E92C6C82F5F5408BD89FF9D6E4DC3

    gatewayUrl

    string url

    Dočasný URL vygenerovaný bránou směřující na její UI. Musíte (e-shop) otevřít prohlížeč plátce na adrese z tohoto URL pro pokračování v platbě po její inicializaci.

    Příklad: https://pay.benefit-plus.cz/ovAWyWlxvioyhiRHPBlrZmSReCo1YQ3WtXtHx0Bk2rWJTax%2FOwBAu5R4XD7FXPp6

    merchantData

    string maxLenght: 255

    Nepovinná data, která můžete poslat při inicializaci platby. Brána je vrátí v přesměrování zpět do e-shopu. Kódovaná v Base64.

    Příklad: cMWZw61rYWQ7ZGF0O29iY2hvZG7DrWth

    orderReferenceCode

    string maxLength: 40 pattern: '^$|^\S$|^\S.*\S$' povinný

    Kód/číslo objednávky – košíku přidělené obchodníkem. Brána bude parametr vracet v některých dalších operacích. Může být použito jako identifikátor nákupu v e-shopu a bude ve vyúčtování s Benefit Management. Brána validuje, zda už neexistuje úspěšná platba s touto hodnotou. Pokud pro tuto objednávku existuje úspěšná platba, brána zamítne požadavek o novou inicializaci platby s responseCode 94 - Duplicitní požadavek.

    Příklad: 34324Q22A4

    paymentId

    string pattern: ^[A-F0-9]{32}$

    Unikátní identifikátor platby přidělený bránou při inicializaci platby. Slouží k primární identifikaci platby.

    Příklad: EC42E6695FFADAE5D0017952F0CF7A69

    paymentState

    enum string

    Stav platby. Viz Číselníky | Stavy platby

    Příklad: IN_PROGRESS_UNPAID

    productCode

    enum string

    Kód kategorie produktu. Viz Číselníky | Kategorie produktu

    Příklad: LEISURE

    remainingAmount

    integer int64

    Celková schválená částka platby v hálířích/centech. Je vrácena v odpovědi na getPaymentState() pouze pokud platba byla schválena. Od verze 2. Dříve amountAuthorized.

    responseCode

    integer int32

    Návratový kód transakce. Viz Číselníky | Návratový kód transakce

    Příklad: 51

    responseMessage

    string

    Návratová zpráva transakce. Lokalizovaná podle jazyka přijatého v inicializaci platby.

    Příklad: Nedostatek prostředků

    returnUrl

    string url povinný

    URL e-shopu na které brána předá řízení po provedení platby.
    INFO: V e-shopu musíte implementovat endpoint akceptující metodu GET s query parametrem paymentId na adrese returnUrl.

    Příklad: https://eshop.partnerx.cz/returns

    tokenScope

    enum string

    Požadovaný účel autentizace při ověření e-shopu. Viz Číselníky | Rozsah platnosti tokenu

    Příklad: SINGLE_PAYMENT

    signature

    string

    Podpis požadavku nebo odpovědi. Kódovaný v Base64 a případně URL encoded, pokud je v query. Viz Bezpečnost | Podepisování zpráv

    Příklad: KZU95wMS2AUaPnnI6RknP0arEjwFs%2Bfr%2BkYBYIpIJqrSkwBpfr35JfWU8KLKFhcgsNmyMx1sHhXeOwB9Dqz3dPotSPV0XzJ6BuvIGaW1fgsTsoFSMXhYbSbzJHZXiEosvmGrQSXHBrS8upLhiGcVr9UCnQ3jTryp%2BKKGtJQQj%2FRE4yzRbRTPtl2JfVCleU3g6nXhKjDAEGkgf623KhCtQ4b9MOiaofyu5z%2BsFlKXVzmLe9vu9ARGZcPunv1RJyI1ysovarQU5%2F0H848dVxCJtMb3ZZvnn%2BkmZCOPJnKv8DJXeltcEYSOOV4tn%2Fy4MRzQYJmDhg3N5JILWtzE6VoG5hrq4RyWHryh7ZY4tIffG6TCMpYuJhurHYXY%2FOC2GIU8GsDWBy5%2B0McJrUTIbqIUwXjRO9LvlCzB%2BhgBgBSWeAtsGgbivQc5%2Fckf%2FRaxtmgWztrD%2BJONmnhkOCvOrNd3at%2BnbDgBsAn775f6Vnwit%2FISh7sNLyAZKsMC5XTY9%2FyMtCo0CHPu%2B4rbKsgGB3XfatSIZSo6IKiDXZ4U6FOb5hlgWNS8GJid%2B%2FbAV3NPzHjMrn1UxuDfZeR7mv2pwStO9sQA4%2FQZi4Qxu6nu6V3n%2BbRvvZg%2FHXi5rpHQsEI3eBmrEMhRTo7RUF3zBCYv78DscmLmHerN50yRjSk5nXcfFXM%3D