logo
Powered by Redocly

Tokenizacja

Dostępna jest tokenizacja kart klienta w oparciu o wewnętrzne mechanizmy bramki ecommmerce (COF) lub tokenizacja w oparciu o usługi organizacji płatniczej Visa VTS/Mastercard SCOF (NETWORK). Proces może być kilkuetapowy, w związku z czym cały flow tokenizacji spina identyfikator o nazwie tokenizerId. Do operacji na tokenie (usunięcie/modyfikacja) należy wykorzystywać identyfikator tokenu (nie tokenizacji).

Aktualizacja danych instrumentu płatniczego dla tokenizacji

Metoda pozwala uzupelnic dane instrumentu płatniczego, jeżeli nie zostaly podane wczesniej. Dozwolone jest przesłanie sekcji instrument i device.

Request
path Parameters
tokenizerId
required
string

Identyfikator systemowy tokenu (służy m.in. do pobrania tokenu)

Request Body schema:
required
type
required
string

Typ instrumentu płatniczego

Enum: "COF" "CARD" "BLIK" "BLIK_CODE" "BLIK_UID" "BLIK_PAYID" "GPAY" "APAY" "PBL" "SCOF"
instrumentNo
string or null

Nr instrumentu płatniczego (np. tokenu lub karty) (wymagany dla type = CARD/COF)

encInstrumentNo
string or null

Zaszyfrowany nr instrumentu płatniczego

instrumentRef
string or null

Identyfikator instrumentu płatnicznego w zewnętrznym systemie (wymagany dla type = SCOF/VTS)

token
string or null

Dane tokenu zwracane przez API APAY/GPAY (base64 encoded) (wymagany dla type = APAY/GPAY)

expDate
string or null

Data ważnosci (Format: YYYYMM) (wymagany dla type = CARD)

encExpDate
string or null

Zaszyfrowana data ważnosci

cvv
string or null

Kod zabezpieczajacy (wymagany dla type = CARD)

encCvv
string or null

Zaszyfrowany kod zabezpieczajacy

code
string or null

Jednorazowy kod płatności BLIK (wymagany dla type = BLIK_CODE)

alias
string or null

Alias uzytkownika BLIK dla płatności OneClick lub cyklicznych (wymagany dla type = BLIK_UID/BLIK_PAYID)

app
string or null

Identyfikator konta mobilnego BLIK (w przypadku niejednoznacznosci aliasu)

provider
string or null

Identyfikator pośrednika płatności (może byc wybrany automatycznie na podstawie konfiguracji merchanta)

Enum: "BM" "PA"
bank
string or null

Nazwa banku (wymagany dla type = PBL)

bankId
integer or null <int32>

Identyfikator banku (w systemie operatora PBL) (wymagany dla type = PBL)

register
boolean or null

Zarejestruj alias na potrzeby transparentnych płatności

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

put/v1/ecommerce/tokenizer/{tokenizerId}/instrument
Request samples
No sample

Aktualizacja atrybutu instrumentu płatniczego

Tą metodę można wykorzystać gdy wymagane jest dosłanie pojedynczego atrybutu instrumentu (np. kod CVV)

Request
path Parameters
tokenizerId
required
string

Identyfikator systemowy tokenu (służy m.in. do pobrania tokenu)

Request Body schema:
required
cvv
string or null

Kod zabezpieczajacy karty

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

patch/v1/ecommerce/tokenizer/{tokenizerId}/instrument
Request samples
{
  • "cvv": "string"
}

Tokenizacja kart klienta

Dostępna jest tokenizacja kart klienta w oparciu o wewnętrzne mechanizmy bramki ecommmerce (COF) lub tokenizacja w oparciu o usługi organizacji płatniczej Visa VTS/Mastercard SCOF (NETWORK). Proces może być kilkuetapowy, w związku z czym cały flow tokenizacji spina identyfikator o nazwie tokenizerId.

Request
Request Body schema:
required
channel
required
string

Kanał operacji

Enum: "PAYWALL" "MOBILE" "WEBAPI" "EBOK" "CSS"
object (InstrumentInfo)

Szczegółowe dane requestu

type
required
string

Typ instrumentu płatniczego

