Sklep

Ta strona zawiera wszystkie szczegóły potrzebne do zarządzania sklepem za pośrednictwem API. Możesz utworzyć, zaktualizować lub anulować swój sklep, a także dodawać lub usuwać metody płatności.

Utwórz sklep

Aby utworzyć nowy zasób establishment, należy zapoznać się z listą dostępnych punktów końcowych środowiska podaną poniżej:

Środowisko	URL	Metoda działania i endpointy	Opis działania
PROD	api.sibsgateway.com	POST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop	Utwórz nowy establishment sprzedawcy
TEST	stargate.qly.site1.sibs.pt	POST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop	Utwórz nowy establishment sprzedawcy

Należy wykonać żądanie POST zawierające następujące parametry nagłówka i ścieżki:

Parametry

Parametr	Typ	Stan	Wymagania	Opis
Content-type	String	Wymagane	Nagłowek	application/json
X-Request-ID	String	Wymagane	Nagłowek	Żadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą.
merchant-id	String	Wymagane	Ścieżka	ID sponsorowanego sprzedawcy
x-ibm-client-id	String	Wymagane	Nagłowek	Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu onboardingu i musi być używany w każdym połączeniu.

Należy wykonać żądanie POST z następującymi parametrami.

Parametry zapytania

Data Element	Type Length	Condition	Description
Shop	Object	Mandatory	Main object containing shop details
Shop.name	String <=40	Optional	Name of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.address	Object	Optional	Shop address details
Shop.address.street	String <=100	Optional	Street name of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.address.postalCode	String <=25	Optional	Postal code of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.address.locality	String <=20	Optional	City/locality of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.address.country	String 3-3	Optional	Shop Country code (Format ISO 3166, Number 3 code — ex: Poland – 616) If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.email	String <=55	Optional	Email address of the shop
Shop.phoneNumber	String <=16	Optional	Phone number of the shop
Shop.type	Enum	Mandatory	Shop type Allowed Values: “Banks” “Wholesale“ “Supermarket“ “Retail“ “Gas Stations“ “Restaurants“ “Hotels“ “Others” “Virtual Establishment“ “Foreign“ “Service Provider“ “Service Entity“ “EMV Tolls“
Shop.mcc	String 4-4	Mandatory	Merchant Category Code
Shop.pkd	String 7-7	Mandatory	Polish Classification of Activities code The format of this parameter will be as Follows: 00.00.A
Shop.invoiceIndicator	Enum	Mandatory	Shop Invoice Indicator type Allowed value: “Payment Facilitator”
Shop.products	Array of Objects	Mandatory	List of products accepted in the shop
Shop.products[].productId	Enum	Mandatory	Payment methods to be activated. Allowed values: “INTP-BLIK-0-0” InterPay-BLIK-Domestic “INTP-BLIK-1-0” – InterPay-BLIK-OneClick “BLMD-PYBL-0-0” BlueMedia-PayByLink-Domestic “MRKP-CRTB-0-0” – Cartes Bancaires “SIBS-MBWY-0-0” – MB WAY “SPDD-BTOB-0-0” – SEPA DD B2B “SPDD-CORE-0-0” – SEPA DD Core “XPAY-APPL-0-0” – ApplePay “XPAY-GGLE-0-0” – GooglePay “MCC-1-C” – Mastercard-Mastercard-Consumer-Credit “MCC-1-D” – Mastercard-Mastercard-Consumer-Debit “MCC-1-P” – Mastercard-Mastercard-Consumer-Prepaid “MCC-2-C” – Mastercard-Mastercard-Commercial-Credit “MCC-2-P” – Mastercard-Mastercard-Commercial-Prepaid “MCC-4-C” – Mastercard-Mastercard-Other-Credit “MCC-4-D” – Mastercard-Mastercard-Other-Debit “MCC-4-P” – Mastercard-Mastercard-Other-Prepaid “MSI-1-D” – Mastercard-Maestro-Consumer-Debit “MSI-1-P” – Mastercard-Maestro-Consumer-Prepaid “MSI-2-D” – Mastercard-Maestro-Commercial-Debit “MSI-2-P” – Mastercard-Maestro-Commercial-Prepaid “VIS-02-C” – VISA-VISA-Commercial-Credit “VIS-02-D” – VISA-VISA-Commercial-Debit “VIS-02-P” – VISA-VISA-Commercial-Prepaid “VIS-01-C” – VISA-VISA-Consumer-Credit “VIS-01-D” – VISA-VISA-Consumer-Debit “VIS-01-P” – VISA-VISA-Consumer-Prepaid “VPY-03-D” – VISA-VPAY-VPAY-Debit “VPY-03-P” – VISA-VPAY-VPAY-Prepaid “VSL-01-C” – VISA-VISA Electron-Consumer-Credit “VSL-01-D” – VISA-VISA Electron-Consumer-Debit “VSL-01-P” – VISA-VISA Electron-Consumer-Prepaid
Shop.products[].productInvoiceIndicator	Enum	Mandatory	Product Invoice Indicator Allowed Value: “Payment Facilitator”
Shop.typeOfIntegration	Enum	Mandatory	Merchant type of integration Allowed Values: “S2S” “SDK” “Plugin” Default “S2S”
Shop.webhookNotification	Object	Conditional	Configuration for webhook notifications Mandatory if typeOfIntegration is “Plugin”
Shop.webhookNotification.type	Enum	Conditional	Type of webhook notifications. Allowed values: “URL” “Email” Mandatory if typeOfIntegration is “Plugin”. If “Plugin”, the value must be “URL”
Shop.webhookNotification.value	String	Conditional	Webhook endpoint or value Mandatory if typeOfIntegration is “Plugin”
Shop.supportEmail	String <=55	Conditional	An email address to where all failed SPG Webhook calls will be reported by the end-of-day Mandatory if typeOfIntegration is “Plugin”
Shop.securityKey	String >=32	Optional	A pseudo-random symmetric key that will be used to cipher the webhook content

