Wykorzystaj nasze API do otrzymywania płatności i stwórz własny formularz płatności, aby uzyskać pełną kontrolę nad wyglądem i doświadczeniem użytkownika na stronie płatności. Postępuj zgodnie z poniższymi instrukcjami, aby rozpocząć przyjmowanie płatności.
Krok 1: Utwórz zamówienie
W tym kroku opisano, jak utworzyć zamówienie, gdy kupujący jest gotowy do zapłaty.
Dostępny docelowy adres URL punktu końcowego (Endpoint):
| Środowisko | URL | Metoda działania i punkt końcowy | Opis operacji |
| PROD | api.sibsgateway.com | POST api/version-id/payments | Wykonuje żądanie przygotowania wymaganych danych checkout’u i zwraca je wraz z formularzem płatności. |
| TEST | stargate-cer.qly.site[1|2].sibs.pt | POST api/version-id/payments | Wykonuje żądanie przygotowania wymaganych danych checkout’u i zwraca je wraz z formularzem płatności. |
Jeśli chodzi o dane wymagane do utworzenia zamówienia, proces jest prosty i wymaga tylko kilku czynności:
Działanie 1: Zdefiniowanie nagłówka i dodanie informacji o sprzedawcy i kliencie
Działanie 2: Dodanie informacji o transakcji do zamówienia
Działanie 3: Wypełnij zamówienie, podając dodatkowe i opcjonalne informacje.
Działanie 1: Zdefiniowanie nagłówka i dodanie informacji o sprzedawcy i kliencie
Sprawdź poniżej pełny opis wymaganych danych, aby rozpocząć tworzenie zamówienia
Parametry nagłówka
Parametry żądania
language code ISO 639-1
Customer language
This element is mandatory if intended payment method is one of the following:
„BNCT” – „Bancontact”;
„GRPY” – „giropay”;
„IDEL” – iDEAL;
„SFRT” – „Sofort”;
“PY24” – “Przelewy24”
address
Customer Address. When applicable used for shipping products.
boolean
Flag to identify if the billing address is the same of shipping address.
Działanie 2: Dodanie informacji o transakcji do zamówienia
Teraz nadszedł czas, aby dołączyć informacje o transakcjach w oparciu o metody płatności, które chcesz wyświetlać w swoim paywallu.
Parametry żądania: application/json
Działanie 3: Wypełnij zamówienie, podając dodatkowe i opcjonalne informacje.
W tym kroku pokazujemy, że istnieje wiele opcjonalnych informacji, które można dodać, aby zakończyć tworzenie zamówienia. Poniżej znajdują się dodatkowe informacje oparte na niektórych przypadkach użycia:
Oto przykład tworzenia zamówienia:
Treść żądania:
{
"merchant": {
"terminalId": 24,
"channel": "web","merchantTransactionId": "Order Id: 9bzraklk4v",
"transactionDescription": "transaction short description",
"shopURL": "https://mytest.e-shop.pl/"
},
"transaction": {
"transactionTimestamp": "2023-05-15T20:11:11.488Z",
"description": "transaction statement description",
"moto": false,
"paymentType": "PURS",
"amount": {
"value": 50.5,
"currency": "PLN"
},
"paymentMethod": [
"CARD",
"BLIK",
"PBLKV"
]
}
}Krok 2: Uzyskanie odpowiedzi
Odpowiedź zawieta statusMsg, transactionID, transactionSignature listę dostępnych paymentMethodList które można wyświetlić.
Przykład odpowiedzi:
{
"returnStatus": {
"statusCode": "000",
"statusMsg": "Success",
"statusDescription": "string"
},
"transactionID": "42f59038f3f14e618d091da8bf3b717e9999",
"transactionSignature": "42f59038f3f14e618d091da8bf3b717e9999",
"amount": {
"value": 50.50,
"currency": "PLN"
},
"merchant": {
"terminalId": 47215,
"channel": "web",
"merchantTransactionId": "5351136",
"transactionDescription": "string",
"shopURL": "string",
"websiteAddress": "string"
},
"paymentMethodList": "",
"tokenList": []
}Odpowiedź zawiera statusMsg które mogą przyjmować różne wartości:
| Kod wyniku | statusMsg | Opis | Akcja |
|---|---|---|---|
| HTTP-200 | Sukces | Odpowiedź sukcesu | n/a |
| HTTP-400 | Zła prośba | Ładunek JSON nie jest zgodny z definicją API lub brakuje niektórych obowiązkowych nagłówków HTTP. | Sprawdź w API Market poprawną składnię. |
| HTTP-401 | Nieautoryzowany | W przypadku Autoryzacji token okaziciela jest nieprawidłowy/wygasł lub nie jest powiązany z używanym terminalem. | Sprawdź w SIBS Backoffice w sekcji Poświadczenia, czy token jest ważny i w razie potrzeby utwórz nowy. |
| HTTP-403 | Zabroniony | Identyfikator klienta ustawiony w nagłówku HTTP X-IBM-Client-Id jest nieprawidłowy lub nie posiada ważnej subskrypcji interfejsu API. | Sprawdź w SIBS Backoffice w SPG APP 2.0, czy ClientID jest poprawny. Jeśli problem będzie się powtarzał, skontaktuj się z pomocą techniczną SIBS Gateway w celu zresetowania ClientID. |
| HTTP-405 | Niedozwolona metoda | Zastosowana metoda HTTP nie jest zgodna z żadną dostępną definicją API. | Sprawdź w API Market poprawną metodę HTTP. |
| HTTP-429 | Zbyt dużo zapytań | Przekroczono limit szybkości wywołań API. | Informacje na temat limitów stawek mających zastosowanie do API można znaleźć w API Market. |
| HTTP-500 | Wewnętrzny błąd serwera | Wywołanie API nie powiodło się… i najprawdopodobniej jest to po naszej stronie. | Powinieneś ponowić operację, a jeśli problem będzie się powtarzał, skontaktuj się z pomocą techniczną SIBS Gateway w celu uzyskania pomocy. |
| HTTP-503 | serwis niedostępny | Wywołanie API nie jest obecnie dostępne. Zwykle jesteśmy zawsze aktywni, ale podczas planowej konserwacji mogą wystąpić krótkie problemy z dostępnością. | Powinieneś poczekać i spróbować ponownie później. |
Krok 3: Zrób płatność
Po utworzeniu i przesłaniu zamówienia z danymi płatności kupującego, który zdecyduje się zapłacić za pomocą metody płatności wymagającej przekierowania, należy złożyć wniosek o płatność do SIBS Gateway.
Sprawdź instrukcje dotyczące dokonywania płatności za pomocą każdego rodzaju metody płatności: