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:
| Operacje | Typ operacji | Metoda działania i punkt końcowy | Opis operacji |
|---|---|---|---|
| Tworzenie żądania Webhook | Połączenie | POST version-id/acquirers/{acquirer-id}/merchants/{merchant-id}/terminal/webhook | Skonfiguruj zasób tworzenia elementu Webhook. |
Poniższa tabela przedstawia szczegóły wymagane do zainicjowania operacji Utwórz Webhook:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Ścieżka | acquirer-id | Max25NumericText | Obowiązkowe | Kod nabywcy |
| Ścieżka | merchant-id | Max10NumericText | Obowiązkowe | Kod nabywcy |
| Parametr zapytania | acceptorId | Max10NumericText | Opcjonalnie | Kod nabywcy |
| Parametr zapytania | terminalId | Max10NumericText | Opcjonalnie | Kod terminala (Terminal Code) |
Parametry nagłówka:
| Element danych | Typ | Stan | Opis |
|---|---|---|---|
| Content-Type | String | Obowiązkowe | application/json |
| Autoryzacja | String | Obowiązkowe | Token okaziciela. Na podstawie uwierzytelniania OAuth2 przeprowadzonego w kroku wstępnym. |
| x-ibm-client-id | String | Obowiązkowe | Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu. |
| TPP-Request-ID | String | Obowiązkowe | Identyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą. |
| User-ID | String | Obowiązkowe | Identyfikacja użytkownika odpowiedzialnego za żądanie (wymagana do celów audytu). |
| User-Organization-ID | String | Obowiązkowe | Identyfikacja organizacji odpowiedzialnej za wniosek (wymagana do celów audytu). |
Parametry żądania:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Treść żądania | notificationConfigurationCode | Max35Text | Obowiązkowe | UUID konfiguracji powiadomienia |
| Treść żądania | requestOperationType | Max3Text | Obowiązkowe | Kod typu operacji żądania Enum: INS – Wstaw DEL – Usuń Ustaw za pomocą 'INS’. |
| Treść żądania | paymentMethods | Metody płatności | Obowiązkowe | Szereg metod płatności |
| Request Body.paymentMethods | paymentMethodNotificationCode | Max15Text | Obowiązkowe | Kod 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’ GRPY-’Giropay’ SFRT-’Sofort’ BNCT-’Bancontact’ IDEL-’Ideal’ |
| Treść żądania | channelTypeNotification | Typ kanału Powiadomienie | Obowiązkowe | Zawiera wszystkie dane związane z powiadomieniem o typie kanału. |
| Treść żądania.channelTypeNotification | notificationType | Max5Text | Obowiązkowe | Kod typu powiadomienia Enum: URL |
| Treść żądania.channelTypeNotification | wartość | Max2048Text | Obowiązkowe | Wartość powiadomienia (email or URL) |
| Treść żądania.channelTypeNotification | bezpieczeństwo | Bezpieczeństwo | Warunkowy | Obejmuje 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.security | klucz | Max32Text (Base64) | Warunkowy | Klucz bezpieczeństwa (tajny). |
| Treść żądania.channelTypeNotification.security | supportEmail | Max256Text | Warunkowy | E-mail wsparcia. |
| Treść żądania.channelTypeNotification.security | algorytm | Max70Text | Warunkowy | Algorytm Ustawienie 'AES-256-GCM’. |
W tym miejscu można przejrzeć strukturę odpowiedzi wynikającą z operacji Utwórz Webhook :
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Nagłówek odpowiedzi | TPP-Request-ID | UUID | Obowiązkowe | Identyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą. |
| Treść odpowiedzi | transactionStatus | Status transakcji | Obowiązkowe | Status transakcji Możliwe wartości to „ACTC-Accepted Technical Validation” i „RJCT-Rejected”. |
| Treść odpowiedzi | returnStatus | Status zwrotu | Obowiązkowe | |
| Treść odpowiedzi.returnStatus | statusCode | Kod wiadomości | Obowiązkowe | „000” oznacza sukces. Wartości różne od „000” oznaczają błędy. |
| Treść odpowiedzi.returnStatus | statusMsg | Typ wiadomości | Obowiązkowe | Komunikat o wynikach. |
| Treść odpowiedzi.returnStatus | statusDescription | Max512Text | Obowiązkowe | Dodatkowy 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.
| Operacje | Typ operacji | Metoda działania i punkt końcowy | Opis operacji |
|---|---|---|---|
| Żądanie 'Pobierz listę webhooków’ | Połączenie | POST version-id/webhooks | Pobierz listę webhooków. |
Poniższa tabela przedstawia wymagane elementy danych i ich warunki inicjowania żądania.
Parametry nagłówka:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Nagłówek żądania | Content-Type | String | Obowiązkowe | application/json |
| Nagłówek żądania | Autoryzacja | String | Obowiązkowe | Token okaziciela. Na podstawie uwierzytelniania OAuth2 przeprowadzonego w kroku wstępnym. |
| Nagłówek żądania | x-ibm-client-id | String | Obowiązkowe | Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu. |
| Nagłówek żądania | TPP-Request-ID | UUID | Obowiązkowe | Identyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą. |
| Nagłówek żądania | User-ID | String | Obowiązkowe | Identyfikacja użytkownika odpowiedzialnego za żądanie (wymagana do celów audytu). |
| Nagłówek żądania | User-Organization-ID | String | Obowiązkowe | Identyfikacja organizacji odpowiedzialnej za wniosek (wymagana do celów audytu). |
Parametry żądania:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Treść żądania | acquirerId | Max25NumericText | Obowiązkowe | Kod nabywcy |
| Treść żądania | merchantId | Max10NumericText | Obowiązkowe | Kod sprzedawcy |
| Treść żądania | acceptorId | Max10NumericText | Opcjonalnie | Kod akceptora |
| Treść żądania | terminalId | Max10NumericText | Opcjonalnie | Kod terminala (Terminal Code) |
Tabela przedstawia oczekiwane elementy odpowiedzi:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Nagłówek odpowiedzi | TPP-Request-ID | UUID | Obowiązkowe | Identyfikator odpowiedzi, unikalny dla połączenia, określony przez stronę inicjującą. |
| Treść odpowiedzi | transactionStatus | Status transakcji | Obowiązkowe | Status transakcji Możliwe wartości to „ACTC-Accepted Technical Validation” i „RJCT-Rejected”. |
| Treść odpowiedzi | returnStatus | Status zwrotu | Obowiązkowe | |
| Treść odpowiedzi.returnStatus | statusCode | Status transakcji. | Obowiązkowe | „000” oznacza sukces. Wartości różne od „000” oznaczają błędy. |
| Treść odpowiedzi.returnStatus | statusMsg | Typ wiadomości | Obowiązkowe | Komunikat o wynikach. |
| Treść odpowiedzi.returnStatus | statusDescription | Max512Text | Obowiązkowe | Dodatkowy tekst wyjaśniający. |
| Treść odpowiedzi | webhooks | Tablica webhooków | Warunkowy | Lista danych szczegółowych zasobu webhook. Występuje tylko w odpowiedziach pomyślnych. |
| Response Body.webhooks | webhook | Webhook | Obowiązkowe | Tablica webhooków |
| Response Body.webhooks.webhook | notificationConfigurationCode | Max36Text | Obowiązkowe | UUID konfiguracji powiadomienia |
| Treść odpowiedzi | paymentMethods | metody płatności | Obowiązkowe | Szereg metod płatności |
| Response Body.paymentMethods | paymentMethodNotificationCode | Max15Text | Obowiązkowe | Kod 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’ GRPY-’Giropay’ SFRT-’Sofort’ BNCT-’Bancontact’ IDEL-’Ideal’ |
| Response Body.webhooks.webhook | channelTypeNotification | Typ kanału Powiadomienie | Obowiązkowe | Zawiera wszystkie dane związane z powiadomieniem o typie kanału. |
| Response Body.webhooks.webhook.channelTypeNotification | notificationType | Max5Text | Obowiązkowe | Kod typu powiadomienia Enum: URL |
| Response Body.webhooks.webhook.channelTypeNotification | wartość | Max2048Text | Obowiązkowe | Wartość powiadomienia (email or URL). |
| Response Body.webhooks.webhook.channelTypeNotification | bezpieczeństwo | Bezpieczeństwo | Warunkowy | Obejmuje 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.security | klucz | Max32Text (Base64) | Warunkowy | Klucz bezpieczeństwa (tajny). |
| Response Body.webhooks.webhook.channelTypeNotification.security | supportEmail | Max256Text | Warunkowy | E-mail wsparcia. |
| Response Body.webhooks.webhook.channelTypeNotification.security | algorytm | Max70Text | Warunkowy | Algorytm. |
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.
| Operacje | Typ operacji | Metoda działania i punkt końcowy | Opis operacji |
|---|---|---|---|
| Żądanie aktualizacji Webhook | Połączenie | PUT version-id/acquirers/{acquirer-id}/merchants/{merchant-id}/terminal/webhook | Aktualizacja zasobu Webhook. |
Poniższa tabela przedstawia podstawowe elementy niezbędne do zainicjowania żądania Aktualizacja Webhook:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Ścieżka | acquirer-id | Max25NumericText | Obowiązkowe | Kod nabywcy |
| Ścieżka | merchant-id | Max10NumericText | Obowiązkowe | Kod sprzedawcy |
| Parametr zapytania | acceptorId | Max10NumericText | Opcjonalnie | Kod akceptanta w programie Merchant |
| Parametr zapytania | terminalId | Max10NumericText | Opcjonalnie | Kod terminala (Terminal Code). |
Parametry nagłówka:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Nagłówek żądania | Content-Type | String | Obowiązkowe | application/json |
| Nagłówek żądania | Autoryzacja | String | Obowiązkowe | Token okaziciela. Na podstawie uwierzytelniania OAuth2 przeprowadzonego w kroku wstępnym. |
| Nagłówek żądania | x-ibm-client-id | String | Obowiązkowe | Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu. |
| Nagłówek żądania | TPP-Request-ID | UUID | Obowiązkowe | Identyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą. |
| Nagłówek żądania | User-ID | String | Obowiązkowe | Identyfikacja użytkownika odpowiedzialnego za żądanie (wymagana do celów audytu). |
| Nagłówek żądania | User-Organization-ID | String | Obowiązkowe | Identyfikacja organizacji odpowiedzialnej za wniosek (wymagana do celów audytu). |
Parametry żądania:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Treść żądania | notificationConfigurationCode | Max35Text | Obowiązkowe | UUID konfiguracji powiadomienia |
| Treść żądania | requestOperationType | Max3Text | Obowiązkowe | Kod typu operacji żądania Enum: INS – Wstaw DEL – Usuń Ustaw za pomocą 'INS’. |
| Treść żądania | paymentMethods | metody płatności | Obowiązkowe | Szereg metod płatności |
| Request Body.paymentMethods | paymentMethodNotificationCode | Max15Text | Obowiązkowe | Kod 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’ GRPY-’Giropay’ SFRT-’Sofort’ BNCT-’Bancontact’ IDEL-’Ideal’ |
| Treść żądania | channelTypeNotification | Typ kanału Powiadomienie | Obowiązkowe | Zawiera wszystkie dane związane z powiadomieniem o typie kanału. |
| Treść żądania.channelTypeNotification | notificationType | Max5Text | Obowiązkowe | Kod typu powiadomienia Enum: URL |
| Treść żądania.channelTypeNotification | wartość | Max2048Text | Obowiązkowe | Wartość powiadomienia (email or URL) |
| Treść żądania.channelTypeNotification | bezpieczeństwo | Bezpieczeństwo | Warunkowy | Obejmuje 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.security | klucz | Max32Text | Warunkowy | Klucz bezpieczeństwa (tajny). |
| Treść żądania.channelTypeNotification.security | supportEmail | Max256Text | Warunkowy | E-mail wsparcia. |
| Treść żądania.channelTypeNotification.security | algorytm | Max70Text | Warunkowy | Algorytm Ustawienie 'AES-256-GCM’. |
Tabela przedstawia komponenty odpowiedzi dla operacji Aktualizacja Webhook:
| Lokalizacja | Element danych | Typ | Stan | Opis |
|---|---|---|---|---|
| Nagłówek odpowiedzi | TPP-Request-ID | UUID | Obowiązkowe | Identyfikator żądania, unikalny dla połączenia, określony przez stronę inicjującą. |
| Treść odpowiedzi | transactionStatus | Status transakcji | Obowiązkowe | Status transakcji Możliwe wartości to „ACTC-Accepted Technical Validation” i „RJCT-Rejected”. |
| Treść odpowiedzi | returnStatus | Status zwrotu | Obowiązkowe | |
| Treść odpowiedzi.returnStatus | statusCode | Kod wiadomości | Obowiązkowe | „000” oznacza sukces. Wartości różne od „000” oznaczają błędy. |
| Treść odpowiedzi.returnStatus | statusMsg | Typ wiadomości | Obowiązkowe | Komunikat o wynikach. |
| Treść odpowiedzi.returnStatus | statusDescription | Max512Text | Obowiązkowe | Dodatkowy tekst wyjaśniający. |