Enum: "COF" "CARD" "BLIK" "BLIK_CODE" "BLIK_UID" "BLIK_PAYID" "GPAY" "APAY" "PBL" "SCOF"
instrumentNo
string or null

Nr instrumentu płatniczego (np. tokenu lub karty) (wymagany dla type = CARD/COF)

encInstrumentNo
string or null

Zaszyfrowany nr instrumentu płatniczego

instrumentRef
string or null

Identyfikator instrumentu płatnicznego w zewnętrznym systemie (wymagany dla type = SCOF/VTS)

token
string or null

Dane tokenu zwracane przez API APAY/GPAY (base64 encoded) (wymagany dla type = APAY/GPAY)

expDate
string or null

Data ważnosci (Format: YYYYMM) (wymagany dla type = CARD)

encExpDate
string or null

Zaszyfrowana data ważnosci

cvv
string or null

Kod zabezpieczajacy (wymagany dla type = CARD)

encCvv
string or null

Zaszyfrowany kod zabezpieczajacy

code
string or null

Jednorazowy kod płatności BLIK (wymagany dla type = BLIK_CODE)

alias
string or null

Alias uzytkownika BLIK dla płatności OneClick lub cyklicznych (wymagany dla type = BLIK_UID/BLIK_PAYID)

app
string or null

Identyfikator konta mobilnego BLIK (w przypadku niejednoznacznosci aliasu)

provider
string or null

Identyfikator pośrednika płatności (może byc wybrany automatycznie na podstawie konfiguracji merchanta)

Enum: "BM" "PA"
bank
string or null

Nazwa banku (wymagany dla type = PBL)

bankId
integer or null <int32>

Identyfikator banku (w systemie operatora PBL) (wymagany dla type = PBL)

register
boolean or null

Zarejestruj alias na potrzeby transparentnych płatności

object or null (MerchantInfo)

Dane merchanta pośredniczacego (operator aplikacji mobilnej)

merchantId
required
string [ 0 .. 15 ] characters

Identyfikator merchanta nadany przez operatora płatności (MID)

merchantName
string or null
Deprecated

Nazwa merchanta

name
string or null

Nazwa merchanta

mcc
string or null

MCC

url
string or null

Adres URL sklepu

redirectURL
string or null

Adres URL przekierowania

terminalId
string or null

Id terminala

object or null (MerchantAddress)

Adres merchanta

street
required
string

Adres (ulica i numer domu)

postal
required
string

Kod pocztowy

state
string or null

Województwo

city
required
string

Miasto

country
required
string

Kraj (kod ISO np. PL)

taxId
string or null

Nip

acsNotificationURL
string or null

Adres publicznego endpointu do odebrania notyfikacji CRes z ACS (jeżeli obsługiwany przez merchanta)

object (CustomerInfo)

Dane wlasciciela karty

email
required
string

Adres email klienta

extCustomerId
string or null

Identyfikator klienta w systemie merchanta

name
string or null

Imię i nazwisko klienta

surname
string or null

Imię i nazwisko klienta

object or null (CustomerAddress)

Adres rozliczeniowy klienta (wymagany dla method = CARD)

street
required
string

Adres (ulica i numer domu)

postal
required
string

Kod pocztowy

state
string

Województwo

city
required
string

Miasto

country
required
string

Kraj (kod ISO np. PL)

object or null (CustomerRiskIndicator)

Dodatkowe parametry analizy ryzyka na potrzeby 3DS

scaPreference
string

Preferencje dotyczące silnego uwierzytelnienia klienta (SCA)

accountAuthDate
string or null

Data i godzina (UTC) uwierzytelnienia klienta (Format: YYYYMMDDHHMM) (wymagane dla scaPreference = LOW_RISK)

accountCreateDate
string or null

Data założenia konta u merchanta/agenta (Format: YYYYMMDD) (wymagane dla scaPreference = LOW_RISK)

accountChangeDate
string or null

Data ostatniej zmiany danych konta (Format: YYYYMMDD) (wymagane dla scaPreference = LOW_RISK)

accountActiveDate
string or null

Data od kiedy posiadacz karty aktywował płatności na koncie merchanta/agenta (Format: YYYYMMDD) (wymagane dla scaPreference = LOW_RISK)

