Go Headless

Changelog

API Reference
Articles
Platform Overview
Authentication
Work with Wix APIs
SDK Setup and Usage
AI Tools

App Management
OAuth 2
App Billing
App Instance
App Permissions
Embedded Scripts
BI Event
Editor Deep Link
Site Plugins
Market Listing V1

Business Solutions
eCommerce
Stores
Bookings
CMS
Events
Restaurants
Blog
Forum
Pricing Plans
Portfolio
Benefit Programs
Donations
Suppliers Hub
Gift Cards
Coupons

Assets
Media
HTTP Functions
Rich Content
Pro Gallery

CRM
Members & Contacts
Forms
Community
Communication
Loyalty Program
CRM

Business Management
AI Site-Chat
Analytics
App Installation
Async Job
Automations
Branches
Calendar
Captcha
Cookie Consent Policy
Custom Embeds
Data Extension Schema
Dashboard
FAQ App
Functions
Get Paid
Introduction
Billable Items
Bulk Downloads
Payment Links
Receipts
Headless
Locations
Marketing
Multilingual
Notifications
Online Programs
Payments
Site Search
Secrets
Site Properties
Site URLs
Tags

Account Level
About Account Level APIs
Sites
Resellers
Domains
B2B Site Management
User Management

Site
Viewer
In This Article

  1. When to Use Which Type
  2. Send Flow
  3. Prerequisites
  4. Common Errors
  5. API Documentation References

Payment Links for Bookings

View the file in GitHub
Download skill
Copy

Use this recipe to collect payment for booking-related flows by generating payment links with the Payment Links API.

When to Use Which Type

Use ECOM_ORDER for existing unpaid orders

If a booking already has an associated unpaid eCommerce order, create an ECOM_ORDER payment link.

Copy

Notes:

  • orderId must exist and be unpaid.
  • ECOM_ORDER links require paymentsLimit: 1.

Use ECOM for ad-hoc booking charges

If there is no existing order, create an ECOM payment link with custom line items.

Copy

Send Flow

Creating a payment link does not deliver it. Send it explicitly:

  • POST https://www.wixapis.com/payment-links/v1/payment-links/{paymentLinkId}/send
Copy

Prerequisites

Before creating booking payment links, ensure:

  1. Site is premium.
  2. Site is published.
  3. Site is set up to accept payments.
  4. Required payment-link permissions are granted to the app.
  5. Recipient contacts exist if you plan to send links.

Common Errors

Error CodeMeaning
UNPUBLISHED_SITESite must be published before creating payment links
MISSING_ACCEPT_PAYMENTSSite is not set up to accept payments
ORDER_NOT_FOUNDThe provided order ID does not exist
INVALID_PAYMENTS_LIMIT_FOR_ECOM_ORDER_PAYMENT_LINKECOM_ORDER links require paymentsLimit: 1
RECIPIENT_NOT_FOUNDRecipient contact ID does not exist

API Documentation References

  • Create Payment Link
  • Send Payment Link
Did this help?