About the Wix eCommerce Payment Settings SPI

As a payment settings service provider, you can integrate your service with Wix's payment process to allow merchants to request and use your services on their Wix sites. By integrating your service with Wix, the payment settings that are checked will then apply during the payment process.

The integration is done via an app in the Wix App Market (created in the Wix Developers Center) and the Wix Payment Settings SPI.

Learn more about implementing an SPI with Wix.

Before you begin

To collect payments, a Wix site must connect a payment provider. Once a payment provider is connected you may use the Payment Settings SPI to enforce additional payment settings to a site's transactions. For example, a site may require additional 3d secure payments (3DS) for certain payment methods. Note that each payment provider may have specific payment settings they accept with their Wix integration. For example, Tranzila is a payment provider that supports 3DS payments, but not all payment providers offer this feature. We recommend contacting payment providers directly to confirm which payment settings they have implemented as part of their Wix integration.

Use cases

Using the SPI, you can design your app to apply specific settings and send additional information to the payment provider. For example, your app can determine whether to apply 3DS during the payment process.

Configuration

To enable Wix to communicate with your app:

1. Go to the Extensions tab in the Wix Developers Center.
2. Click Create Extension in the top right.
3. Filter by eCommerce in the left menu, then find Ecom Payment Settings and click Create.
4. Provide the following configuration:

Name	Type	Description
deploymentUri	string	Required. Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. For example, to call the Get Payment Settings endpoint at https://my-payment-settings.com/v1/payment-settings, the base URI you provide here is https://my-payment-settings.com.
componentName	string	A unique name for this component. This is an internal name that will only appear in the Dev Center.
fallbackValueForRequires3dSecure	boolean	The value to set for paymentSettings.requires3dSecure if the SPI call fails. Default: false

Terminology

• 3 Domain Secure (3DS): An additional layer of security for online credit and debit card transactions. The name refers to the "three domains" which interact using the protocol: the card issuer, the acquiring bank, and the payment gateway that facilitates the transaction. Learn more about 3DS payments with third-party payment providers.
• Merchant: A business that offers products to customers on their Wix site.
• Wix site owner: The person managing the merchant's Wix site.
• Payment Settings Service Provider: A 3rd-party app that implements custom logic to return payment settings.

Payment Settings: Sample Flow

This article presents sample flows your app can support. You aren't limited to this exact flow, but it can be a helpful jumping off point as you plan your Payment Settings integration.

Retrieve Payment Settings

1. A site visitor clicks on the "Place Order" button in their Wix checkout, and an online payment is required.

2. Wix sends a Get Payment Settings SPI request to your app.

3. Your server handles the request and returns the payment settings.

   Example of a payment settings response from your app:

   Copy

   1
   {
   2
     "paymentSettings": {
   3
       "requires3dSecure": true
   4
     }
   5
   }

4. Wix passes the payment settings to the payment provider to continue the payment process.