Poniżej przykład żądania POST:

{
  "Shop": {
    "name": "Example Shop",
    "address": {
      "street": "Main Street 123",
      "postalCode": "00-001",
      "locality": "Warsaw",
      "country": "616"
    },
    "email": "shop@example.com",
    "phoneNumber": "351912345678",
    "type": "Retail",
    "mcc": "5411",
    "pkd": "47.11.Z",
    "invoiceIndicator": "Payment Facilitator",
    "products": [
      {
        "productId": "XPAY-APPL-0-0",
        "productInvoiceIndicator": "Payment Facilitator"
      },
      {
        "productId": "VIS-01-D",
        "productInvoiceIndicator": "Payment Facilitator"
      }
    ],
    "typeOfIntegration": "S2S",
    "webhookNotification": {
      "type": "URL",
      "value": "https://merchant.example.com/webhook"
    },
    "supportEmail": "support@example.com",
    "securityKey": "8a93f83e0a89485f912374fe0cb458bc"
  }
}

Aktualizacja sklepu

Aby zaktualizować szczegóły sklepu, zapoznaj się z poniższą listą dostępnych punktów końcowych środowiska:

Środowisko	URL	Metoda działania i endpointy	Opis działania
PROD	api.sibsgateway.com	PUT /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Aktualizacja Merchant Establishment .
TEST	stargate.qly.site1.sibs.pt	PUT /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Aktualizacja Merchant Establishment .

Należy wykonać żądanie PUT zawierające następujące parametry nagłówka i ścieżki.

Parametry

Parametr	Typ	Stan	Wymagania	Opis
Content-type	String	Wymagane	Nagłowek	application/json
X-Request-ID	String	Wymagane	Nagłowek	Żadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą.
merchant-id	String	Wymagane	Ścieżka	ID sponsorowanego sprzedawcy
shop-id	String	Wymagane	Ścieżka	Establishment ID
x-ibm-client-id	String	Wymagane	Nagłowek	Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu onboardingu i musi być używany w każdym połączeniu.