passChangeDate
string or null

Data ostatniej zmiany hasła do konta (Format: YYYYMMDD) (wymagane dla scaPreference = LOW_RISK)

purchaseCount6M
integer or null <int32>

Liczba zakupów wykonana za pomocą konta w ciagu ostatnich sześciu miesięcy (wymagane dla scaPreference = LOW_RISK)

tokenizationCountDay
integer or null <int32>

Liczba prób dodania kart do konta z ostatnich 24 godzin (wymagane dla scaPreference = LOW_RISK)

transactionCountDay
integer or null <int32>
Deprecated

Liczba transakcji udanych oraz nieudanych z ostatnich 24 godzin

transactionCountYear
integer or null <int32>
Deprecated

Liczba transakcji udanych oraz nieudanych z ostatniego roku

shipAddressDate
string or null

Data pierwszego użycia adresu, który zostal wybrany dla aktualnej transakcji (Format: YYYYMMDD) (wymagane dla scaPreference = LOW_RISK)

shipNameIndicator
boolean or null

Wskazuje czy nazwa posiadacza karty zdefiniowana na koncie operatora jest identyczna jak ta w nazwie do wysyłki biezacej transakcji

suspiciousActivity
boolean or null

Wskazuje czy kiedykolwiek zachowanie posiadacza karty zostało potraktowane jako podejrzane (wymagane dla scaPreference = LOW_RISK)

authenticatedTransaction
boolean or null

Wskazuje czy transakcja byla dodatkowo uwierzytelniona

transactionSCountDay
integer or null <int32>

Liczba transakcji udanych z ostatnich 24 godzin

transactionUCountDay
integer or null <int32>

Liczba transakcji nieudanych z ostatnich 24 godzin

transactionSCountYear
integer or null <int32>

Liczba transakcji udanych z ostatniego roku

transactionUCountYear
integer or null <int32>

Liczba transakcji nieudanych z ostatniego roku

object or null (PhoneNumber)

Obiekt zawierajacy dane telefoniczne klienta

countryCode
required
string [ 1 .. 3 ] characters

Kod kraju

phoneNo
required
string [ 7 .. 15 ] characters

Numer telefonu

object or null (DeviceInfo)

Dane urządzenia z ktorego wykonywana jest operacja (przegladarka www lub urzadzenie mobilne) (wymagane dla channel = PAYWALL/WEBAPI)

ip
string or null

IP urządzenia

name
string or null

Nazwa urządzenia z ktorego wykonywana jest płatność

object or null (SdkData)

Parametry SDK (wymagany dla channel = MOBILE)

sdkTransID
required
string

Identyfikator UUID generowany przez 3DS SDK

sdkReferenceNumber
required
string

Identyfikator dostawcy oraz wersji 3DS SDK

sdkInterface
required
string

Wspierane przez SDK typ interfejsu

sdkUiType
required
Array of strings

Lista typow interfejsow wspieranych dla procesu challenge

Items Enum: "TEXT" "SINGLE_SELECT" "MULTI_SELECT" "OOB" "HTML"
sdkAppId
required
string

Stała Wartość UUID, ktora jest generowana przez SDK podczas inStałacji aplikacji

sdkEncData
required
string

Obiekt JWE przygotowany przez SDK, zawierajacy zaszyfrowane dane dla DS

required
object (EphemPubKey)

Czesc publiczna efemerycznej pary kluczy wygenerowanych przez SDK służąca do negocjacji połączenia z ACS

sdkAuthValue
required
string

Wartość służąca do weryfkacji autentycznosci oraz integralnosci SDK

object or null (BrowserData)

Parametry przeglądarki (wymagany dla channel = PAYWALL/WEBAPI; method = CARD)

javascriptEnabled
required
boolean

Obsługa JavaScript włączona w przeglądarce

javaEnabled
boolean or null

Obsługa Java włączona w przeglądarce (wymagany dla javascriptEnabled = true)

language
required
string or null

Jezyk ustawiony na przeglądarce (wymagany dla javascriptEnabled = true)

colorDepth
string or null

Wartość reprezentujaca głębie bitowa palety kolorów (wymagany dla javascriptEnabled = true)

screenHeight
integer or null <int32>

