Skip to content
Menu

Operacje API

W tej sekcji zagłębimy się w operacje webhook API (FULL CODE), obejmujące procesy tworzenia webhooków, pobierania listy webhooków i aktualizacji webhooków, obejmujące różne aspekty, takie jak metoda operacji, punkt końcowy (endpoint) i szczegóły żądania.

Utwórz webhook

W tym segmencie zbadamy proces tworzenia webhooków, przedstawiając niezbędne kroki, parametry i szczegóły uwierzytelniania.

Punkty końcowe:
OperacjeTyp operacjiMetoda działania i punkt końcowyOpis operacji
Tworzenie żądania WebhookPołączeniePOST version-id/acquirers/{acquirer-id}/merchants/{merchant-id}/terminal/webhookSkonfiguruj zasób tworzenia elementu Webhook.

Poniższa tabela przedstawia szczegóły wymagane do zainicjowania operacji Utwórz Webhook:

LokalizacjaElement danychTypStanOpis
Ścieżkaacquirer-idMax25NumericTextObowiązkoweKod nabywcy
Ścieżkamerchant-idMax10NumericTextObowiązkoweKod nabywcy
Parametr zapytaniaacceptorIdMax10NumericTextOpcjonalnieKod nabywcy
Parametr zapytaniaterminalIdMax10NumericTextOpcjonalnieKod terminala (Terminal Code)
Parametry nagłówka:
Element danychTypStanOpis
Content-TypeStringObowiązkoweapplication/json
AutoryzacjaStringObowiązkoweToken okaziciela. Na podstawie uwierzytelniania OAuth2 przeprowadzonego w kroku wstępnym.
x-ibm-client-idStringObowiązkoweToken identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu.
TPP-Request-IDStringObowiązkoweIdentyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą.
User-IDStringObowiązkoweIdentyfikacja użytkownika odpowiedzialnego za żądanie (wymagana do celów audytu).
User-Organization-IDStringObowiązkoweIdentyfikacja organizacji odpowiedzialnej za wniosek (wymagana do celów audytu).
Parametry żądania:
LokalizacjaElement danychTypStanOpis
Treść żądanianotificationConfigurationCodeMax35TextObowiązkoweUUID konfiguracji powiadomienia
Treść żądaniarequestOperationTypeMax3TextObowiązkoweKod typu operacji żądania
Enum:
INS – Wstaw
DEL – Usuń
Ustaw za pomocą 'INS’.
Treść żądaniapaymentMethodsMetody płatnościObowiązkoweSzereg metod płatności
Request Body.paymentMethodspaymentMethodNotificationCodeMax15TextObowiązkoweKod typu powiadomienia o metodzie płatności
Enum:
MBWY-’MB WAY’
CARD-’Card Payments’
BLIK-’BLIK’
PYBL-’Pay By Link – Blue Media’
XPAY-’XPAY Payments’ 
BNCT-’Bancontact’
IDEL-’Ideal’
Treść żądaniachannelTypeNotificationTyp kanału Powiadomienie ObowiązkoweZawiera wszystkie dane związane z powiadomieniem o typie kanału.
Treść żądania.channelTypeNotificationnotificationTypeMax5TextObowiązkoweKod typu powiadomienia
Enum:
EMAIL
URL
Treść żądania.channelTypeNotificationwartośćMax2048TextObowiązkoweWartość powiadomienia (email or URL)
Treść żądania.channelTypeNotificationbezpieczeństwoBezpieczeństwoWarunkowyObejmuje on wszystkie dane związane z bezpieczeństwem.
Ta struktura (i wszystkie powiązane elementy danych) powinna być prezentowana tylko wtedy, gdy wartość kodu typu powiadomienia to „URL”.
Treść żądania.channelTypeNotification.securitykluczMax32Text (Base64)WarunkowyKlucz bezpieczeństwa (tajny).
Treść żądania.channelTypeNotification.securitysupportEmailMax256TextWarunkowyE-mail wsparcia.
Treść żądania.channelTypeNotification.securityalgorytmMax70TextWarunkowyAlgorytm
Ustawienie 'AES-256-GCM’.