W poniższej tabeli wyszczególniono parametry, które można wykorzystać w komunikacie żądania w celu aktualizacji informacji o sklepie:

Parametry zapytania

Data Element	Type Length	Condition	Description
Shop	Object	Mandatory	Main object containing shop details
Shop.address	Object	Optional	Shop address details
Shop.address.street	String <=100	Optional	Street name of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.address.postalCode	String <=25	Optional	Postal code of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.address.locality	String <=20	Optional	City/locality of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.email	String <=55	Optional	Email address of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.phoneNumber	String <=16	Optional	Phone number of the shop If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.type	Enum	Mandatory	Shop type Allowed Values: “Banks” “Wholesale“ “Supermarket“ “Retail“ “Gas Stations“ “Restaurants“ “Hotels“ “Others” “Virtual Establishment“ “Foreign“ “Service Provider“ “Service Entity“ “EMV Tolls“

Sprawdź poniżej przykład żadania PUT:

{
  "Shop": {
    "address": {
      "street": "Behsu Road",
      "postalCode": "K8D 1C8",
      "locality": "aparuma"
    },
    "email": "JRvAd_GfBJs.@lLdRqk9B16A7rc7B_oBb1BNaVj1mVvx-0YEJFBRoeINdL_GhCb4x-KBYnsKjY9_9a0wnyFn7A.OdVz",
    "phoneNumber": "13881980362441110710459585739360",
    "type": "Banks",
    "maxPercentLowRiskExemptions": "100",
    "scaExemption": "0"
  }
}

Usunięcie sklepu

Aby usunąć sklep z systemu bazując na unikalnym identyfikatorze, użyj operacji DELETE. W przypadku tej akcji należy użyć następujących punktów końcowych:

Środowisko	URL	Metoda działania i endpointy	Opis działania
PROD	api.sibsgateway.com	DELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Anulowanie zasobu Merchant Establishment.
TEST	stargate.qly.site1.sibs.pt	DELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Anulowanie zasobu Merchant Establishment.

Poniżej znajdują się nagłówki żądania i ścieżka:

Parametry

Parametr	Typ	Stan	Wymagania	Opis
Content-type	String	Wymagane	Nagłowek	application/json
X-Request-ID	String	Wymagane	Nagłowek	Żadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą.
merchant-id	String	Wymagane	Ścieżka	ID sponsorowanego sprzedawcy
shop-id	String	Wymagane	Ścieżka	Establishment ID
x-ibm-client-id	String	Wymagane	Nagłowek	Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu onboardingu i musi być używany w każdym połączeniu.

Więcej informacji na temat komunikatów o błędach znajdziesz na stronie Onboarding API > Sprzedawca, w sekcji Obsługa błędów.

Dodaj metodę płatności

Nasze API umożliwia bezproblemową integrację nowych produktów finansowych z istniejącym sklepem. Aby dodać nową metodę płatności, zapoznaj się z listą dostępnych punktów końcowych środowiska podaną poniżej:

Środowisko	URL	Metoda działania i punkt końcowy	Opis
PROD	api.sibsgateway.com	POST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Dodaj nowy produkt finansowy
TEST	stargate.qly.site1.sibs.pt	POST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Dodaj nowy produkt finansowy

Należy wykonać żądanie POST zawierające następujące parametry nagłówka i ścieżki:

Parametr	Typ	Stan	Wymaganie	Opis
Content-type	String	Wymagany	Nagłówek	application/json
X-Request-ID	String	Wymagany	Nagłówek	Identyfikator żądania, unikalny dla połączenia, ustalony przez stronę inicjującą
merchant-id	String	Wymagany	Ścieżka	ID sponsorowanego sprzedawcy (wymagane w ścieżce)
shop-id	String	Wymagany	Ścieżka	ID placówki (wymagane w ścieżce)
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

Poniższa tabela zawiera szczegółowe informacje na temat parametrów, które należy uwzględnić w komunikacie żądania, aby dodać produkt finansowy:

Request Parameters

Data Element	Type Length	Condition	Description
products	Array of Objects	Mandatory	List of products to be configured
products[].productId	Enum	Mandatory	Payment methods to be activated. Allowed values: “INTP-BLIK-0-0” InterPay-BLIK-Domestic “INTP-BLIK-1-0” – InterPay-BLIK-OneClick “BLMD-PYBL-0-0” BlueMedia-PayByLink-Domestic “MRKP-CRTB-0-0” – Cartes Bancaires “SIBS-MBWY-0-0” – MB WAY “SPDD-BTOB-0-0” – SEPA DD B2B “SPDD-CORE-0-0” – SEPA DD Core “XPAY-APPL-0-0” – ApplePay “XPAY-GGLE-0-0” – GooglePay “MCC-1-C” – Mastercard-Mastercard-Consumer-Credit “MCC-1-D” – Mastercard-Mastercard-Consumer-Debit “MCC-1-P” – Mastercard-Mastercard-Consumer-Prepaid “MCC-2-C” – Mastercard-Mastercard-Commercial-Credit “MCC-2-P” – Mastercard-Mastercard-Commercial-Prepaid “MCC-4-C” – Mastercard-Mastercard-Other-Credit “MCC-4-D” – Mastercard-Mastercard-Other-Debit “MCC-4-P” – Mastercard-Mastercard-Other-Prepaid “MSI-1-D” – Mastercard-Maestro-Consumer-Debit “MSI-1-P” – Mastercard-Maestro-Consumer-Prepaid “MSI-2-D” – Mastercard-Maestro-Commercial-Debit “MSI-2-P” – Mastercard-Maestro-Commercial-Prepaid “VIS-02-C” – VISA-VISA-Commercial-Credit “VIS-02-D” – VISA-VISA-Commercial-Debit “VIS-02-P” – VISA-VISA-Commercial-Prepaid “VIS-01-C” – VISA-VISA-Consumer-Credit “VIS-01-D” – VISA-VISA-Consumer-Debit “VIS-01-P” – VISA-VISA-Consumer-Prepaid “VPY-03-D” – VISA-VPAY-VPAY-Debit “VPY-03-P” – VISA-VPAY-VPAY-Prepaid “VSL-01-C” – VISA-VISA Electron-Consumer-Credit “VSL-01-D” – VISA-VISA Electron-Consumer-Debit “VSL-01-P” – VISA-VISA Electron-Consumer-Prepaid
products[].productInvoiceIndicator	Enum	Mandatory	Product Invoice Indicator Allowed Value: “Payment Facilitator”

Poniżej znajdziesz przykład żądania POST:

{
  "products" : [ {
    "productId" : "MCC-1-C",
    "productInvoiceIndicator" : "Payment Facilitator"
  } ]
}

Po wysłaniu żądania API odpowie jednym z dwóch kodów statusu:

Kod Statusu	Wiadomość	TransactionStatus
000	Sukces	“ACTC” (Accepted Technical Validation)
999	Nieoczekiwany błąd	“RJT” (Rejected)

Usuń metodę płatności

Aby usunąć produkt finansowy/metodę płatności z istniejącej placówki, możesz wykonać operację DELETE. W tym celu skorzystaj z następujących punktów końcowych:

Środowisko	URL	Metoda działania i punkt końcowy	Opis
PROD	api.sibsgateway.com	DELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Usuwanie produktu finansowego z establiszmentu
TEST	stargate.qly.site1.sibs.pt	DELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Usuwanie produktu finansowego z establiszmentu

Należy wykonać żądanie DELETE zawierające następujące parametry nagłówka i ścieżki:

Parameters

Parametr	Typ	Stan	Wymagane	Opis
Content-type	String	Wymagany	Nagłówek	aplikacja/json
X-Request-ID	String	Wymagany	Nagłówek	Identyfikator żądania, unikalny dla połączenia, ustalony przez stronę inicjującą
merchant-id	String	Wymagany	Ścieżka	ID sponsorowanego sprzedawcy (wymagane w ścieżce)
shop-id	String	Wymagany	Ścieżka	ID of ID placówki (wymagane w ścieżce)
x-ibm-client-id	String	Wymagany	Nagłówek	Token that identifies a client Token identyfikujący organizację klienta. Jest on dostarczany podczas procesu wdrażania i musi być używany w każdym połączeniu

Poniższa tabela zawiera szczegółowe informacje na temat parametrów, które należy uwzględnić w komunikacie żądania, aby dodać produkt finansowy:

Request Parameters

Data Element	Type Length	Condition	Description
products	Array of Objects	Mandatory	Object that defines the Shop Products
products[].productId	Enum	Mandatory	Payment methods to be activated. Allowed values: “INTP-BLIK-0-0” InterPay-BLIK-Domestic “INTP-BLIK-1-0” – InterPay-BLIK-OneClick “BLMD-PYBL-0-0” BlueMedia-PayByLink-Domestic “MRKP-CRTB-0-0” – Cartes Bancaires “SIBS-MBWY-0-0” – MB WAY “SPDD-BTOB-0-0” – SEPA DD B2B “SPDD-CORE-0-0” – SEPA DD Core “XPAY-APPL-0-0” – ApplePay “XPAY-GGLE-0-0” – GooglePay “MCC-1-C” – Mastercard-Mastercard-Consumer-Credit “MCC-1-D” – Mastercard-Mastercard-Consumer-Debit “MCC-1-P” – Mastercard-Mastercard-Consumer-Prepaid “MCC-2-C” – Mastercard-Mastercard-Commercial-Credit “MCC-2-P” – Mastercard-Mastercard-Commercial-Prepaid “MCC-4-C” – Mastercard-Mastercard-Other-Credit “MCC-4-D” – Mastercard-Mastercard-Other-Debit “MCC-4-P” – Mastercard-Mastercard-Other-Prepaid “MSI-1-D” – Mastercard-Maestro-Consumer-Debit “MSI-1-P” – Mastercard-Maestro-Consumer-Prepaid “MSI-2-D” – Mastercard-Maestro-Commercial-Debit “MSI-2-P” – Mastercard-Maestro-Commercial-Prepaid “VIS-02-C” – VISA-VISA-Commercial-Credit “VIS-02-D” – VISA-VISA-Commercial-Debit “VIS-02-P” – VISA-VISA-Commercial-Prepaid “VIS-01-C” – VISA-VISA-Consumer-Credit “VIS-01-D” – VISA-VISA-Consumer-Debit “VIS-01-P” – VISA-VISA-Consumer-Prepaid “VPY-03-D” – VISA-VPAY-VPAY-Debit “VPY-03-P” – VISA-VPAY-VPAY-Prepaid “VSL-01-C” – VISA-VISA Electron-Consumer-Credit “VSL-01-D” – VISA-VISA Electron-Consumer-Debit “VSL-01-P” – VISA-VISA Electron-Consumer-Prepaid
products[].productInvoiceIndicator	Enum	Mandatory	Product Invoice Indicator Allowed Value: “Payment Facilitator”

Poniżej znajdziesz przykład żądania DELETE:

{
  "products" : [ {
    "productId" : "MCC-1-C",
    "productInvoiceIndicator" : "Payment Facilitator"
  } ]
}

Po wysłaniu żądania API odpowie jednym z dwóch kodów statusu:

Kod statusu	Wiadomość	TransactionStatus
000	Sukces	“ACTC” (Accepted Technical Validation)
999	Nieoczekiwany błąd	“RJT” (Rejected)

Sklep

Utwórz sklep

Parametry

Parametry zapytania

Aktualizacja sklepu

Parametry

Parametry zapytania

Usunięcie sklepu

Parametry

Dodaj metodę płatności

Request Parameters

Usuń metodę płatności

Parameters

Request Parameters

On this page: