Skip to content
Menu

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:

ŚrodowiskoURLMetoda działania i endpointyOpis działania
PRODapi.sibsgateway.comPOST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shopUtwórz nowy establishment sprzedawcy
TESTstargate.qly.site1.sibs.ptPOST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shopUtwórz nowy establishment sprzedawcy

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

Parametry
ParametrTypStanWymaganiaOpis
Content-typeStringWymaganeNagłowekapplication/json
X-Request-IDStringWymaganeNagłowekŻadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą.
merchant-idStringWymaganeŚcieżkaID sponsorowanego sprzedawcy
x-ibm-client-idStringWymaganeNagłowekToken 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 ElementType
Length
ConditionDescription
ShopObjectMandatoryMain object containing shop details
Shop.nameString
<=40
OptionalName of the shop
If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.addressObjectOptionalShop address details
Shop.address.streetString
<=100
OptionalStreet 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.postalCodeString
<=25
OptionalPostal 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.localityString
<=20
OptionalCity/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.countryString
3-3
OptionalShop 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.emailString
<=55
OptionalEmail address of the shop
Shop.phoneNumberString
<=16
OptionalPhone number of the shop
Shop.typeEnumMandatoryShop type
Allowed Values:
“Banks”
“Wholesale“
“Supermarket“
“Retail“
“Gas Stations“
“Restaurants“
“Hotels“
“Others”
“Virtual Establishment“
“Foreign“
“Service Provider“
“Service Entity“
“EMV Tolls“
Shop.mccString
4-4
MandatoryMerchant Category Code
Shop.pkdString
7-7
MandatoryPolish Classification of Activities code
The format of this parameter will be as Follows: 00.00.A
Shop.invoiceIndicatorEnumMandatoryShop Invoice Indicator type
Allowed value:
“Payment Facilitator”
Shop.productsArray of ObjectsMandatoryList of products accepted in the shop
Shop.products[].productIdEnumMandatoryPayment 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[].productInvoiceIndicatorEnumMandatoryProduct Invoice Indicator
Allowed Value:
“Payment Facilitator”
Shop.typeOfIntegrationEnumMandatoryMerchant type of integration
Allowed Values:
“S2S”
“SDK”
“Plugin”
Default “S2S”
Shop.webhookNotificationObjectConditionalConfiguration for webhook notifications
Mandatory if typeOfIntegration is “Plugin”
Shop.webhookNotification.typeEnumConditionalType of webhook notifications.
Allowed values:
“URL”
“Email”
Mandatory if typeOfIntegration is “Plugin”.
If “Plugin”, the value must be “URL”
Shop.webhookNotification.valueStringConditionalWebhook endpoint or value
Mandatory if typeOfIntegration is “Plugin”
Shop.supportEmailString
<=55
ConditionalAn email address to where all failed SPG Webhook calls will be reported by the end-of-day
Mandatory if typeOfIntegration is “Plugin”
Shop.securityKeyString
>=32
OptionalA 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:

ŚrodowiskoURLMetoda działania i endpointyOpis działania
PRODapi.sibsgateway.comPUT /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Aktualizacja Merchant Establishment .
TESTstargate.qly.site1.sibs.ptPUT /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
ParametrTypStanWymaganiaOpis
Content-typeStringWymaganeNagłowekapplication/json
X-Request-IDStringWymaganeNagłowekŻadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą.
merchant-idStringWymaganeŚcieżkaID sponsorowanego sprzedawcy
shop-idStringWymaganeŚcieżkaEstablishment ID
x-ibm-client-idStringWymaganeNagłowekToken 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 ElementType
Length
ConditionDescription
ShopObjectMandatoryMain object containing shop details
Shop.addressObjectOptionalShop address details
Shop.address.streetString
<=100
OptionalStreet 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.postalCodeString
<=25
OptionalPostal 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.localityString
<=20
OptionalCity/locality of the shop
If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.emailString
<=55
OptionalEmail address of the shop
If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.phoneNumberString
<=16
OptionalPhone number of the shop
If this field is left empty, the system will default to using the value specified at the Merchant level.
Shop.typeEnumMandatoryShop 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:

ŚrodowiskoURLMetoda działania i endpointyOpis działania
PRODapi.sibsgateway.comDELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Anulowanie zasobu Merchant Establishment.
TESTstargate.qly.site1.sibs.ptDELETE /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
ParametrTypStanWymaganiaOpis
Content-typeStringWymaganeNagłowekapplication/json
X-Request-IDStringWymaganeNagłowekŻadanie indentyfikatora ID, unikalne do połączenia, określony przez stronę inicjującą.
merchant-idStringWymaganeŚcieżkaID sponsorowanego sprzedawcy
shop-idStringWymaganeŚcieżkaEstablishment ID
x-ibm-client-idStringWymaganeNagłowekToken identyfikujący organizację klienta. Jest on dostarczany podczas procesu onboardingu i musi być używany w każdym połączeniu.
Info

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:

ŚrodowiskoURLMetoda działania i punkt końcowyOpis
PRODapi.sibsgateway.comPOST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/productsDodaj nowy produkt finansowy
TESTstargate.qly.site1.sibs.ptPOST /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/productsDodaj nowy produkt finansowy

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

ParametrTypStanWymaganieOpis
Content-typeStringWymaganyNagłówek application/json
X-Request-IDStringWymaganyNagłówek Identyfikator żądania, unikalny dla połączenia, ustalony przez stronę inicjującą
merchant-idStringWymaganyŚcieżkaID sponsorowanego sprzedawcy (wymagane w ścieżce)
shop-idStringWymaganyŚcieżkaID placówki (wymagane w ścieżce)
x-ibm-client-idStringWymaganyNagłó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 ElementType
Length
ConditionDescription
productsArray of ObjectsMandatoryList of products to be configured
products[].productIdEnumMandatoryPayment 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[].productInvoiceIndicatorEnumMandatoryProduct 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 StatusuWiadomośćTransactionStatus
000Sukces“ACTC” (Accepted Technical Validation)
999Nieoczekiwany 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:

ŚrodowiskoURLMetoda działania i punkt końcowyOpis
PRODapi.sibsgateway.comDELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/productsUsuwanie produktu finansowego z establiszmentu
TESTstargate.qly.site1.sibs.ptDELETE /api/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/productsUsuwanie produktu finansowego z establiszmentu

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

Parameters
ParametrTypStanWymaganeOpis
Content-typeStringWymaganyNagłówekaplikacja/json
X-Request-IDStringWymaganyNagłówekIdentyfikator żądania, unikalny dla połączenia, ustalony przez stronę inicjującą
merchant-idStringWymaganyŚcieżkaID sponsorowanego sprzedawcy (wymagane w ścieżce)
shop-idStringWymaganyŚcieżkaID of ID placówki (wymagane w ścieżce)
x-ibm-client-idStringWymaganyNagłówekToken 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 ElementType
Length
ConditionDescription
productsArray of ObjectsMandatoryObject that defines the Shop Products
products[].productIdEnumMandatoryPayment 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[].productInvoiceIndicatorEnumMandatoryProduct 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 statusuWiadomośćTransactionStatus
000Sukces“ACTC” (Accepted Technical Validation)
999Nieoczekiwany błąd“RJT” (Rejected)
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.