W tym miejscu można przejrzeć strukturę odpowiedzi wynikającą z operacji Utwórz Webhook :

LokalizacjaElement danychTypStanOpis
Nagłówek odpowiedziTPP-Request-IDUUIDObowiązkoweIdentyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą.
Treść odpowiedzitransactionStatusStatus transakcjiObowiązkoweStatus transakcji
Możliwe wartości to „ACTC-Accepted Technical Validation” i „RJCT-Rejected”.
Treść odpowiedzi returnStatusStatus zwrotuObowiązkowe
Treść odpowiedzi.returnStatusstatusCodeKod wiadomości Obowiązkowe„000” oznacza sukces. Wartości różne od „000” oznaczają błędy.
Treść odpowiedzi.returnStatusstatusMsgTyp wiadomościObowiązkoweKomunikat o wynikach.
Treść odpowiedzi.returnStatusstatusDescriptionMax512TextObowiązkoweDodatkowy tekst wyjaśniający.

Pobierz listę webhooków

W tej sekcji przedstawiamy szczegółowe informacje na temat operacji Pobierz listę Webhooków, obejmujące metodę operacji, Punkt końcowy (Endpoint) i elementy niezbędne do pobrania listy webhooków, wraz ze strukturami żądania i odpowiedzi API (FULL CODE) w celach informacyjnych.

OperacjeTyp operacjiMetoda działania i punkt końcowyOpis operacji
Żądanie 'Pobierz listę webhooków’PołączeniePOST version-id/webhooksPobierz listę webhooków.

Poniższa tabela przedstawia wymagane elementy danych i ich warunki inicjowania żądania.

Parametry nagłówka:
LokalizacjaElement danychTypStanOpis
Nagłówek żądaniaContent-TypeStringObowiązkoweapplication/json
Nagłówek żądaniaAutoryzacjaStringObowiązkoweToken okaziciela. Na podstawie uwierzytelniania OAuth2 przeprowadzonego w kroku wstępnym.
Nagłówek żądaniax-ibm-client-idStringObowiązkoweToken identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu.
Nagłówek żądaniaTPP-Request-IDUUIDObowiązkoweIdentyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą.
Nagłówek żądania User-IDStringObowiązkoweIdentyfikacja użytkownika odpowiedzialnego za żądanie (wymagana do celów audytu).
Nagłówek żądaniaUser-Organization-IDStringObowiązkoweIdentyfikacja organizacji odpowiedzialnej za wniosek (wymagana do celów audytu).
Parametry żądania:
LokalizacjaElement danychTypStanOpis
Treść żądaniaacquirerIdMax25NumericTextObowiązkoweKod nabywcy
Treść żądaniamerchantIdMax10NumericTextObowiązkoweKod sprzedawcy
Treść żądaniaacceptorIdMax10NumericTextOpcjonalnieKod akceptora
Treść żądaniaterminalIdMax10NumericTextOpcjonalnieKod terminala (Terminal Code)

Tabela przedstawia oczekiwane elementy odpowiedzi:

LokalizacjaElement danychTypStanOpis
Nagłówek odpowiedziTPP-Request-IDUUIDObowiązkoweIdentyfikator odpowiedzi, unikalny dla połączenia, określony przez stronę inicjującą.
Treść odpowiedzitransactionStatusStatus transakcjiObowiązkoweStatus transakcji
Możliwe wartości to „ACTC-Accepted Technical Validation” i „RJCT-Rejected”.
Treść odpowiedzi returnStatusStatus zwrotuObowiązkowe
Treść odpowiedzi.returnStatusstatusCodeStatus transakcji. Obowiązkowe„000” oznacza sukces. Wartości różne od „000” oznaczają błędy.
Treść odpowiedzi.returnStatusstatusMsgTyp wiadomościObowiązkoweKomunikat o wynikach.
Treść odpowiedzi.returnStatusstatusDescriptionMax512TextObowiązkoweDodatkowy tekst wyjaśniający.
Treść odpowiedziwebhooksTablica webhookówWarunkowyLista danych szczegółowych zasobu webhook.
Występuje tylko w odpowiedziach pomyślnych.
Response Body.webhookswebhookWebhookObowiązkoweTablica webhooków
Response Body.webhooks.webhooknotificationConfigurationCodeMax36TextObowiązkoweUUID konfiguracji powiadomienia
Treść odpowiedzipaymentMethodsmetody płatnościObowiązkoweSzereg metod płatności
Response Body.paymentMethodspaymentMethodNotificationCodeMax15TextObowiązkoweKod typu powiadomienia o metodzie płatności
Enum:
CARD-’Płatności kartą’
PYBL-’Pay By Link – Blue Media’
PLKV-’Pay By Link – kevin’
BLIK-’BLIK’
XPAY-’XPAY Payments’
BNPL-’Buy Now Pay Later -Paywerk’
BNCT-’Bancontact’
IDEL-’Ideal’
Response Body.webhooks.webhookchannelTypeNotificationTyp kanału Powiadomienie ObowiązkoweZawiera wszystkie dane związane z powiadomieniem o typie kanału.
Response Body.webhooks.webhook.channelTypeNotificationnotificationTypeMax5TextObowiązkoweKod typu powiadomienia
Enum:
EMAIL
URL
Response Body.webhooks.webhook.channelTypeNotificationwartośćMax2048TextObowiązkoweWartość powiadomienia (email or URL).
Response Body.webhooks.webhook.channelTypeNotificationbezpieczeństwoBezpieczeństwoWarunkowyObejmuje on wszystkie dane związane z bezpieczeństwem.
Ta struktura (i wszystkie powiązane elementy danych) powinna być prezentowana tylko wtedy, gdy wartość kodu typu powiadomienia to „URL”.
Response Body.webhooks.webhook.channelTypeNotification.securitykluczMax32Text (Base64)WarunkowyKlucz bezpieczeństwa (tajny).
Response Body.webhooks.webhook.channelTypeNotification.securitysupportEmailMax256TextWarunkowyE-mail wsparcia.
Response Body.webhooks.webhook.channelTypeNotification.securityalgorytmMax70TextWarunkowyAlgorytm.

Aktualizacja webhooków

Tutaj omawiamy metodę operacji, Punkt końcowy (Endpoint) i odpowiednie elementy wymagane do modyfikacji zasobu webhook. Obejmuje to omówienie struktur żądań i odpowiedzi API (FULL CODE) w celach informacyjnych.

OperacjeTyp operacjiMetoda działania i punkt końcowyOpis operacji
Żądanie aktualizacji WebhookPołączeniePUT version-id/acquirers/{acquirer-id}/merchants/{merchant-id}/terminal/webhookAktualizacja zasobu Webhook.

Poniższa tabela przedstawia podstawowe elementy niezbędne do zainicjowania żądania Aktualizacja Webhook:

LokalizacjaElement danychTypStanOpis
Ścieżkaacquirer-idMax25NumericTextObowiązkoweKod nabywcy
Ścieżkamerchant-idMax10NumericTextObowiązkoweKod sprzedawcy
Parametr zapytaniaacceptorIdMax10NumericTextOpcjonalnieKod akceptanta w programie Merchant
Parametr zapytaniaterminalIdMax10NumericTextOpcjonalnieKod terminala (Terminal Code).
Parametry nagłówka:
LokalizacjaElement danychTypStanOpis
Nagłówek żądaniaContent-TypeStringObowiązkoweapplication/json
Nagłówek żądaniaAutoryzacjaStringObowiązkoweToken okaziciela. Na podstawie uwierzytelniania OAuth2 przeprowadzonego w kroku wstępnym.
Nagłówek żądaniax-ibm-client-idStringObowiązkoweToken identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu.
Nagłówek żądaniaTPP-Request-IDUUIDObowiązkoweIdentyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą.
Nagłówek żądaniaUser-IDStringObowiązkoweIdentyfikacja użytkownika odpowiedzialnego za żądanie (wymagana do celów audytu).
Nagłówek żądaniaUser-Organization-IDStringObowiązkoweIdentyfikacja organizacji odpowiedzialnej za wniosek (wymagana do celów audytu).
Parametry żądania:
LokalizacjaElement danychTypStanOpis
Treść żądanianotificationConfigurationCodeMax35TextObowiązkoweUUID konfiguracji powiadomienia
Treść żądaniarequestOperationTypeMax3TextObowiązkoweKod typu operacji żądania
Enum:
INS – Wstaw
DEL – Usuń
Ustaw za pomocą 'INS’.
Treść żądaniapaymentMethodsmetody płatnościObowiązkoweSzereg metod płatności
Request Body.paymentMethodspaymentMethodNotificationCodeMax15TextObowiązkoweKod typu powiadomienia o metodzie płatności
Enum:
MBWY-’MB WAY’
CARD-’Card Payments’
BLIK-’BLIK’
PYBL-’Pay By Link – Blue Media’
XPAY-’XPAY Payments’ 
BNCT-’Bancontact’
IDEL-’Ideal’
Treść żądaniachannelTypeNotificationTyp kanału Powiadomienie ObowiązkoweZawiera wszystkie dane związane z powiadomieniem o typie kanału.
Treść żądania.channelTypeNotificationnotificationTypeMax5TextObowiązkoweKod typu powiadomienia
Enum:
EMAIL
URL
Treść żądania.channelTypeNotificationwartośćMax2048TextObowiązkoweWartość powiadomienia (email or URL)
Treść żądania.channelTypeNotificationbezpieczeństwoBezpieczeństwoWarunkowyObejmuje on wszystkie dane związane z bezpieczeństwem.
Ta struktura (i wszystkie powiązane elementy danych) powinna być prezentowana tylko wtedy, gdy wartość kodu typu powiadomienia to „URL”.
Treść żądania.channelTypeNotification.securitykluczMax32TextWarunkowyKlucz bezpieczeństwa (tajny).
Treść żądania.channelTypeNotification.securitysupportEmailMax256TextWarunkowyE-mail wsparcia.
Treść żądania.channelTypeNotification.securityalgorytmMax70TextWarunkowyAlgorytm
Ustawienie 'AES-256-GCM’.

Tabela przedstawia komponenty odpowiedzi dla operacji Aktualizacja Webhook:

LokalizacjaElement danychTypStanOpis
Nagłówek odpowiedziTPP-Request-IDUUIDObowiązkoweIdentyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą.
Treść odpowiedzitransactionStatusStatus transakcjiObowiązkoweStatus transakcji
Możliwe wartości to „ACTC-Accepted Technical Validation” i „RJCT-Rejected”.
Treść odpowiedzi returnStatusStatus zwrotuObowiązkowe
Treść odpowiedzi.returnStatusstatusCodeKod wiadomościObowiązkowe„000” oznacza sukces. Wartości różne od „000” oznaczają błędy.
Treść odpowiedzi.returnStatusstatusMsgTyp wiadomościObowiązkoweKomunikat o wynikach.
Treść odpowiedzi.returnStatusstatusDescriptionMax512TextObowiązkoweDodatkowy tekst wyjaśniający.
Przegląd prywatności

Ta strona korzysta z ciasteczek, aby zapewnić Ci najlepszą możliwą obsługę. Informacje o ciasteczkach są przechowywane w przeglądarce i wykonują funkcje takie jak rozpoznawanie Cię po powrocie na naszą stronę internetową i pomaganie naszemu zespołowi w zrozumieniu, które sekcje witryny są dla Ciebie najbardziej interesujące i przydatne.

Ściśle niezbędne ciasteczka

Niezbędne ciasteczka powinny być zawsze włączone, abyśmy mogli zapisać twoje preferencje dotyczące ustawień ciasteczek.

Jeśli wyłączysz to ciasteczko, nie będziemy mogli zapisać twoich preferencji. Oznacza to, że za każdym razem, gdy odwiedzasz tę stronę, musisz ponownie włączyć lub wyłączyć ciasteczka.