Skip to content

Shop

Explore a range of actions you can undertake for shops, including creating, updating, and canceling.

Create shop

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

EnvironmentURLOperation Method & EndpointOperation Description
PRODapi.sibsgateway.comPOST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shopCreate a new merchant establishment resource
CERstargate-cer.qly.site1.sibs.ptPOST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shopCreate a new merchant establishment resource
Sandboxsandbox.sibsgateway.comPOST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shopCreate a new merchant establishment resource

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

Parameters
ParameterTypeConditionRequiredDescription
Content-typeStringMandatoryHeaderapplication/json
X-Request-IDStringMandatoryHeaderID of the request, unique to the call, as determined by the initiating party
merchant-idStringMandatoryPathID of Sponsored Merchant
x-ibm-client-idStringMandatoryHeaderToken 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 ElementType
Length
ConditionDescription
shopMandatoryObject that defines the Merchant Establishment
nameString
<=40
OptionalEstablishment Name.
When this field is empty, the value to be considered will be the ones parametrized at the Merchant level.
addressStringOptionalEstablishment Address
When these fields are empty, the value to be considered will be the ones parametrized at the Merchant level.
streetString
<=100
OptionalStreet
postalcodeString
<=25
OptionalPostal Code
localityString
<=20
OptionalLocality
countryNumber
3-3
Format ISO 3166, Number 3 code (ex: Poland – 616)
OptionalCountry
emailString
<=55
OptionalEstablishment Email
When these fields are empty, the value to be considered will be the ones parametrized at the Merchant level.
phoneNumberString
<=16
OptionalEstablishment Phone
When these fields are empty, the value to be considered will be the ones parametrized at the Merchant level.
typeString
“Banks”
“Wholesale“
“Supermarket“
“Retail“
“Gas Stations“
“Restaurants“
“Hotels“
“Others”
“Virtual Establishment“
“Foreign“
“Service Provider“
“Service Entity“
“EMV Tolls“
MandatoryEstablishment Type
mccString
4-4
MandatoryEstablishment MCC
pkdString
7
MandatoryEstablishment CAE
InvoiceIndicatorstring
“Payment Facilitator”
“Sponsored Merchant”
Default: “Payment Facilitator”
MandatoryEstablishment Invoice Indicator
productsStringMandatoryObject that defines the Establishment Products
productIDString
“XPAY-APPL-0-0”,
“XPAY-GGLE-0-0”,
“PYWK-BNPL-1-0”,
“PYWK-BNPL-2-0”,
“INTP-BLIK-0-0”,
“INTP-BLIK-1-0”,
“BLMD-PYBL-0-0”,
“KEVN-PYBL-0-0”,
“MCC-1-C”,
“MCC-1-D”,
“MCC-1-P”,
“MCC-2-C”,
“MCC-2-P”,
“MCC-4-C”,
“MCC-4-D”,
“MCC-4-P”,
“MSI-1-D”,
“MSI-1-P”,
“MSI-2-D”,
“MSI-2-P”,
“VIS-01-C”,
“VIS-01-D”,
“VIS-01-P”,
“VIS-02-C”,
“VIS-02-D”,
“VIS-02-P”,
“VPY-03-D”,
“VPY-03-P”,
“VSL-01-C”,
“VSL-01-D”,
“VSL-01-P”
MandatoryPayment methods selected by the customer.
Product ID’s to activate:
“INTP-BLIK-0-0” InterPay-BLIK-Domestic
“INTP-BLIK-1-0” – InterPay-BLIK-OneClick
“BLMD-PYBL-0-0” BlueMedia-PayByLink-Domestic
“KEVN-PYBL-0-0” – PayByLink-Kevin
“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
productInvoiceIndicatorString
“Payment Facilitator”
“Sponsored Merchant”
Default: “Payment Facilitator”
OptionalProduct Invoice Indicator
paymentMethodTypeString
“Direct Debit”
“Bank Transfer”
Default: “Direct Debit”
ConditionalPayment method type for the invoicing of the sponsored merchant. This field is mandatory if the Invoice indicator is “Sponsored Merchant”
invoiceEmailString
<=55
ConditionalInvoice email address.
This field is mandatory if the Invoice indicator is “Sponsored Merchant”
payoutStringConditionalObject that defines the Payout Information.
Mandatory if InvoiceIndicator is “Sponsored Merchant”
bankAccountString
26-26
ConditionalSponsored Merchants bank account
Mandatory if InvoiceIndicator is “Sponsored Merchant”
ibanString
<=34
ConditionalSponsored Merchants iban
Mandatory if InvoiceIndicator is “Sponsored Merchant”
bicString
8<11
ConditionalSponsored Merchants bic
Mandatory if InvoiceIndicator is “Sponsored Merchant”
numDaysPayoutNumberOptionalSponsored Merchants Payout Number of Days
Reserved for future use.
maxPercentLowRiskExemptionsNumber
<=100
OptionalThe maximum percentage of low-risk exemptions allowed in a system or process.
scaExemptionString
Default “0”
OptionalThe field to evaluate SCA Exemptions must be filled with 1 to allow and 0 to not allow
typeOfIntegrationString
“S2S”
“SDK”
“Plugin”
Default “S2S”
MandatorySponsored merchant type of integration
webhookNotificationStringConditionalObject that defines the webhook configuration details
Mandatory if typeOfIntegration is “Plugin”.
typeString
“URL”
“Email”
ConditionalType of webhook notifications.
Mandatory if typeOfIntegration is “Plugin”.
If “Plugin”, the value must be “URL”
ValueStringConditionalA delivery email address (for email type), or an HTTP(S) URL
Mandatory if typeOfIntegration is “Plugin”
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”
securityKeyString
<=32
OptionalA pseudo-random symmetric key that will be used to cipher the webhook content

Below is an example of a POST request:

{
 "Shop": {
 "name": "Alma Parker",
 "address": {
 "street": "Norcop Court",
 "postalCode": "00-007",
 "locality": "Warsaw",
 "country": "616"
 },
 "email": "jondoe@gmail.com",
 "type": "Banks",
 "mcc": "5115",
 "pkd": "60m93YN",
 "invoiceIndicator": "Payment Facilitator",
 "products": [
 {
 "productId": "BLMD-PYBL-0-0",
 "productInvoiceIndicator": "Payment Facilitator"
 }
 ],
 "paymentMethodType": "Direct Debit",
 "invoiceEmail": "jonhdoe@gmail.com",
 "payout": {
 "bankAccount": "99999999999999999999999999",
 "iban": "RX89tf91aF",
 "bic": "pihezhuzhi",
 },
 "maxPercentLowRiskExemptions": "100",
 "scaExemption": "0",
 "typeOfIntegration": "S2S",
 "webhookNotification": {
 "type": "URL",
 "value": "78.89"
 },
 "supportEmail": "johndoe@gmail.com",
 "securityKey": "cefabijtakidaanogatopwazwoshawzi"
 }
}

Update shop

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

EnvironmentURLOperation Method & EndpointOperation Description
PRODapi.sibsgateway.comPUT sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Update a Merchant Establishment resource.
CERstargate-cer.qly.site1.sibs.ptPUT sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Update a Merchant Establishment resource.
Sandboxsandbox.sibsgateway.comPUT sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Update a Merchant Establishment resource.

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

Parameters
ParameterTypeConditionRequiredDescription
Content-typeStringMandatoryHeaderapplication/json
X-Request-IDStringMandatoryHeaderID of the request, unique to the call, as determined by the initiating party
merchant-idStringMandatoryPathID of Sponsored Merchant
shop-idStringMandatoryPathID of Establishment
x-ibm-client-idStringMandatoryHeaderToken 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 ElementType
Length
ConditionDescription
shopMandatoryObject that defines the Merchant Establishment
addressStringOptionalEstablishment Address
When these fields are empty, the value to be considered will be the ones parametrized at the Merchant level.
streetString
<=100
OptionalStreet
postalcodeString
<=25
OptionalPostal Code
localityString
<=20
OptionalLocality
emailString
<=55
OptionalEstablishment Email
When these fields are empty, the value to be considered will be the ones parametrized at the Merchant level.
phoneNumberString
<=16
OptionalEstablishment Phone
When these fields are empty, the value to be considered will be the ones parametrized at the Merchant level.
typeString
“Banks”
“Wholesale“
“Supermarket“
“Retail“
“Gas Stations“
“Restaurants“
“Hotels“
“Others”
“Virtual Establishment“
“Foreign“
“Service Provider“
“Service Entity“
“EMV Tolls“
MandatoryEstablishment Type
maxPercentLowRiskExemptionsNumber
<=100
OptionalThe maximum percentage of low-risk exemptions allowed in a system or process.
scaExemptionString
Default “0”
OptionalThe field to evaluate SCA Exemptions must be filled with 1 to allow and 0 to not allow

Find below a PUT request example:

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

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:

EnvironmentURLOperation Method & EndpointOperation Description
PRODapi.sibsgateway.comDELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Cancel a Merchant Establishment resource.
CERstargate-cer.qly.site1.sibs.ptDELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Cancel a Merchant Establishment resource.
Sandboxsandbox.sibsgateway.comDELETE sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}Cancel a Merchant Establishment resource.

Find below the request headers and path:

Parameters
ParameterTypeConditionRequiredDescription
Content-typeStringMandatoryHeaderapplication/json
X-Request-IDStringMandatoryHeaderID of the request, unique to the call, as determined by the initiating party
merchant-idStringMandatoryPathID of Sponsored Merchant
shop-idStringMandatoryPathID of Establishment
x-ibm-client-idStringMandatoryHeaderToken that identifies a client organization. It is provided during onboarding process and must be used in every call
Info

For more information related to the error messages, please refer to the Error handling section on the “Merchant” page.