getConfig( )


Retrieves the configuration of your payment settings plugin.

Set your payment settings configuration in the return of the getConfig() function. Wix calls this function when you publish your site. Changes to the configuration don't take effect until you publish your site.

The only default currently available is to set a fallback value for whether to require 3 domain security to an order payment if the getPaymentSettings() function fails.

Where to find getConfig()

When you add the Payment Settings service plugin, a folder is automatically added to your site. Use the -config.js file in the folder to set the default configuration for your implementation of the service plugin.

For more information on setting your configuration, see Tutorial: Payment Settings Service Plugin.

Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<PaymentSettingsConfigResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

getPaymentSettings( )


Retrieves the payment settings to apply to an order based on your custom logic. Wix passes these settings to the payment provider.

Add the custom logic to apply to an order in the return of the getPaymentSettings() function. Wix calls this function when an order is placed from the checkout page of your site.

Currently, the only payment setting available to customize is whether to apply 3 domain security (3DS) to an order. Note that if the code fails then requires3dSecure sets to the value for fallbackValueForRequires3dSecure set in getConfig().

Where to find getPaymentSettings()

When you add the Payment Settings service plugin, a folder is automatically added to your site. Use the .js file in the folder to write the code to determine which payment settings to apply to an order.

For more information on customizing your payment settings, see Tutorial: Payment Settings Service Plugin.

Method Declaration
Copy
Method Parameters
optionsOptionsRequired

The order information.


contextContextRequired

Metadata about the request.

Returns
Return Type:Promise<PaymentSettingsResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?