About the Payment Links API

Payment links are unique URLs that Wix users can send to customers, allowing them to make convenient online payments for goods and services. Learn more about Wix payment links. Each payment link can be used multiple times to pay for the same items.

The Payment Links API enables you to create and share payment links and manage their activation status.

There are 2 types of payment links:

  • Ecom: Link for payment of custom or catalog line items. Use this type to send a customer a link to checkout for a specified list of items that either already exist in the Wix user's site (for example, Wix Stores products), or items that you manage for the site, either using the eCommerce Catalog Service Plugin, or as custom line items.
  • EcomOrder: Link for payment of an existing Wix eCommerce Order. Use this type if a customer has already created an order but hasn't paid for it yet, and specify the amount to charge the customer when you create the payment link.

Payment links can have one of the following statuses:

  • Active: The link is currently accepting payments.
  • Inactive: The link is not accepting payments.
  • Expired: The link’s validity period has ended, and payments can no longer be accepted.
  • Paid: Payment has been successfully received through the link.

Payment links can be sent to potential buyers, leading them through a checkout flow when they open the link.
Additionally, these links can initiate a checkout flow without requiring the buyer to open the payment link. This feature is particularly useful for Wix users meeting customers in person, allowing them to facilitate the checkout process directly on the Wix user's device. See the Lead a Wix user directly to a checkout page for an existing payment link use case for more information.

Before you begin

It's important to note the following points before starting to code:

  • Payment links are only available for premium sites with at least one connected payment method.
  • Payment links can be created, activated and deactivated. Once settings including price value and payment limit are set during creation, they can't be changed.
  • Payment links can't be deleted once funds have been received for them.
  • Ecom type payment links with catalog line items support the following:
  • The Initiate Payment method is not intended for use in the standard payment link flow. It is intended for Wix users meeting customers in person, allowing them to facilitate the checkout process directly on the Wix user's device.

Use Cases

Terminology

  • Payment link: Unique URLs that can be sent to customers, allowing them to make convenient online payments for goods and services. Also referred to as pay link.
Did this help?