Wysokość ekranu w pikselach (wymagany dla javascriptEnabled = true)

screenWidth
integer or null <int32>

Szerokość ekranu w pikselach (wymagany dla javascriptEnabled = true)

timezone
integer or null <int32>

Przesunięcie strefy czasowej w minutach między czasem UTC (wymagany dla javascriptEnabled = true)

object or null (MerchantInfo)

Dane merchanta pośredniczacego (operator aplikacji mobilnej)

merchantId
required
string [ 0 .. 15 ] characters

Identyfikator merchanta nadany przez operatora płatności (MID)

merchantName
string or null
Deprecated

Nazwa merchanta

name
string or null

Nazwa merchanta

mcc
string or null

MCC

url
string or null

Adres URL sklepu

redirectURL
string or null

Adres URL przekierowania

terminalId
string or null

Id terminala

object or null (MerchantAddress)

Adres merchanta

street
required
string

Adres (ulica i numer domu)

postal
required
string

Kod pocztowy

state
string or null

Województwo

city
required
string

Miasto

country
required
string

Kraj (kod ISO np. PL)

taxId
string or null

Nip

acsNotificationURL
string or null

Adres publicznego endpointu do odebrania notyfikacji CRes z ACS (jeżeli obsługiwany przez merchanta)

object or null (PaymentOptions)

Inne parametry sterujace

transKind
string or null

Rodzaj transakcji dla transakcji kartowych

transType
string or null

Typ transakcji dla transakcji kartowych

tokenize
boolean or null

Zadanie tokenizacji karty

recurring
string or null

Flaga płatności cyklicznych

recurringType
string or null

Rodzaj płatności cyklicznej

refPaymentId
string or null

Identyfikator poprzedniej płatności (INITIAL)

tdsServerTxnId
string or null

Identyfikator transakcji z systemu 3DS Server (jeżeli wystapiła wczesniejsza interakcja z 3DS przed zarejestrowaniem płatności)

validTime
integer or null <int32> <= 604800

Czas ważnosci generowanych linkow płatności w sekundach (domyslnie 600; max. 604800)

iframe
boolean or null

Zadanie tokenizacji karty

asyncNotify
string or null

Obsługa notyfikacji dla transakcji kartowych

methods
string or null

Lista dozwolonych metod płatności

method
required
string

Typ tokenizacji (COF/NETWORK lub DEFAULT jeżeli system sam ma podjać decyzje na podstawie parametryzacji merchanta)

Enum: "COF" "NETWORK" "DEFAULT"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/v1/ecommerce/tokenizer
Request samples
No sample
Response samples
No sample

Unieważnienie tokenu

Usunięcie tokenu z systemu operatora płatności. Wariant z wykorzystaniem identyfikatora procesu tokenizacji:

Request
path Parameters
tokenizerId
required
string

Identyfikator systemowy tokenu (słuzy m.in. do pobrania tokenu)

Request Body schema:
reason
string or null

Powód usuniecia tokenu

Enum: "FRAUD" "CLIENT" "SYSTEM"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/v1/ecommerce/tokenizer/{tokenizerId}/discard
Request samples
{
  • "reason": "FRAUD"
}

Anulowanie tokenizacji

Proces tokenizacji możne zostać przerwany przez klienta. Tokenizacja otrzymuje status CANCELLED.

Request
path Parameters
tokenizerId
required
string

Identyfikator systemowy tokenu (sluzy m.in. do pobrania tokenu)

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/v1/ecommerce/tokenizer/{tokenizerId}/cancel
Request samples 
Wyszukanie tokenu
Wyszukiwanie tokenów kartowych po numerze. Wyszukiwanie odbywa się w kontekście merchanta.


Request 
Request Body schema: 
required
method
required
string
Typ tokenu (COF/SCOF/VTS)


 Enum: "COF" "NETWORK" "DEFAULT"  
type
required
string
Typ tokenu (COF/SCOF/VTS)


 Enum: "COF" "SCOF" "VTS"  
instrumentNo
string or null
Nr tokenu kartowego (wymagany dla method = COF)


 
instrumentRef
string or null
Identyfikator tokenu w zewnetrznym systemie (wymagany dla method = SCOF/VTS)


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


