Na tej stronie znajdują się informacje o interfejsach API umożliwiających tworzenie i usuwanie terminala.
Utwórz terminal
Aby móc wykonywać inne operacje sklepu i terminala, proszę sprawdzić poniżej dostępne punkty końcowe środowiska:”
| Środowisko | URL | Metoda działania i endpointy | Opis działania |
|---|---|---|---|
| PROD | api.sibsgateway.com | POST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/terminal | utwórz zasób Merchant Establishment Terminal |
| CER | stargate-cer.qly.site1.sibs.pt | POST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/terminal | utwórz zasób Merchant Establishment Terminal |
| Sandbox | sandbox.sibsgateway.com | POST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/terminal | utwórz zasób Merchant Establishment Terminal |
Musisz wykonać żadanie POST z nasępującymi danymi:
Patametry
| Parametr | Typ | Stan | Required | Opis |
|---|---|---|---|---|
| Typ zawartości | Ciąg | Wymagane | Nagłowek | application/json |
| Merchant-ID | Ciąg | Wymagane | Ścieżka | Merchant ID |
| Shop-ID | Ciąg | Wymagane | Ścieżka | Establishment ID |
| X-Request-ID | Ciąg | Wymagane | Nagłowek | Żadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą. |
| x-ibm-client-id | Ciąg | Wymagane | Nagłowek | Token identyfikujący organizację klienta. It is provided during onboarding process and must be used in every call |
Po wysłaniu żądania API odpowie jednym z dwóch kodów statusu:
| Kod statusu | Wiadomość | TransactionStatus |
|---|---|---|
| 000 | Sukces | “ACT” (Accepted Technical Validation) |
| 999 | Nieoczekiwany błąd | “RJT” (Rejected) |
Więcej informacji na temat komunikatów o błędach znajdziesz na stronie Onboarding API > Sprzedawca, w sekcji Obsługa błędów.
Usuń terminal
Aby anulować istniejący terminal, możesz wykonać operację DELETE. W tym celu wykorzystaj następujące punkty końcowe:
| Środowisko | URL | Metoda działania i punkt końcowy | Opis |
|---|---|---|---|
| PROD | api.sibsgateway.com | DELETE /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/teminal | Usuń zasób terminala |
| CER | stargate-cer.qly.site1.sibs.pt | DELETE /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/teminal | Usuń zasób terminala |
| Sandbox | sandbox.sibsgateway.com | DELETE /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/teminal | Usuń zasób terminala |
Należy wykonać żądanie CANCEL z następującymi danymi:
Header and Path Parameters
| Parametr | Typ | Stan | Wymagane | Opis |
|---|---|---|---|---|
| Content-type | String | Wymagany | Nagłówek | aplikacja/json |
| Merchant-ID | String | Wymagany | Ścieżka | ID sprzedawcy (wymagane w ścieżce) |
| Shop-ID | String | Wymagany | Ścieżka | Identyfikator placówki (wymagany w ścieżce) |
| Terminal-id | String | Wymagany | Ścieżka | ID terminala (wymagane w ścieżce) |
| X-Request-ID | String | Wymagany | Nagłówek | Identyfikator żądania, unikalny dla połączenia, ustalony przez stronę inicjującą |
| x-ibm-client-id | String | Wymagany | Nagłówek | Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu |
Po wysłaniu żądania API odpowie jednym z dwóch kodów statusu:
| Kod Statusu | Wiadomość | TransactionStatus |
|---|---|---|
| 000 | Sukces | “ACT” (Accepted Technical Validation) |
| 999 | Nieoczekiwany Błąd | “RJT” (Rejected) |