Skip to content

Ověřovací kód na výpis

Ondřej Zaoral edited this page Jun 17, 2022 · 1 revision

Toto rozšíření (extension) umožňuje přenést na výpis plátce kód, který může být použit pro ověření, zda je uživatel oprávněným držitelem karty a má přístup k výpisu. Generování kódu a následné ověření provádí obchodník, brána pouze předává kód (vygenerovaný obchodníkem) dále do zpracování.

Obchodník musí mít tuto funkcionalitu na platební bráně aktivovanou. Pro aktivaci, prosím, kontaktujte [email protected].

Rozšíření parametrů požadavku operace payment/init

Nově přidaný parametr je extensions, obsahuje seznam všech předávaných rozšíření pro danou operaci. Rozšíření validationCode bude akceptováno platební bránou v požadavku operace payment/init.

Popis parametrů rozšíření validationCode použité v operaci payment/init

Tučně uvedené parametry musí obchodník vyplnit (jsou povinné)

Položka Typ Popis
extension String ID rozšíření (přidělené na základě konfigurace platební bránou). Pro toto rozšíření bude vždy nastaveno na konstantu validationCode.
dttm String Datum a čas požadavku ve formátu YYYYMMDDHHMMSS.
code String Ověřovací kód, max. délka 12 znaků.
signature String Podpis rozšíření, kódováno v BASE64.

Příklad doplněného požadavku pro payment/init o rozšíření validationCode

curl -v –X POST https://api.platebnibrana.csob.cz/api/v1.9/payment/init \
-H "Content-Type:application/json" \
-d '{
  "merchantId":"M1MIPS0000",
  "orderNo":"55471",
  "dttm":"20220125131601",
  "payOperation":"payment",
  "payMethod":"card",
  "totalAmount":12300,
  "currency":"CZK",
  "closePayment": true,
  "returnUrl":"https://example.com/return",
  "returnMethod":"POST",
  "cart":[
    {
      "name": "Nákup: example.com",
      "quantity": 1,
      "amount": 12300
    }
  ],
  "language":"cs",
  "signature":"base64-encoded-signature-of-payment-request",
  "extensions":[
    {
      "extension": "validationCode",
      "dttm": "20220125131601",
      "code": "X167CS",
      "signature": "base64-encoded-extension-signature"
    }
  ]
}'

Řetězec pro výpočet nebo pro ověření podpisu je pro toto rozšíření seskládaný v pořadí, v jakém jsou položky uvedeny ve specifikaci (viz výše).

validationCode|20220125131601|X167CS

Poznámka: Podpis původních parametrů je nezměněn, položka extensions obsahující seznam jednotlivých posílaných rozšíření nijak nezasahuje do výpočtu původního podpisu zprávy, každé rozšíření má svůj vlastní podpis.

Pro podepisování / ověření podpisu rozšíření je použit stejný algoritmus (SHA1withRSA pro eAPI 1.7 a nižší, nově pak SHA256withRSA pro eAPI 1.8 a vyšší).

Rozšíření parametrů požadavku operace payment/status

V případě, že je daná transakce autorizována a obchodník v rámci payment/init vyplnil ověřovací kód, vrací se v odpovědi operace payment/status rozšíření validationCode. Jinak toto rozšíření v odpovědi payment/status není vyplněno.

Popis parametrů rozšíření validationCode použité v operaci payment/status

Tučně uvedené parametry budou vždy obsažené v odpovědi

Položka Typ Popis
extension String ID rozšíření (přidělené na základě konfigurace platební bránou). Pro toto rozšíření bude vždy nastaveno na konstantu validationCode.
dttm String Datum a čas požadavku ve formátu YYYYMMDDHHMMSS.
code String Ověřovací kód, max. délka 12 znaků (převzata hodnota z payment/init).
verified3DS Boolean Příznak, zda byla transakce 3DS ověřena.
signature String Podpis rozšíření, kódováno v BASE64.

Příklad doplněného response pro payment/status o rozšíření validationCode

{
  "dttm": "20220125131810",
  "payId": "ff41e84b7e33@HA",
  "resultCode": 0,
  "resultMessage": "OK",
  "paymentStatus": 7,
  "authCode": "453708",
  "signature": "base64-encoded-response-signature",
  "extensions": [
    {
      "extension": "validationCode",
      "dttm": "20220125131810",
      "code": "X167CS",
      "verified3DS": true,
      "signature": "base64-encoded-extension-signature"
    }
  ]
}

Řetězec pro výpočet nebo pro ověření podpisu je pro toto rozšíření seskládaný v pořadí, v jakém jsou položky uvedeny ve specifikaci (viz výše).

validationCode|20220125131810|X167CS|true

Poznámka: Podpis původních parametrů je nezměněn, položka extensions obsahující seznam jednotlivých posílaných rozšíření nijak nezasahuje do výpočtu původního podpisu zprávy, každé rozšíření má svůj vlastní podpis.

Pro podepisování / ověření podpisu rozšíření je použit stejný algoritmus (SHA1withRSA pro eAPI 1.7 a nižší, nově pak SHA256withRSA pro eAPI 1.8 a vyšší).

Clone this wiki locally