Základní metody

Stručný přehled

Metoda	Popis
payment/init	Založení platby na platební bráně.
payment/status	Zjištění stavu platby.
payment/process	Přesměrování na platební bránu po předchozí inicializaci platby.
payment/reverse	Operace reverzuje (zruší před odesláním do uzávěrky) již autorizovanou platbu.
payment/close	Operace zařadí autorizovanou nezaúčtovanou platbu do zúčtování.
payment/refund	Operace zažádá o plný nebo částečný návrat prostředků nazpět plátci.
echo	Operace pro ověření dostupnosti platební brány, případně pro ověření podpisu zprávy pro snazší integraci.
echo/customer	Operace pro zjištění informace o uloženém zákazníkovi.

Následující schéma zachycuje průběh platby kartou na bráně:

Zákazník platí na e-shopu svou objednávku. Poté, co vybere platbu kartou, e-shop incializuje na platební bráně platbu pomocí operace payment/init. V odpovědi získává identifikaci platby payId (1). Po založení platby je zákazník z e-shopu pomocí operace payment/process (2) přesměrován na platební bránu.

Po zadání údajů pro platbu kartou (číslo karty, expirace, CVC) provádí platební brána u některých karet tzv. otisk zařízení (3). Jedná se o odeslání údajů z prohlížeče zákazníka vydavateli karty, který tato data použije pro následné ověření platby (4). Po dokončení platby je zákazník přesměrován zpět na e-shop.

Obchodník průběžně zjišťuje stav platby pomocí volání operace payment/status (5).

Tučně uvedené parametry jsou pro volání povinné.

Metoda `payment/init`

POST https://api.platebnibrana.csob.cz/api/v1.9/payment/init

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
orderNo	String	Referenční číslo objednávky využívané pro párování plateb, které bude uvedeno také na výpisu z banky. Numerická hodnota, maximální délka 10 číslic.
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
payOperation	String	Typ platební operace. Povolené hodnoty: `payment`, `oneclickPayment`, `customPayment`. Od verze 1.9 nepovinný parametr, defaultní hodnota: `payment`.
payMethod	String	Typ implicitní platební metody, která bude nabídnuta zákazníkovi. Povolené hodnoty: `card` = platba kartou, `card#LVP` = platba kartou s indikací low value payment (výjimka ze silného ověření pro platby nízkých částek). Od verze 1.9 nepovinný parametr, defaultní hodnota: `card`.
totalAmount	Number	Celková cena v setinách základní měny. Tato hodnota bude zobrazena na platební bráně jako celková částka k zaplacení. Částka musí souhlasit s celkovou hodnotou jednotlivých položek košíku (pokud košík obsahuje dvě položky, musí součet částek souhlasit s celkovou cenou)
currency	String	Kód měny. Povolené hodnoty: `CZK`, `EUR`, `USD`, `GBP`, `HUF`, `PLN`, `RON`, `NOK`, `SEK`.
closePayment	Boolean	Indikuje, zda má být platba automaticky zahrnuta do uzávěrky a proplacena. Povolené hodnoty: `true` / `false`. Od verze 1.9 nepovinný parametr, defaultní hodnota: `true`.
returnUrl	String	URL adresa, na kterou bude klient přesměrován zpět do e-shopu po dokončení platby. Maximální délka 300 znaků. Specifikace návratových hodnot je popsána níže.
returnMethod	String	Metoda návratu na URL adresu e-shopu. Povolené hodnoty `POST`, `GET`. Doporučená metoda je `POST`.
cart	Object	Seznam položek nákupu, který bude zobrazen na platební bráně. Obsahuje položky Item, popis položky viz níže.
customer	Object	Dodatečná data o nákupu týkající se zákazníka. Viz detailní popis struktury `customer`.
order	Object	Dodatečná data o nákupu týkající se objednávky. Viz detailní popis struktury `order`.
merchantData	String	Libovolná pomocná data, která předává obchodník na bránu, musí být kódována v BASE64. Maximální délka po zakódování je 255 znaků. V případě obchodního modelu "Marketplace" musí obchodník identifikovat svého retailera pomocí IČO. Tento identifikátor je třeba plnit do hranatých závorek [] a může být umístěn libovolně v rámci položky merchantData. V případě, že se nákupu účastní vícero retailerů, hodnoty IČO se oddělují čárkou - např. [12345678,87654321].
customerId	String	Jednoznačné ID zákazníka, který přiděluje e-shop. Maximální délka 50 znaků. Používá se při uložení karty a jejím následném použití při další návštěvě tohoto e-shopu.
language	String	Preferovaná jazyková mutace, která se zobrazí zákazníkovi na platební bráně. Od verze 1.6 povinný parametr. Povolené hodnoty: `cs`,`en`,`de`,`fr`,`hu`,`it`,`ja`,`pl`,`pt`,`ro`,`ru`,`sk`,`es`,`tr`,`vi`,`hr`,`sl`,`sv`.
ttlSec	Number	Nastavení životnosti platby, v sekundách, min. povolená hodnota 300, max. povolená hodnota 1800 (5-30 min). Životnost platby je počítána od okamžiku provolání `payment/init`. Pokud je nastaven typ platby `payOperation` na hodnotu `customPayment`, tato životnost platby `ttlSec` se ignoruje a zákazník je schopen dokončit platbu po celou dobu až 60 dní, nastavenou v parametru `customExpiry`.
logoVersion	Number	Verze schváleného loga obchodníka, které se pro danou platbu zobrazí. Pokud se bude jednat o dosud neschválené logo, použije se aktivní logo obchodníka. Pokud není, použije se defaultní logo platební brány.
colorSchemeVersion	Number	Verze schváleného barevného schématu obchodníka, které se pro danou platbu zobrazí. Pokud se bude jednat o dosud neschválené barevné schéma, zobrazí se aktivní barevné schéma obchodníka, pokud není, zobrazí se defaultní barevné schéma platební brány.
customExpiry	String	Expirace platby na míru, formát `YYYYMMDDHHMMSS` (volitelný parametr, který je kontrolován pouze v případě, že `payOperation` je nastaven na hodnotu `customPayment`). Zadaná hodnota nesmí být v minulosti. Maximální povolená platnost platby na míru je 60 dní, pokud není hodnota zadána, je nastavena expirace platby na míru na 60 dní.
signature	String	Podpis požadavku, kódováno v BASE64.