post/v1/ecommerce/tokenizer/search
Request samples 
{
  • "method": "COF",
  • "type": "COF",
  • "instrumentNo": "string",
  • "instrumentRef": "string"
}
Unieważnienie tokenu
Usunięcie tokenu z systemu operatora płatności. Wariant wykorzystujący numer tokenu kartowego.


Request 
Request Body schema: 
required
method
required
string
Typ tokenu (COF/SCOF/VTS)


 Enum: "COF" "NETWORK" "DEFAULT"  
type
required
string
Typ tokenu (COF/SCOF/VTS)


 Enum: "COF" "SCOF" "VTS"  
instrumentNo
string or null
Nr tokenu kartowego (wymagany dla method = COF)


 
instrumentRef
string or null
Identyfikator tokenu w zewnetrznym systemie (wymagany dla method = SCOF/VTS)


 
reason
string or null
Powód usunięcia tokenu


 Enum: "FRAUD" "CLIENT" "SYSTEM"  
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


post/v1/ecommerce/tokenizer/discard
Request samples 
{
  • "method": "COF",
  • "type": "COF",
  • "instrumentNo": "string",
  • "instrumentRef": "string",
  • "reason": "FRAUD"
}
Konwersja tokenu COF na NETWORK
Tokeny z wewnętrznej tokenizacji COF można zmigrować na tokeny NETWORK. Metoda nie usuwa danych oryginalnego tokenu.


Request 
Request Body schema: 
required
method
required
string
 Value: "NETWORK"  
required
object (InstrumentInfo) 
Szczegółowe dane requestu


 
type
required
string
Typ instrumentu płatniczego


 Enum: "COF" "CARD" "BLIK" "BLIK_CODE" "BLIK_UID" "BLIK_PAYID" "GPAY" "APAY" "PBL" "SCOF"  
instrumentNo
string or null
Nr instrumentu płatniczego (np. tokenu lub karty) (wymagany dla type = CARD/COF)


 
encInstrumentNo
string or null
Zaszyfrowany nr instrumentu płatniczego


 
instrumentRef
string or null
Identyfikator instrumentu płatnicznego w zewnętrznym systemie (wymagany dla type = SCOF/VTS)


 
token
string or null
Dane tokenu zwracane przez API APAY/GPAY (base64 encoded) (wymagany dla type = APAY/GPAY)


 
expDate
string or null
Data ważnosci (Format: YYYYMM) (wymagany dla type = CARD)


 
encExpDate
string or null
Zaszyfrowana data ważnosci


 
cvv
string or null
Kod zabezpieczajacy (wymagany dla type = CARD)


 
encCvv
string or null
Zaszyfrowany kod zabezpieczajacy


 
code
string or null
Jednorazowy kod płatności BLIK (wymagany dla type = BLIK_CODE)


 
alias
string or null
Alias uzytkownika BLIK dla płatności OneClick lub cyklicznych (wymagany dla type = BLIK_UID/BLIK_PAYID)


 
app
string or null
Identyfikator konta mobilnego BLIK (w przypadku niejednoznacznosci aliasu)


 
provider
string or null
Identyfikator pośrednika płatności (może byc wybrany automatycznie na podstawie konfiguracji merchanta)


 Enum: "BM" "PA"  
bank
string or null
Nazwa banku (wymagany dla type = PBL)


 
bankId
integer or null <int32> 
Identyfikator banku (w systemie operatora PBL) (wymagany dla type = PBL)


 
register
boolean or null
Zarejestruj alias na potrzeby transparentnych płatności


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


post/v1/ecommerce/tokenizer/convert
Request samples 
{
  • "method": "NETWORK",
  • "instrument": {
    }
}
Okeslenie organizacji platniczej i wersji protokołu (dla flow mobilnego).
Dodatkowy krok dla flow mobilnego do określenia organizacji płatniczej i używanej wersji protokołu. Wersja protokołu uStałana jest jako najwyższa możliwa z zakresów obsługiwanych przez komponenty: SDK, ACS, 3DS i DS.


Request 
Request Body schema: 
required
channel
required
string
Kanał operacji


 Enum: "PAYWALL" "MOBILE" "WEBAPI" "EBOK" "CSS"  
