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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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?