Upozornění: pokud je payOperation nastavena na oneclickPayment nebo na customPayment, ignoruje se předávaný parametr customerId. Při zpracování šablony pro platbu tedy lze zadat v rozhraní platební brány pouze novou kartu, nelze platit dříve uloženou kartou. Podobně u platby na míru - nelze platit dříve uloženými kartami.

item - Položka košíku (objekt cart)

Položky jsou uváděny po řádcích. Každý řádek košíku má název položky, počet ks, celkovou cenu za uvedený počet ks dané položky a nepovinný pomocný popis.

Položka	Typ	Popis
name	String	Název zboží, maximální délka 20 znaků.
quantity	Number	Množství, musí být >=1, celé číslo.
amount	Number	Celková cena za uvedené množství položek v setinách měny; měna bude automaticky převzata z položky currency celého požadavku.
description	String	Popis položky košíku, maximální délka 40 znaků.

Pozn: pokud je amount=0, zobrazení obsahu košíku na platební bráně uvádí text ZDARMA

POZOR: Od verze v1 musí být v košíku nejméně jedna (například "dobití kreditu") a nejvýše dvě položky, například "nákup na ..." a "doprava"). Omezení je dáno grafickou úpravou platební brány a v další verzi bude limit položek výrazně posunut.

Příklad payment/init požadavku s jednou položkou v košíku, bez vyplněných dodatečných dat o nákupu:

{
  "merchantId":"M1MIPS0000",
  "orderNo":"5547",
  "dttm":"20220125131559",
  "payOperation":"payment",
  "payMethod":"card",
  "totalAmount":123400,
  "currency":"CZK",
  "closePayment": true,
  "returnUrl":"https://shop.example.com/return",
  "returnMethod":"POST",
  "cart":[
    {
      "name": "Wireless headphones",
      "quantity": 1,
      "amount": 123400
    }
  ],
  "merchantData":"some-base64-encoded-merchant-data",
  "language":"cs",
  "signature":"base64-encoded-signature-of-payment-request"
}

Příklad payment/init požadavku se dvěma položkami v košíku, včetně vyplněných dodatečných dat o nákupu:

{
  "merchantId":"M1MIPS0000",
  "orderNo":"5547",
  "dttm":"20220125131559",
  "payOperation":"payment",
  "payMethod":"card",
  "totalAmount":123400,
  "currency":"CZK",
  "closePayment": true,
  "returnUrl":"https://shop.example.com/return",
  "returnMethod":"POST",
  "cart":[
    {
      "name": "Wireless headphones",
      "quantity": 1,
      "amount": 123400
    },
    {
      "name": "Shipping",
      "quantity": 1,
      "amount": 0,
      "description": "DPL"
    }
  ],
  "customer": {
    "name":"Jan Novák",
    "email":"[email protected]",
    "mobilePhone":"+420.800300300",
    "account": {
      "createdAt":"2022-01-12T12:10:37+01:00",
      "changedAt":"2022-01-15T15:10:12+01:00"
    },
    "login": {
      "auth":"account",
      "authAt":"2022-01-25T13:10:03+01:00"
    }
  },
  "order": {
    "type":"purchase",
    "availability":"now",
    "delivery":"shipping",
    "deliveryMode": "1",
    "addressMatch":true,
    "billing": {
      "address1":"Karlova 1",
      "city":"Praha",
      "zip":"11000",
      "country":"CZE",
    }
  },
  "merchantData":"some-base64-encoded-merchant-data",
  "language":"cs",
  "signature":"base64-encoded-signature-of-payment-request"
}

Návratové hodnoty

Položka	Typ	Popis
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init, obsahuje 15-znakový řetězec).
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
paymentStatus	Number	Stav platby, viz životní cyklus transakce.
customerCode	String	Kód platby na míru pro předání zákazníkovi. Vrací se pouze v opovědi pro `payOperation` nastavenou na `customPayment` a pouze v případě, že platba je ve stavu Platba založena (1).
statusDetail	String	Detailní stav platby (tzv. mikrostav), obsahuje například důvod zamítnutí platby, viz popis.
signature	String	Podpis odpovědi, kódováno v BASE64.

Příklad návratových hodnot pro payment/init -- úspěšně založená transakce:

{
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125131601",
  "resultCode": 0,
  "resultMessage":"OK",
  "paymentStatus": 1,
  "signature":"base64-encoded-response-signature"
 }

Příklad návratových hodnot pro payment/init -- úspěšně založená transakce typu platba na míru:

{
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125131601",
  "resultCode": 0,
  "resultMessage":"OK",
  "paymentStatus": 1,
  "customerCode": "E61EC8",
  "signature":"base64-encoded-response-signature"
 }

V případě nevalidního požadavku vrací platební brána odpověď obsahující popis chyby. Detailní popis je uveden na stránce Volání rozhraní eAPI.

Metoda `payment/process`

Požadavek obsahuje položky přímo v URL adrese. Hodnoty parametrů musí být "URL enkódovány".

GET https://api.platebnibrana.csob.cz/api/v1.9/payment/process/{merchantId}/{payId}/{dttm}/{signature}

Přesměrování na platební bránu po předchozí inicializaci platby. Na rozdíl od ostatních operací eAPI (které se mohou odesílat pomocí jakéhokoli http klienta ze systému obchodníka a vrací návratové hodnoty ve formátu JSON) se v případě této operace musí GET požadavek odeslat z prohlížeče plátce, výsledkem je přesměrování zákazníka na stránku platební brány.

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci `payment/init`).
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
signature	String	Podpis požadavku, kódováno v BASE64.

V případě platby na míru pro přechod na platební bránu nelze použít operaci payment/process, platební brána umožní dokončit platbu pouze přes adresu https://platebnibrana.csob.cz/zaplat/{customerCode} obsahující přidělený customerCode. Pro integrační prostředí platí adresa https://iplatebnibrana.csob.cz/zaplat/{customerCode}.

Příklad volání:

curl -v -X GET https://api.platebnibrana.csob.cz/api/v1.9/payment/process/M1MIPS0000/ff41e84b7e33%40HA/20220125131559/base64-encoded-request-signature

Server vrací přesměrování na stránku platební brány pro zobrazení výsledku zpracování požadavku ...

HTTP/1.1 303 See Other
Location: https://platebnibrana.csob.cz/pay/example.com/1a813383-2483-47b7-aa19-81a8e9c77850/

V případě korektního zpracování se zobrazí stránka platební brány pro zadání potřebných údajů pro zaplacení, v případě chyby při zpracování (neplatné parametry, chybný podpis požadavku, platba neexistuje apod.) se zobrazí stránka platební brány s popisem chyby.

Return URL - návrat do e-shopu

