connectWixPaymentsAccount( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Connects a Wix Payments account to the site.

The call fails if:

  • The site's location (SDK | REST) is outside the USA.
  • A Wix Payments account is already connected to the site.
  • You don't specify {"tosAccepted": true}.

The connected Wix Payments account has the following limitations, which site owners can manage in their dashboard:

  • By default, customers can only pay via credit card, Apple Pay, or Google Pay.
  • To receive payments, site owners must complete onboarding to their Wix Payments account in the site's dashboard.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Connect Wix Payments Account
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
accountWixPaymentsAccountRequired

Wix Payments account to connect to the site.

Returns
Return Type:Promise<ConnectWixPaymentsAccountResponse>
Errors

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

Did this help?