/wix-manage

Payment Links for Bookings

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.

{
  "paymentLink": {
    "title": "Booking Balance",
    "currency": "USD",
    "type": "ECOM_ORDER",
    "paymentsLimit": 1,
    "ecomOrderPaymentLink": {
      "orderId": "ORDER_ID",
      "amount": "50"
    }
  }
}

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.

{
  "paymentLink": {
    "title": "Booking Fee",
    "currency": "USD",
    "type": "ECOM",
    "ecomPaymentLink": {
      "lineItems": [
        {
          "type": "CUSTOM",
          "customItem": {
            "name": "Booking Fee",
            "quantity": 1,
            "price": "50.00"
          }
        }
      ]
    }
  }
}

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

{
  "paymentLinkId": "PAYMENT_LINK_ID",
  "recipients": [
    {
      "contactId": "CONTACT_ID",
      "sendMethods": ["EMAIL_METHOD"]
    }
  ]
}

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

API Documentation References

• Create Payment Link
• Send Payment Link