sdkStartProtocol
required
string
Najstarsza wersja protokołu wspierana przez SDK


 
sdkEndProtocol
required
string
Najnowsza wersja protokołu wspierana przez SDK


 
required
object (InstrumentInfo) 
Szczegółowe dane requestu


 
type
required
string
Typ instrumentu płatniczego


 Enum: "COF" "CARD" "BLIK" "BLIK_CODE" "BLIK_UID" "BLIK_PAYID" "GPAY" "APAY" "PBL" "SCOF"  
instrumentNo
string or null
Nr instrumentu płatniczego (np. tokenu lub karty) (wymagany dla type = CARD/COF)


 
encInstrumentNo
string or null
Zaszyfrowany nr instrumentu płatniczego


 
instrumentRef
string or null
Identyfikator instrumentu płatnicznego w zewnętrznym systemie (wymagany dla type = SCOF/VTS)


 
token
string or null
Dane tokenu zwracane przez API APAY/GPAY (base64 encoded) (wymagany dla type = APAY/GPAY)


 
expDate
string or null
Data ważnosci (Format: YYYYMM) (wymagany dla type = CARD)


 
encExpDate
string or null
Zaszyfrowana data ważnosci


 
cvv
string or null
Kod zabezpieczajacy (wymagany dla type = CARD)


 
encCvv
string or null
Zaszyfrowany kod zabezpieczajacy


 
code
string or null
Jednorazowy kod płatności BLIK (wymagany dla type = BLIK_CODE)


 
alias
string or null
Alias uzytkownika BLIK dla płatności OneClick lub cyklicznych (wymagany dla type = BLIK_UID/BLIK_PAYID)


 
app
string or null
Identyfikator konta mobilnego BLIK (w przypadku niejednoznacznosci aliasu)


 
provider
string or null
Identyfikator pośrednika płatności (może byc wybrany automatycznie na podstawie konfiguracji merchanta)


 Enum: "BM" "PA"  
bank
string or null
Nazwa banku (wymagany dla type = PBL)


 
bankId
integer or null <int32> 
Identyfikator banku (w systemie operatora PBL) (wymagany dla type = PBL)


 
register
boolean or null
Zarejestruj alias na potrzeby transparentnych płatności


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


post/v1/ecommerce/tokenizer/binInfo
Request samples 
{
  • "channel": "PAYWALL",
  • "sdkStartProtocol": "string",
  • "sdkEndProtocol": "string",
  • "instrument": {
    }
}
Pobieranie tokenu kartowego
Pobranie danych tokenu na podstawie identyfikatora procesu tokenizacji. Merchant powinien zapisać nr tokenu i posługiwać się nim w dalszej komunikacji z API.


Request 
path Parameters
tokenizerId
required
string
Identyfikator systemowy tokenu (sluzy m.in. do pobrania tokenu)


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


get/v1/ecommerce/tokenizer/{tokenizerId}
Request samples 
Aktualizacja danych instrumentu płatniczego i urządzenia
Podobna metoda wykorzystywana jest przez paywall API, ale pozwala rownież na przesłanie danych urządzenia z którego klient realizuje płatność. Dozwolone jest przesłanie sekcji instrument i device.


Request 
path Parameters
tokenizerId
required
string
Identyfikator systemowy tokenu (sluzy m.in. do pobrania tokenu)


 
Request Body schema: 
required
object (InstrumentInfo) 
Szczegółowe dane requestu


 
type
required
string
Typ instrumentu płatniczego


 Enum: "COF" "CARD" "BLIK" "BLIK_CODE" "BLIK_UID" "BLIK_PAYID" "GPAY" "APAY" "PBL" "SCOF"  
