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
function getPaymentSettings(
  options: Options,
  context: Context,
): Promise<PaymentSettingsResponse>;
Method Parameters
optionsOptionsRequired

The order information.


contextContextRequired

Metadata about the request.

Returns
Return Type:Promise<PaymentSettingsResponse>
JavaScript
export const getPaymentSettings = (options) => { return { paymentSettings: { requires3dSecure: true, }, }; };
Errors

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

Did this help?