Skorzystaj z naszych interfejsów API typu „serwer-serwer”, aby odbierać płatności bezpośrednio z własnego systemu zaplecza i zachować pełną kontrolę nad procesem realizacji transakcji.
Ten model integracji pozwala na gromadzenie danych dotyczących płatności po Twojej stronie oraz bezpieczne przesyłanie ich do bramki SIBS Gateway w celu przetworzenia. Wykonaj poniższe kroki, aby rozpocząć przyjmowanie płatności w sposób wydajny i bezpieczny.
Krok 1: Utwórz zamówienie
Gdy klient jest gotowy do zapłaty, zacznij od utworzenia zamówienia. Spowoduje to zainicjowanie transakcji w systemie oraz zdefiniowanie informacji o kliencie, sprzedawcy i transakcji niezbędnych do przetworzenia płatności.
Dostępny adres URL punktu docelowego:
| Environment | URL | Operation Method & Endpoint | Operation Description |
| PROD | api.sibsgateway.com | POST api/version-id/payments | Tworzy transakcję i przygotowuje ją do przetworzenia płatności. |
| TEST | stargate.qly.site[1|2].sibs.pt | POST api/version-id/payments | Tworzy transakcję w środowisku testowym. |
Proces tworzenia zamówienia obejmuje trzy główne etapy:
Etap 1: Zdefiniowanie nagłówka oraz dodanie danych sprzedawcy i klienta
Etap 2: Dodanie informacji o transakcji do zamówienia
Etap 3: Zakończenie tworzenia zamówienia poprzez wprowadzenie dodatkowych i opcjonalnych ustawień
Etap 1: Zdefiniowanie nagłówka oraz dodanie danych sprzedawcy i klienta
Na tym etapie należy zdefiniować nagłówki wymagane do uwierzytelnienia oraz podać dane sprzedawcy i klienta niezbędne do zainicjowania transakcji.
Dzięki temu API może poprawnie zidentyfikować sprzedawcę, zweryfikować uprawnienia i powiązać kupującego z zamówieniem.
Poniżej znajduje się pełny opis danych wymaganych do rozpoczęcia tworzenia zamówienia.
Parametry nagłówka
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| string | Mandatory | Określa typ zawartości żądania. | application/json |
| string | Mandatory | Token typu „Bearer” służący do uwierzytelniania. | Bearer xxxxxxxx |
| string | Mandatory | Token identyfikujący organizację klienta, podany podczas rejestracji. | 123456789 |
Parametry żądania
Poniżej przedstawiono podstawowe obiekty wymagane do standardowej integracji procesu realizacji zamówienia typu „serwer-serwer”. Każdy obiekt zawiera główne pola, a dla przejrzystości zagnieżdżone podpola przedstawiono w notacji kropkowej. Metadane opcjonalne zgrupowano, aby uniknąć powtórzeń.
| Field | Type | Condition | Description |
|---|---|---|---|
| object | Mandatory | Dane sprzedawcy. Element opcjonalny służący do sprawdzania statusu transakcji. |
| object | Mandatory | Dane klienta. |
| object | Mandatory | Szczegóły transakcji (kwota, metoda, znacznik czasu). |
| object | Mandatory | Urządzenie klienta i dodatkowe informacje. |
| array of key-value | Optional | Pary klucz-wartość zawierające dodatkowe informacje o sprzedawcy. |
| Array | Optional | Dodatkowe metadane klienta w formacie klucz-wartość. |
1. Merchant (object) – Mandatory
Dane akceptanta są niezbędne do identyfikacji i realizacji transakcji.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
merchant | object | Mandatory | Kontener obiektów akceptanta. | – |
merchant.terminalID | numeric (≤10) | Mandatory | Identyfikator terminala merchanta | 24 |
merchant.channel | string | Mandatory | Kanał merchanta | Web |
merchant.merchantTransactionID | string (≤1000) | Mandatory | Unikalny identyfikator transakcji | Order_20260219_001 |
merchant.transactionDescription | String (≤4000) | Optional | Opis transakcji | Payment for order #001 |
merchant.shopURL | string | Optional | Adres URL strony internetowej akceptanta używany do przekierowań związanych z transakcją | https://shop.example.com |
2. Customer (object) – Mandatory
Dane klienta obejmują informacje osobowe, rozliczeniowe i dotyczące wysyłki.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
customer | object | Mandatory | Kontener obiektu klienta | – |
customer.customerInfo | object | Mandatory | Wstępnie zdefiniowane informacje o kliencie | – |
customer.shippingAddress | object | Optional | Adres wysyłki klienta | – |
customer.shippingAddress | object | Optional | Adres rozliczeniowy klienta | – |
customer.billingAddressSameAsShippingAddress | boolean | Optional | Flaga wskazująca, czy adres rozliczeniowy jest taki sam jak adres wysyłki | True |
2.1 Customer Info (subobject) – Mandatory
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
customer.customerInfo.customerName | string | Mandatory | Pełne imię i nazwisko kupującego | Jan Kowalski |
customer.customerInfo.customerEmail | string | Mandatory | Adres e-mail kupującego | jan.kowalski@example.pl |
customer.customerInfo.customerPhone | string (≤16) | Conditional | Numer telefonu w formacie E.164, musi zaczynać się od znaku „+” i zawierać maksymalnie 15 cyfr. Pole obowiązkowe, jeśli metoda płatności to: „MBWY” – „MB Way”. W pozostałych przypadkach pole opcjonalne. | +48500123456 |
customer.customerInfo.customerLanguage | string (ISO 639-1) | Conditional | Pole obowiązkowe, jeśli metoda płatności to: „BNCT” – „Bancontact”; „IDEL” – „iDEAL”; „BIZM” – „Bizum”. W pozostałych przypadkach pole opcjonalne. | PL |
customer.customerInfo.shippingAddress | Address | Mandatory | Adres wysyłki klienta, jeśli dotyczy | – |
customer.customerInfo.billingAddress | Address | Mandatory | Adres rozliczeniowy klienta | – |
customer.customerInfo.billingAddressSameAsAddress | Boolean | Optional | True, jeśli adres rozliczeniowy jest taki sam jak adres wysyłki | True |
2.2 Shipping Address (subobject) – Mandatory when applicable
Stosuje się w przypadku towarów fizycznych.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
customer.shippingAddress.street1 | string (≤70) | Mandatory | Street line 1 | ul. Marszałkowska 10 |
customer.shippingAddress.street2 | string (≤70) | Optional | Street line 2 | Apartment 5 |
customer.shippingAddress.city | string (≤35) | Mandatory | City / town | Warszawa |
customer.shippingAddress.postcode | string (≤16) | Mandatory | Postal code | 00-001 |
customer.shippingAddress.countrySubDivision | string (≤35, ISO 3166-1 Alpha 2) | Optional | State / Province code | PL |
customer.shippingAddress.country | string (ISO 3166-1 Alpha 2) | Mandatory | Country code | PL |
2.3 Billing Address (subobject) – Optional
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
customer.billingAddress.street1 | string (≤70) | Mandatory | Street line 1 | ul. Marszałkowska 10 |
customer.billingAddress.street2 | string (≤70) | Optional | Street line 2 | – |
customer.billingAddress.city | string (≤35) | Mandatory | City / town | Warszawa |
customer.billingAddress.postcode | string (≤16) | Mandatory | Postal code | 00-001 |
customer.billingAddress.countrySubDivision | string (≤35, ISO 3166-1 Alpha 2) | Optional | State / Province code | PL |
customer.billingAddress.country | string | Conditional | Billing country code (ISO 3166-1 Alpha 2) | PL |
3. Info (object) – Mandatory
Dodatkowe informacje kontekstowe dotyczące transakcji, w tym dane dotyczące urządzenia.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
info | object | Mandatory | Additional contextual information about the transaction. | – |
info.deviceInfo | object | Mandatory | Customer device information. | – |
3.1 Device Info (subobject) – Mandatory
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
info.deviceInfo.browserAcceptHeader | string | Optional | Browser Accept Header | text/html |
info.deviceInfo.browserJavaEnabled | string | Optional | Browser Java Enabled | True |
info.deviceInfo.browserJavascriptEnabled | string | Optional | Browser Javascript Enabled | True |
info.deviceInfo.browserLanguage | string | Optional | Browser Language | en-US |
info.deviceInfo.browserColorDepth | string | Optional | Browser Color Depth | 24 |
info.deviceInfo.browserScreenHeight | string | Optional | Browser Screen Height | 1080 |
info.deviceInfo.browserScreenWidth | string | Optional | Browser Screen Width | 1920 |
info.deviceInfo.browserTZ | string | Optional | Browser Time Zone | GMT+1 |
info.deviceInfo.browserUserAgent | string | Optional | Browser User Agent | Mozilla/5.0 |
info.deviceInfo.systemFamily | string | Optional | System Family | Windows |
info.deviceInfo.systemVersion | string | Optional | System Version | 10 |
info.deviceInfo.systemArchitecture | string | Optional | System Architecture | x64 |
info.deviceInfo.deviceManufacturer | string | Optional | Device Manufacturer | Dell |
info.deviceInfo.deviceModel | string | Optional | Device Model | XPS 15 |
info.deviceInfo.deviceID | string | Optional | Device Unique ID | 12345-6789 |
info.deviceInfo.applicationName | string | Optional | Application Name Note: Form must fill this field with „Form:applcationName”. | Form:Edge |
info.deviceInfo.applicationVersion | string | Optional | Application Version Note: Form must fill this field with „formVersion:applicationVersion”. | 2.0:130 |
info.deviceInfo.geoLocalization | string | Optional | Geolocation | 52.2297,21.0122 |
info.deviceInfo.ipAddress | string | Optional | IP Address | 192.168.1.1 |
Optional Generic Extension Fields
Poniższe pola umożliwiają sprzedawcom podawanie dodatkowych metadanych kontekstowych lub niestandardowych, które nie są uwzględnione w podstawowym schemacie. Pola te są opcjonalne i mogą służyć do rozszerzania informacji o transakcji lub kliencie w elastycznej strukturze typu klucz-wartość.
extendedInfo (object) – Optional
Ogólne dane typu klucz-wartość związane z transakcją.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
extendedInfo | Array of key-value | Optional | Pole na dodatkowe informacje o sprzedawcy | extendedInfo |
extendedInfo.key | string | Mandatory | Klucz właściwości rozszerzenia. | loyaltyId |
extendedInfo.value | string | Mandatory | Wartość właściwości rozszerzenia. | LTY-998877 |
customerInfo (subobject) – Optional
Dodatkowe metadane dotyczące klientów podane w postaci par klucz-wartość.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
customerInfo | Array of key-value | Optional | Container for additional. | – |
customerInfo.key | string | Mandatory | Klucz metadanych klienta. | internalSegment |
customerInfo .value | string | Mandatory | Wartość metadanych klienta. | VIP |
Action 2: Add Transaction Information
Ta operacja definiuje samą transakcję, w tym kwotę, metodę płatności, znacznik czasu oraz inne atrybuty niezbędne do prawidłowego przetworzenia płatności.
Teraz nadszedł czas, aby wprowadzić informacje o transakcji w oparciu o metody płatności, które chcesz udostępnić w swoim systemie paywall.
transaction (object) – Mandatory
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
transaction | object | Mandatory | Szczegóły transakcji (kwota, metoda, sygnatura czasowa). | – |
transaction.transactionTimeStamp | ISODateTime | Mandatory | Sygnatura czasowa utworzenia transakcji | 2026-02-19T15:00:00.000Z |
transaction.description | string (≤100) | Optional | Krótki opis transakcji | Payment for Order #20260220 |
transaction.moto | boolean | Mandatory | Wskazuje, czy transakcja jest transakcją typu Mail Order / Telephone Order (MOTO). | False |
transaction.paymentType | string | Mandatory | Rodzaj płatności. Dopuszczalne wartości: „PURS” – Zakup „AUTH” – Autoryzacja | PURS (Purchase) |
transaction.paymentMethod | array | Mandatory | Możliwe wartości to: „CARD” – Karta „TOKEN” – Token „PAY_BY_LINK” – Płatność przez link „BLIK” – BLIK „XPAY” – xPay „IDEL” – Ideal „BNCT” – Bancontact „SPDD” – Polecenie zapłaty SEPA „CRTB” – Cartes Bancaires „MBWY” – MB WAY „BIZM” – Bizum | [„CARD”,”BLIK”,”TOKEN”] |
transaction.amount | object | Mandatory | Obiekt kwoty zawierający wartość transakcji i walutę | – |
Amount (object) – Mandatory
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
transaction.amount | object | Mandatory | Kwota transakcji i waluta | – |
transaction.amount.value | double | Mandatory | Kwota transakcji | 50.5 |
transaction.amount.currency | string | Mandatory | Waluta ISO 4217 | PLN |
Etap 3: Dodatkowa konfiguracja
W tym kroku pokażemy Ci, że istnieje wiele opcjonalnych informacji, które możesz podać, aby sfinalizować tworzenie zamówienia. Poniżej znajdziesz dodatkowe informacje dotyczące różnych scenariuszy:
Konfiguracja 3D Secure
Autoryzacja płatności z uwierzytelnieniem 3D Secure (bezpośrednia lub z weryfikacją).
Zapisz kartę
Zapisuj dane klientów i realizuj płatności cykliczne oraz opłaty abonamentowe.
Skorzystaj z karty OneClick
Wprowadź najbardziej płynny i szybki sposób przyjmowania płatności.
Konfiguracja webhooków
Dbaj o to, by Twój system był na bieżąco informowany o zdarzeniach związanych z płatn
Oto przykład, jak złożyć zamówienie:
Request body:
</> JSON
{
"merchant": {
"terminalId": 47215,
"channel": "web",
"merchantTransactionId": "ORDER_20260309_001",
"transactionDescription": "Payment for order #1001",
"shopURL": "https://shop.example.com"
},
"customer": {
"customerInfo": {
"customerName": "Jan Kowalski",
"customerEmail": "jan.kowalski@example.com",
"customerPhone": "+48500123456",
"customerLanguage": "PL"
},
"shippingAddress": {
"street1": "Marszalkowska 10",
"street2": "Apartment 5",
"city": "Warsaw",
"postcode": "00-001",
"countrySubDivision": "PL",
"country": "PL"
},
"billingAddressSameAsShippingAddress": true
},
"transaction": {
"transactionTimestamp": "2026-03-09T14:30:00.000Z",
"description": "Order payment",
"moto": false,
"paymentType": "PURS",
"paymentMethod": [
"CARD",
"BLIK"
],
"amount": {
"value": 50.50,
"currency": "EUR"
}
},
"info": {
"deviceInfo": {
"browserAcceptHeader": "text/html",
"browserJavaEnabled": "true",
"browserJavascriptEnabled": "true",
"browserLanguage": "en-US",
"browserColorDepth": "24",
"browserScreenHeight": "1080",
"browserScreenWidth": "1920",
"browserTZ": "GMT+1",
"browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
"systemFamily": "Windows",
"systemVersion": "10",
"systemArchitecture": "x64",
"deviceManufacturer": "Dell",
"deviceModel": "XPS 15",
"deviceID": "12345-67890",
"applicationName": "MyShopCheckout",
"applicationVersion": "1.0",
"geoLocalization": "52.2297,21.0122",
"ipAddress": "192.168.1.10"
}
},
"extendedInfo": [
{
"key": "loyaltyId",
"value": "LTY-998877"
}
]
}
Krok 2: Pobierz odpowiedź
Po wysłaniu żądania POST /api/{version-id}/payments bramka SIBS zwraca uporządkowaną odpowiedź w formacie JSON zawierającą status transakcji, szczegóły techniczne realizacji, dostępne metody płatności oraz elementy zabezpieczeń.
Na tym etapie Twój backend powinien:
- Zweryfikować status przetwarzania
- Zweryfikować transactionSignature
- Zapisać identyfikatory transakcji
- Przygotować proces realizacji transakcji w interfejsie użytkownika zgodnie z otrzymanymi danymi
Parametry odpowiedzi
Poniższa tabela opisuje główne pola zwracane w odpowiedzi API.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
returnStatus | Object | Mandatory | Obiekt określający status przetworzonej transakcji. | – |
transactionID | string (<=36) | Conditional | Unikalny identyfikator przypisany do transakcji przez bramkę SIBS | 42f59038f3f14e618d091da8bf3b717e9999 |
transactionSignature | string | Conditional | Cyfrowy podpis odpowiedzi na transakcję. Należy zweryfikować ten podpis w systemie zaplecza, aby zapewnić integralność i autentyczność odpowiedzi. | eyJ0eElkIjoiZzB6Q… |
amount | Object | Conditional | Obiekt określający kwotę i walutę transakcji. | – |
merchant | Object | Conditional | Obiekt zawierający dane identyfikacyjne akceptanta oraz dane konfiguracyjne transakcji wymagane do przetworzenia płatności. | – |
actionResponse | Object | Optional | Obiekt zwracany, gdy przed zakończeniem płatności konieczne jest podjęcie dodatkowych działań. | – |
paymentMethodList | Array of string | Mandatory | Lista dostępnych metod płatności dla tego zamówienia. Możliwe wartości to: „CARD” – Card „TOKEN” – Token „PAY_BY_LINK”- Pay by Link „BLIK” – BLIK „XPAY” – xPay „IDEL” – Ideal „BNCT” – Bancontact; „SPDD” – SEPA Direct Debit „CRTB” – Cartes Bancaires „MBWY” – „MB WAY” „BIZM” – „Bizum” | [„CARD”,”BLIK”] |
tokenList | Array of Object | Conditional | Lista tokenów płatniczych dostępnych dla kupującego | – |
expiry | string (ISODateTime) | Mandatory | Data i godzina wygaśnięcia zamówienia. | 2026-02-19T20:30:00Z |
execution | Object | Mandatory | Zawiera techniczne znaczniki czasu związane z przetwarzaniem żądania. | – |
regulationList | Array of Object | Mandatory | Lista przepisów i informacji prawnych mających zastosowanie do usługi. | – |
actionResponse | Object | Optional | Zwracane tylko wtedy, gdy do zakończenia transakcji wymagane jest podjęcie dodatkowego działania. | – |
returnStatus (Object) – Mandatory
Ten obiekt zawiera wynik przetworzonej transakcji.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
returnStatus | Object | Mandatory | Obiekt określający status przetworzonej transakcji. | – |
returnStatus.statusCode | string | Mandatory | Kod statusu transakcji. Wartość „000” oznacza pomyślne zakończenie. Każda inna wartość oznacza błąd. | 000 |
returnStatus.statusMsg | string | Mandatory | Komunikat dotyczący statusu przetworzonej transakcji. | Success |
returnStatus.statusDescription | string | Mandatory | Opis statusu przetworzonej transakcji. | Transaction created successfully |
amount (object) – Conditional
Zwracane, gdy w odpowiedzi znajdują się informacje o kwocie transakcji.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
amount | object | Conditional | Obiekt określający kwotę transakcji i walutę. | – |
amount.value | number (double) | Mandatory | Wartość kwoty transakcji. | 50.5 |
amount.currency | string (ISO 4217 Alpha-3) | Mandatory | Waluta używana w transakcji. | PLN |
merchant (object) – Conditional
Ten obiekt zawiera dane identyfikacyjne sprzedawcy oraz szczegóły konfiguracyjne związane z transakcją.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
merchant | object | Conditional | Obiekt zawierający dane identyfikacyjne akceptanta oraz dane konfiguracyjne transakcji niezbędne do przetworzenia płatności. | – |
merchant.terminalId | string (<=10) | Mandatory | Identyfikator terminala akceptanta. | 47215 |
merchant.channel | string | Mandatory | Kanał akceptanta | Web |
merchant.merchantTransactionId | string (<=36) | Mandatory | Unikalny identyfikator transakcji używany i podawany przez akceptanta. | Order_20260219_001 |
merchant.websiteAddress | string | Mandatory | Adres URL strony internetowej akceptanta. Adres strony internetowej akceptanta skonfigurowany podczas rejestracji (konfiguracja akceptanta). Ta wartość jest statyczna i nie zmienia się w zależności od transakcji. | myshop.pl |
merchant.shopURL | string | Optional | Adres URL akceptanta używany do przekierowań podczas przebiegu transakcji. Jeśli zostanie zwrócony, odzwierciedla wartość pierwotnie podaną w żądaniu. | https://myshop.pl/status |
execution (object) – Mandatory
Techniczne znaczniki czasu wskazujące, kiedy rozpoczęło się wysyłanie żądania i kiedy wygenerowano odpowiedź.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
execution | object | Mandatory | Zawiera techniczne znaczniki czasu związane z przetwarzaniem żądania. | – |
execution.startTime | string (ISODateTime) | Yes | Czas, w którym interfejs API przyjął żądanie. | 2026-02-19T13:41:01.626Z |
execution.endTime | string (ISODateTime) | Yes | Czas, w którym interfejs API udzielił odpowiedzi na żądanie. | 2026-02-19T13:41:02.105Z |
regulationList (object) – Mandatory
Ten obiekt zawiera informacje dotyczące przepisów i zgodności, które muszą zostać przedstawione klientowi w zależności od konfiguracji usługi.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
regulationList | Array of Object | Mandatory | Wykaz przepisów i informacji prawnych mających zastosowanie do usługi. | – |
regulationList.identification | string | Mandatory | Unikalny identyfikator elementu regulacyjnego skonfigurowanego dla usługi. | REG_001 |
regulationList.type | string (RegulationType) | Mandatory | Typ elementu regulacyjnego. Możliwe wartości to: ACCEPTANCE – Acceptance statement COMPLAINTS – Complaints information CERTIFICATIONS – Certifications or compliance references ACQUIRER_NAME – Acquirer identification ACCQUIRER_LOGO – Acquirer logo resource VISA_NETWORK_LOGO – Visa network logo MASTERCARD_NETWORK_ LOGO – Mastercard network logo | ACCEPTANCE |
regulationList.language | string (ISO 639-1) | Mandatory | Język powiązany z elementem regulacyjnym. Musi być zgodny z formatem ISO 639-1. | PL |
regulationList.label | string | Optional | Tekst informacyjny powiązany z elementem regulacyjnym. | By proceeding, you accept the terms and conditions. |
regulationList.regulationURL | string | Optional | Warunki skonfigurowane dla Usługi. | https://merchant.com/terms |
regulationList.logoURL | string | Optional | Adres URL zasobu logo powiązanego z elementem regulacyjnym. | https://gateway.com/logo.png |
Response example:
{
"returnStatus": {
"statusCode": "000",
"statusMsg": "SUCCESS",
"statusDescription": "TRANSACTION CREATED SUCCESSFULLY"
},
"transactionID": "42f59038f3f14e618d091da8bf3b717e9999",
"transactionSignature": "eyJ0eElkIjoiZzB6Q...",
"amount": {
"value": 50.50,
"currency": "EUR"
},
"merchant": {
"terminalId": 47215,
"channel": "WEB",
"merchantTransactionId": "ORDER_20260309_001",
"transactionDescription": "PAYMENT FOR ORDER #1001",
"websiteAddress": "MYSHOP.COM",
"shopURL": "HTTPS://MYSHOP.COM/STATUS"
},
"paymentMethodList": ["CARD", "BLIK"],
"tokenList": [],
"expiry": "2026-03-09T20:30:00Z",
"execution": {
"startTime": "2026-03-09T14:30:00.000Z",
"endTime": "2026-03-09T14:30:01.200Z"
},
"regulationList": [
{
"identification": "REG_001",
"type": "ACCEPTANCE",
"language": "PL",
"label": "By proceeding, you accept the terms and conditions.",
"regulationURL": "https://merchant.com/terms",
"logoURL": "https://gateway.com/logo.png"
}
]
}
actionResponse (object) – Optional
W niektórych przypadkach transakcji płatności nie da się zakończyć od razu i konieczne jest wykonanie dodatkowego kroku, zanim będzie znany ostateczny wynik.
W takiej sytuacji API zwraca obiekt actionResponse. Obiekt ten zawiera informacje potrzebne Twojemu backendowi do wykonania kolejnego kroku niezbędnego do kontynuowania procesu płatności.
Dopóki akcja opisana w tym obiekcie nie zostanie wykonana, transakcja pozostanie w stanie oczekującym.
Jeśli akcja nie zostanie wykonana przed upływem czasu ważności zamówienia, transakcja wygaśnie i nie będzie już przetwarzana.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
| actionResponse | object | Optional | Zwracane tylko wtedy, gdy do zakończenia transakcji konieczne jest podjęcie dodatkowego działania. | – |
| actionResponse.data | object | Mandatory | Pole zawierające szczegóły dotyczące dodatkowego działania. | – |
actionResponse.data – Optional
Ten obiekt zawiera informacje techniczne niezbędne do wykonania dodatkowego etapu procesu płatności.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
| actionResponse.data | object | Optional | Pole na szczegóły dodatkowej czynności. | – |
| actionResponse.data.url | string | Optional | Punkt końcowy, do którego należy wysłać żądanie w celu wykonania dodatkowego kroku niezbędnego do sfinalizowania płatności. Transakcja pozostaje w stanie oczekującym do momentu pomyślnego wykonania tego kroku. | – |
| actionResponse.data.params | Array | Optional | Parametry, które należy przesłać podczas wywoływania podanego punktu końcowego w celu wykonania wymaganej dodatkowej czynności. | – |
actionResponse.data.params – Array
Jeśli do wykonania dodatkowej akcji potrzebne są parametry, zostaną one zwrócone w tablicy params.
Każdy element tej tablicy odpowiada parametrowi, który należy uwzględnić w żądaniu wysyłanym do podanego punktu końcowego.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
| actionResponse.data.params | Array | Optional | Lista parametrów wymaganych do wykonania dodatkowej czynności. Każdy wpis jest reprezentowany jako obiekt. | – |
| actionResponse.data.params.parameter | object | Optional | Obiekt reprezentujący pojedynczy parametr wymagany do wykonania dodatkowej czynności. | – |
actionResponse.data.params.parameter (object) – Optional
Każdy obiekt parametru zawiera nazwę parametru oraz wartość, którą należy przesłać podczas wywoływania punktu końcowego akcji.
| Field | Type | Condition | Description | Example |
|---|---|---|---|---|
| actionResponse. params.parameter.name | string | Optional | Nazwa parametru wymagana przez punkt końcowy akcji. | – |
| actionResponse. params.parameter.data | string | Optional | Wartość, którą należy przesłać dla zdefiniowanego powyżej parametru. Treść zależy od żądanej akcji. | – |
actionResponse Example
Poniższy przykład przedstawia komunikat, który wymaga podjęcia dodatkowego działania, zanim będzie można kontynuować płatność.
{
"actionResponse": {
"url": "https://acs.gateway.com/3ds",
"params": [
{
"name": "PaReq",
"value": "eJxVUttygjAQ..."
},
{
"name": "TermUrl",
"value": "https://merchant.com/3ds/callback"
}
]
}
}
HTTP Status Codes
Interfejs API zwraca standardowe kody statusu HTTP wraz ze strukturalnym obiektem returnStatus w treści odpowiedzi.
Sprzedawcy muszą zawsze sprawdzić zarówno kod statusu HTTP, jak i wartość returnStatus.statusCode zanim podejmą dalsze działania.
Odpowiedź zawiera parametr statusMsg który może przyjmować różne wartości:
| Result code | statusMsg | Description | Action |
|---|---|---|---|
| HTTP-200 | Success | Success response | n/a |
| HTTP-400 | Bad Request | The JSON payload does not match the API definition or some mandatory HTTP headers are missing. | Please check in API Market for the correct syntax. |
| HTTP-401 | Unauthorized | On the Authorization, Bearer token is invalid/expired or not associated with the Terminal used. | Please check in SIBS Backoffice under the Credentials if the token is valid and create a new one if needed. |
| HTTP-403 | Forbidden | The ClientID set on the X-IBM-Client-Id HTTP header is not valid or does not possess a valid subscription to the API. | Please check in SIBS Backoffice under the SPG APP 2.0 if the ClientID is correct. If the problem persists, contact SIBS Gateway support for a ClientID reset. |
| HTTP-405 | Method Not Allowed | The HTTP Method used does not match any of the API definitions available. | Please check in API Market for the correct HTTP Method. |
| HTTP-429 | Too Many Requests | The API calls rate limit has been exceeded. | Please check in API Market for information on the rate limits that apply to the API. |
| HTTP-500 | Internal Server Error | The API call has failed… and its most likely on our side. | You should retry the operation, and if the problem persists contact SIBS Gateway support for assistance. |
| HTTP-503 | Service Unavailable | The API call is not currently available. Usually we are always on, but short availability issues may occur during scheduled maintenance. | You should wait and try again later. |
Krok 3: Dokonaj płatności
Po utworzeniu i przesłaniu zamówienia wraz z danymi płatniczymi klienta oraz po wybraniu przez niego metody płatności wymagającej przekierowania należy wysłać żądanie płatności do bramki SIBS Gateway.
Zapoznaj się z instrukcją dotyczącą dokonywania płatności przy użyciu poszczególnych metod płatności:
| Payment Method | Description |
|---|---|
| Karty płatnicze | Akceptuj płatności kartami Visa, Mastercard oraz kartami partnerskimi. Rozwiązanie to sprawdza się w większości sytuacji i obsługuje standardowe procedury autoryzacji. |
| Pay by Link | Umożliwia klientom realizację płatności bezpośrednio z konta bankowego za pomocą bezpiecznego przekierowania. |
| BLIK | Popularna metoda płatności mobilnych w Polsce, umożliwiająca natychmiastowe płatności za pomocą jednorazowego kodu generowanego w aplikacji bankowej. |
| Apple Pay & Google Pay | Portfel cyfrowy do błyskawicznej realizacji transakcji |
| iDEAL | Wero | Metoda płatności bankowej szeroko stosowana w Holandii, umożliwiająca bezpośrednie przelewy między rachunkami. |
| Bancontact | Lokalna metoda płatności w Belgii, powszechnie stosowana do płatności kartowych i powiązanych z kontem bankowym. |
| SEPA Direct Debit | Umożliwia akceptantom pobieranie płatności bezpośrednio z konta bankowego klienta w strefie SEPA. |
| Cartes Bancaires | Francuski krajowy system kartowy, powszechnie stosowany obok międzynarodowych sieci kartowych. |
| MB WAY | Portfel mobilny szeroko stosowany w Portugalii, umożliwiający klientom autoryzację płatności za pomocą numeru telefonu komórkowego i aplikacji. |
| Bizum | Metoda natychmiastowych płatności mobilnych w Hiszpanii, umożliwiająca przelewy między rachunkami bankowymi przy użyciu numeru telefonu. |