V tomto místě je vhodné upřesnit, jaké parametry bude obsahovat přesměrování z platební brány zpět na e-shop.

Předávané parametry v rámci návratu do e-shopu:

Položka	Typ	Popis
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init, obsahuje 15-znakový řetězec).
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
paymentStatus	Number	Stav platby, viz životní cyklus transakce.
authCode	String	Autorizační kód platby. Vrací se pouze v případě, že platba je ve stavu Platba potvrzena (4) nebo ve stavu Čekání na zúčtování (7) nebo ve stavu Zúčtováno (8).
merchantData	String	Data přijatá od obchodníka v `payment/init` operaci. Mohou sloužit např. pro udržení kontinuity procesu na e-shopu, kódována v BASE64. Maximální délka po zakódování 255 znaků.
statusDetail	String	Detailní stav platby (tzv. mikrostav), obsahuje například důvod zamítnutí platby, viz popis.
signature	String	Podpis odpovědi, kódováno v BASE64.

Parametry jsou předány na návratovou adresu e-shopu (parametr returnUrl získaný v payment/init) a to přes prohlížeč plátce pomocí metody POST nebo GET (parametr returnMethod) .

Poznámka: e-shop musí od v1.5 podporovat zpracování návratovych hodnot pomocí metody GET i POST (platební brána provádí redirect podle parametru returnMethod, u některých akcí -- např. zrušení platby uživatelem -- nicméně provede vždy redirect pomocí GET metody).

Příklad návratových hodnot při přesměrování z platební brány na e-shop pomocí metody POST:

Http-Method: POST
Address: https://store.example.com/return
Payload:
payId=ff41e84b7e33%40HA&dttm=20220125131610&resultCode=0&resultMessage=OK&paymentStatus=4
&authCode=F7A23E&merchantData=base64-encoded-merchant-data&signature=base64-encoded-response-signature

Poznámka: parametry jsou předávané jako Form URL Encoded data posílané v těle POST požadavku.

Příklad návratových hodnot při přesměrování z platební brány na e-shop pomocí metody GET:

Http-Method: GET
Address: https://store.example.com/return?payId=ff41e84b7e33%40HA&dttm=20220125131610&resultCode=0&resultMessage=OK&paymentStatus=4
&authCode=F7A23E&merchantData=base64-encoded-merchant-data&signature=base64-encoded-response-signature

Poznámka: hodnoty parametrů jsou "URL enkódovány".

Metoda `payment/status`

Požadavek obsahuje položky přímo v URL adrese. Hodnoty parametrů musí být "URL enkódovány".

GET https://api.platebnibrana.csob.cz/api/v1.9/payment/status/{merchantId}/{payId}/{dttm}/{signature}

Operace pro zjištění stavu platby.

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init).
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad volání:

curl -v -X GET https://api.platebnibrana.csob.cz/api/v1.9/payment/status/M1MIPS0000/ff41e84b7e33%40HA/20220125131559/base64-encoded-request-signature

Návratové hodnoty

Položka	Typ	Popis
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init, obsahuje 15-znakový řetězec).
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
paymentStatus	Number	Stav platby, viz životní cyklus transakce.
authCode	String	Autorizační kód platby. Vrací se pouze v případě, že platba je ve stavu Platba potvrzena (4), Čekání na zúčtování (7), Zúčtováno (8), Zpracování vrácení (9) nebo ve stavu Platba vrácena (10).
statusDetail	String	Detailní stav platby (tzv. mikrostav), obsahuje například důvod zamítnutí platby, viz popis.
actions	Object	Struktura pro předání potřebných dat pro provedení potvrzení v rámci ověření platby, relevantní pro platební metody oneclick@shop, applepay@shop a googlepay@shop. Viz struktura actions.
signature	String	Podpis odpovědi, kódováno v BASE64.

Příklad návratových hodnot pro payment/status:

{
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125131601",
  "resultCode": 0,
  "resultMessage":"OK",
  "paymentStatus": 4,
  "authCode":"F7A23E",
  "signature":"base64-encoded-response-signature"
 }

Metoda `payment/reverse`

PUT https://api.platebnibrana.csob.cz/api/v1.9/payment/reverse

Operace reverzuje (zruší před odesláním do uzávěrky) již autorizovanou platbu. Při zavolání této funkce na platbu, která již do uzávěrky odešla, se vrací chyba. V takovém případě je pro zrušení platby potřeba zadat žádost o vrácení prostředků.

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init).
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad požadavku:

{
  "merchantId":"M1MIPS0000",
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125132015",
  "signature":"base64-encoded-request-signature"
}

Návratové hodnoty

Položka	Typ	Popis
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init, obsahuje 15-znakový řetězec).
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
paymentStatus	Number	Stav platby, viz životní cyklus transakce.
statusDetail	String	Detailní stav platby (tzv. mikrostav), obsahuje například důvod zamítnutí platby, viz popis.
signature	String	Podpis odpovědi, kódováno v BASE64.

Příklad návratových hodnot pro payment/reverse:

{
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125132018",
  "resultCode": 0,
  "resultMessage":"OK",
  "paymentStatus": 5,
  "signature":"base64-encoded-response-signature"
 }

Metoda `payment/close`

PUT https://api.platebnibrana.csob.cz/api/v1.9/payment/close

Operace zařadí platbu do zúčtování.

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init).
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
totalAmount	Number	Celková koncová cena v setinách základní měny; hodnota musí být kladná a zároveň menší nebo rovna původní částce (viz parametr `totalAmount` v operaci `payment/init`).
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad požadavku:

{
  "merchantId":"M1MIPS0000",
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125132015",
  "signature":"base64-encoded-request-signature"
}

Příklad požadavku: (zaúčtování na menší částku)

{
  "merchantId":"M1MIPS0000",
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125132015",
  "totalAmount":10000,
  "signature":"base64-encoded-request-signature"
}

Návratové hodnoty

Položka	Typ	Popis
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init, obsahuje 15-znakový řetězec).
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
paymentStatus	Number	Stav platby, viz životní cyklus transakce.
authCode	String	Autorizační kód platby. Vrací se pouze v případě, že platba je ve stavu Platba potvrzena (4) nebo ve stavu Čekání na zúčtování (7) nebo ve stavu Zúčtováno (8).
statusDetail	String	Detailní stav platby (tzv. mikrostav), obsahuje například důvod zamítnutí platby, viz popis.
signature	String	Podpis odpovědi, kódováno v BASE64.

Příklad návratových hodnot pro payment/close:

{
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125132018",
  "resultCode": 0,
  "resultMessage":"OK",
  "paymentStatus": 7,
  "authCode":"F7A23E",
  "signature":"base64-encoded-response-signature"
 }

Metoda `payment/refund`

PUT https://api.platebnibrana.csob.cz/api/v1.9/payment/refund

Voláním operace je zažádáno o návrat prostředků nazpět plátci. Aplikuje se na již zaúčtované transakce.

Od eAPI v1.5 lze provést tzv. částečný refund vyplněním nepovinného parametru amount. Částečný refund lze provádět opakovaně, přičemž platí, že částka v parametru amount musí být menší než rozdíl původní autorizované částky a sumy dosud provedených (schválených) částečných refundů.

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init).
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
amount	Number	Požadovaná částka pro částečný refund v setinách základní měny.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad požadavku:

{
  "merchantId":"M1MIPS0000",
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125133015",
  "signature":"base64-encoded-request-signature"
}

Příklad požadavku: (včetně vyplnění částky)

{
  "merchantId":"M1MIPS0000",
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125133015",
  "amount": 1000,
  "signature":"base64-encoded-request-signature"
}

Návratové hodnoty

Položka	Typ	Popis
payId	String	Jednoznačné ID platby (přidělené platební bránou v operaci init, obsahuje 15-znakový řetězec).
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
paymentStatus	Number	Stav platby, viz životní cyklus transakce.
authCode	String	Autorizační kód platby. Vrací se pouze v případě, že platba je ve stavu Zúčtováno (8), Zpracování vrácení (9) nebo ve stavu Platba vrácena (10).
statusDetail	String	Detailní stav platby (tzv. mikrostav), obsahuje například důvod zamítnutí platby, viz popis.
signature	String	Podpis odpovědi, kódováno v BASE64.

Zpracování u této operace je asynchronní, parametr paymentStatus v návratových hodnotách proto obsahuje aktuální stav platebního požadavku (Platba zúčtována), stav platebního požadavku je možné sledovat přes payment/status.

Příklad návratových hodnot pro payment/refund:

{
  "payId":"ff41e84b7e33@HA",
  "dttm":"20220125133016",
  "resultCode": 0,
  "resultMessage":"OK",
  "paymentStatus": 8,
  "authCode": "F7A23E",
  "signature":"base64-encoded-response-signature"
 }

Metoda `echo`

Pomocná operace, která slouží pro ověření správnosti složeného podpisu požadavku a kontrolu podpisu odpovědi při vývoji aplikace. Operaci je možné volat pomocí metody POST (parametry poslány v těle požadavku ve formátu JSON) nebo pomocí metody GET -- požadavek obsahuje položky přímo v URL adrese: https://api.platebnibrana.csob.cz/api/v1.9/echo/{merchantId}/{dttm}/{signature}

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad volání pomocí metody POST:

curl -v -X POST https://api.platebnibrana.csob.cz/api/v1.9/echo \
-H "Content-Type:application/json" \
-d '{
  "merchantId":"M1MIPS0000",
  "dttm":"20220125133015",
  "signature":"base64-encoded-request-signature"
}'

Příklad volání pomocí metody GET:

curl -v -X GET https://api.platebnibrana.csob.cz/api/v1.9/echo/M1MIPS0000/20220125133015/base64-encoded-request-signature

Poznámka: hodnoty parametrů musí být "URL enkódovány".

Návratové hodnoty

Položka	Typ	Popis
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad návratových hodnot pro echo:

{
  "dttm":"20220125133016",
  "resultCode": 0,
  "resultMessage":"OK",
  "signature":"base64-encoded-response-signature"
 }

Metoda `echo/customer`

POST https://api.platebnibrana.csob.cz/api/v1.9/echo/customer

Operace pro zjištění informace o uloženém zákazníkovi.

Položka	Typ	Popis
merchantId	String	ID obchodníka přiřazené platební bránou.
customerId	String	ID zákazníka přidělené v e-shopu, maximální délka 50 znaků.
dttm	String	Datum a čas odeslání požadavku ve formátu `YYYYMMDDHHMMSS`.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad požadavku:

{
  "merchantId":"M1MIPS0000",
  "customerId":"[email protected]",
  "dttm":"20220125133015",
  "signature":"base64-encoded-request-signature"
}

Návratové hodnoty

Položka	Typ	Popis
customerId	String	ID zákazníka přidělené v e-shopu.
dttm	String	Datum a čas odpovědi ve formátu `YYYYMMDDHHMMSS`.
resultCode	Number	Výsledek operace, viz výčet.
resultMessage	String	Textový popis výsledku operace.
signature	String	Podpis požadavku, kódováno v BASE64.

Příklad návratových hodnot:

{
  "customerId":"[email protected]",
  "dttm":"20220125133015",
  "resultCode": 800,
  "resultMessage":"Customer not found",
  "signature":"base64-encoded-response-signature",
 }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Základní metody

Stručný přehled

Metoda `payment/init`

item - Položka košíku (objekt cart)

Návratové hodnoty

Metoda `payment/process`

Return URL - návrat do e-shopu

Metoda `payment/status`

Návratové hodnoty

Metoda `payment/reverse`

Návratové hodnoty

Metoda `payment/close`

Návratové hodnoty

Metoda `payment/refund`

Návratové hodnoty

Metoda `echo`

Návratové hodnoty

Metoda `echo/customer`

Návratové hodnoty

💳 Platební brána

💰 Platby

🔬 eAPI 1.9

📐 Návody a podklady

📟 API rozšíření

🔧 Časté dotazy (FAQ)

📡 Archiv starších verzí eAPI

Clone this wiki locally

Základní metody

Stručný přehled

Metoda payment/init

item - Položka košíku (objekt cart)

Návratové hodnoty

Metoda payment/process

Return URL - návrat do e-shopu

Metoda payment/status

Návratové hodnoty

Metoda payment/reverse

Návratové hodnoty

Metoda payment/close

Návratové hodnoty

Metoda payment/refund

Návratové hodnoty

Metoda echo

Návratové hodnoty

Metoda echo/customer

Návratové hodnoty

💳 Platební brána

💰 Platby

🔬 eAPI 1.9

📐 Návody a podklady

📟 API rozšíření

🔧 Časté dotazy (FAQ)

📡 Archiv starších verzí eAPI

Clone this wiki locally

Metoda `payment/init`

Metoda `payment/process`

Metoda `payment/status`

Metoda `payment/reverse`

Metoda `payment/close`

Metoda `payment/refund`

Metoda `echo`

Metoda `echo/customer`