About the Payment Settings Service Plugin
As a payment settings 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 and by implementing the Payment Settings service plugin. After the app is installed on a site, Wix triggers a call to your service when an order is placed from the checkout page of the site.
Using the service plugin, you can design your app to apply specific settings and send additional information to the payment provider. Currently, the only payment setting available to customize is whether to apply 3DS to an order. If 3DS is required, the customer will have to pass an additional layer of security before completing their payment. For example:
Before you begin
It's important to note the following points before starting to code:
- To collect payments, a Wix site must connect a payment provider.
- We recommend contacting payment providers directly to confirm which payment settings they have implemented as part of their Wix integration.
Terminology
- 3 Domain Security (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.
- Payment Providers: Different payment methods available to your Wix site. Learn more about accepting payments.
Get started
Follow these steps to begin implementing your service plugin.
Choose a framework
You can implement this service plugin with the following frameworks:
- Wix CLI: Learn how to implement a service plugin with the CLI and the SDK.
- Self-hosted: Learn how to implement a self-hosted service plugin with the SDK and the Wix Dev Center.
Configure your service plugin
To configure and customize your plugin, you need to provide important information in the service plugin configuration file. You can configure your plugin in the Wix Dev Center. For details, see Payment Settings Extension Configuration.
Define handler functions
Use paymentSettings.provideHandlers() to define the following handler functions that implement your custom business logic. Make sure you define all required functions.
| Function | Required |
|---|---|
getPaymentSettings() | Yes |
Code examples
Below is an example for implementing the Payment Settings service plugin in your code.
CLI: Basic code structure
This is the basic code structure for implementing the Payment Settings service plugin with the Wix CLI:
Self-hosted: Basic code structure
This is the basic code structure for implementing a self-hosted Payment Settings service plugin:
See also
Extension Config
To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.
If you created your service plugin extension with the CLI, required fields are automatically populated for you.
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/.
The value to set for paymentSettings.requires3dSecure if the service plugin call fails.
Default: false