instrumentNo
string or null
Nr instrumentu płatniczego (np. tokenu lub karty) (wymagany dla type = CARD/COF)


 
encInstrumentNo
string or null
Zaszyfrowany nr instrumentu płatniczego


 
instrumentRef
string or null
Identyfikator instrumentu płatnicznego w zewnętrznym systemie (wymagany dla type = SCOF/VTS)


 
token
string or null
Dane tokenu zwracane przez API APAY/GPAY (base64 encoded) (wymagany dla type = APAY/GPAY)


 
expDate
string or null
Data ważnosci (Format: YYYYMM) (wymagany dla type = CARD)


 
encExpDate
string or null
Zaszyfrowana data ważnosci


 
cvv
string or null
Kod zabezpieczajacy (wymagany dla type = CARD)


 
encCvv
string or null
Zaszyfrowany kod zabezpieczajacy


 
code
string or null
Jednorazowy kod płatności BLIK (wymagany dla type = BLIK_CODE)


 
alias
string or null
Alias uzytkownika BLIK dla płatności OneClick lub cyklicznych (wymagany dla type = BLIK_UID/BLIK_PAYID)


 
app
string or null
Identyfikator konta mobilnego BLIK (w przypadku niejednoznacznosci aliasu)


 
provider
string or null
Identyfikator pośrednika płatności (może byc wybrany automatycznie na podstawie konfiguracji merchanta)


 Enum: "BM" "PA"  
bank
string or null
Nazwa banku (wymagany dla type = PBL)


 
bankId
integer or null <int32> 
Identyfikator banku (w systemie operatora PBL) (wymagany dla type = PBL)


 
register
boolean or null
Zarejestruj alias na potrzeby transparentnych płatności


 
object or null (DeviceInfo) 
Dane urządzenia z ktorego wykonywana jest operacja (przegladarka www lub urzadzenie mobilne) (wymagane dla channel = PAYWALL/WEBAPI)


 
ip
string or null
IP urządzenia


 
name
string or null
Nazwa urządzenia z ktorego wykonywana jest płatność


 
object or null (SdkData) 
Parametry SDK (wymagany dla channel = MOBILE)


 
sdkTransID
required
string
Identyfikator UUID generowany przez 3DS SDK


 
sdkReferenceNumber
required
string
Identyfikator dostawcy oraz wersji 3DS SDK


 
sdkInterface
required
string
Wspierane przez SDK typ interfejsu


 
sdkUiType
required
Array of strings
Lista typow interfejsow wspieranych dla procesu challenge


Items Enum: "TEXT" "SINGLE_SELECT" "MULTI_SELECT" "OOB" "HTML"  
sdkAppId
required
string
Stała Wartość UUID, ktora jest generowana przez SDK podczas inStałacji aplikacji


 
sdkEncData
required
string
Obiekt JWE przygotowany przez SDK, zawierajacy zaszyfrowane dane dla DS


 
required
object (EphemPubKey) 
Czesc publiczna efemerycznej pary kluczy wygenerowanych przez SDK służąca do negocjacji połączenia z ACS


 
sdkAuthValue
required
string
Wartość służąca do weryfkacji autentycznosci oraz integralnosci SDK


 
object or null (BrowserData) 
Parametry przeglądarki (wymagany dla channel = PAYWALL/WEBAPI; method = CARD)


 
javascriptEnabled
required
boolean
Obsługa JavaScript włączona w przeglądarce


 
javaEnabled
boolean or null
Obsługa Java włączona w przeglądarce (wymagany dla javascriptEnabled = true)


 
language
required
string or null
Jezyk ustawiony na przeglądarce (wymagany dla javascriptEnabled = true)


 
colorDepth
string or null
Wartość reprezentujaca głębie bitowa palety kolorów (wymagany dla javascriptEnabled = true)


 
screenHeight
integer or null <int32> 
Wysokość ekranu w pikselach (wymagany dla javascriptEnabled = true)


 
screenWidth
integer or null <int32> 
Szerokość ekranu w pikselach (wymagany dla javascriptEnabled = true)


 
timezone
integer or null <int32> 
Przesunięcie strefy czasowej w minutach między czasem UTC (wymagany dla javascriptEnabled = true)


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


patch/v1/ecommerce/tokenizer/{tokenizerId}
Request samples 
No sample
Sprawdzenie statusu tokenizacji
Sprawdzenie statusu tokenizacji bez zwracania ciała tokenu kartowego.


Request 
path Parameters
tokenizerId
required
string
Identyfikator systemowy tokenu (sluzy m.in. do pobrania tokenu)


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


500
Internal Server Error


502
Bad Gateway


503
Service Unavailable


504
Gateway Timeout


get/v1/ecommerce/tokenizer/{tokenizerId}/status
Request samples