Shop

This page provides all the details you need to manage your shop through the API. You can create, update, or cancel your shop, and add or remove payment methods.

Create shop

To create new establishment resource, please refer to the list of available environment endpoints provided below:

Environment	URL	Operation Method & Endpoint	Operation Description
PROD	api.sibsgateway.com	POST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop	Create a new merchant shop resource
TEST	stargate.qly.site1.sibs.pt	POST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop	Create a new merchant shop resource

You need to perform a POST request including the following header and path parameters:

Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
merchant-id	String	Mandatory	Path	ID of Sponsored Merchant
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

You need to perform a POST request with the following parameters:

Request parameters

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

Below is an example of a POST request:

{
  "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"
  }
}

Update shop

To update of shop details, kindly refer to the list of available environment endpoints below:

Environment	URL	Operation Method & Endpoint	Operation Description
PROD	api.sibsgateway.com	PUT sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Update a Merchant Shop resource.
TEST	stargate.qly.site1.sibs.pt	PUT sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Update a Merchant Shop resource.

You need to perform a PUT request including the following header and path parameters:

Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
merchant-id	String	Mandatory	Path	ID of Sponsored Merchant
shop-id	String	Mandatory	Path	ID of Establishment
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

The table below details the parameters that can be utilized in the request message to update shop information:

Request parameters

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“

Find below a PUT request example:

{
  "Shop": {
    "address": {
      "street": "Behsu Road",
      "postalCode": "K8D 1C8",
      "locality": "aparuma"
    },
    "email": "johndoe@johndoe.pl",
    "phoneNumber": "987654321",
    "type": "Banks"
  }
}

Cancel shop

To remove a shop from the system based on its unique identifier, you can execute a DELETE operation. For this action, please utilize the following endpoints:

Environment	URL	Operation Method & Endpoint	Operation Description
PROD	api.sibsgateway.com	DELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Cancel a Merchant Shop resource.
TEST	stargate.qly.site1.sibs.pt	DELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}	Cancel a Merchant Shop resource.

Find below the request headers and path:

Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
merchant-id	String	Mandatory	Path	ID of Sponsored Merchant
shop-id	String	Mandatory	Path	ID of Establishment
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

For more information related to the error messages, please refer to the page Onboarding API > Merchant, section Error handling.

Add payment method

Our API enables seamless integration of new financial products into an existing store. To add a new payment method, please refer to the list of available environment endpoints provided below:

Environment	URL	Operation Method & Endpoint	Description
PROD	api.sibsgateway.com	POST sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Add new Financial Product
TEST	stargate.qly.site1.sibs.pt	POST sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Add new Financial Product

You need to perform a POST request including the following header and path parameters:

Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
merchant-id	String	Mandatory	Path	ID of Sponsored Merchant (required in the path)
shop-id	String	Mandatory	Path	ID of Establishment (required in the path)
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

The table below details the parameters that should be included in the request message to add a financial product:

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”

Find below a POST request example:

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

After the request, the API will respond with one of the two status codes:

Status Code	Message	TransactionStatus
000	Success	“ACT” (Accepted Technical Validation)
999	Unexpected Error	“RJT” (Rejected)

Delete payment method

To remove a financial product/payment method from an existing establishment, you can execute a DELETE operation. For this action, please utilize the following endpoints:

Environment	URL	Operation Method & Endpoint	Description
PROD	api.sibsgateway.com	DELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Delete a Payment Method/Financial Product from a Shop
TEST	stargate.qly.site1.sibs.pt	DELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/products	Delete a Payment Method/Financial Product from a Shop

You need to perform a DELETE request including the following header and path parameters:

Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
merchant-id	String	Mandatory	Path	ID of Sponsored Merchant (required in the path)
shop-id	String	Mandatory	Path	ID of Establishment (required in the path)
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

The table below details the parameters that should be included in the request message to add a financial product:

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”

Find below a DELETE request example:

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

After the request, the API will respond with one of the two status codes:

Status Code	Message	TransactionStatus
000	Success	“ACT” (Accepted Technical Validation)
999	Unexpected Error	“RJT” (Rejected)

Shop

Create shop

Parameters

Request parameters

Update shop

Parameters

Request parameters

Cancel shop

Parameters

Add payment method

Parameters

Request Parameters

Delete payment method

Parameters

Request Parameters

On this page: