Go Headless

Changelog

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

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

Business Solutions
eCommerce
Stores
Bookings
CMS
Events
Restaurants
Blog
Forum
Pricing Plans
Portfolio
Benefit Programs
Donations
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
Introduction
Payment Links
Introduction
Sample Flows
Filtering and Sorting
Introduction to Settings
Payment Link Object
P
Create Payment Link
G
Get Payment Link
D
Delete Payment Link
P
Query Payment Links
P
Search Payment Links
P
Activate Payment Link
P
Bulk Update Payment Link Tags
P
Bulk Update Payment Link Tags By Filter
P
Deactivate Payment Link
P
Initiate Payment
P
Send Payment Link
P
Set Note
P
Update Extended Fields
Payment Link Activated
Payment Link Created
Payment Link Deactivated
Payment Link Deleted
Payment Link Note Set
Payment Link Payment Initiated
Payment Link Sent
Payment Link Updated
Payment Link Payments
Payment Link Settings
Receipts
Headless
Locations
Marketing
Multilingual
Notifications
Payments
Site Search
Secrets
Site Properties
Site URLs
Tags

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

Site
Viewer

Payment Link Object


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 payment links.

Properties
availableActionsArray <string>Read-only

Available actions for this payment link.


createdDatestringRead-onlyimmutableformat date-time

Date and time the payment link was created.


currencystringformat CURRENCY

Currency code in ISO-4217 alphabetic format.


descriptionstringmaxLength 600

Description of the payment link.


displayDataDisplayData

Display data for payment link checkout.


expirationDatestringimmutableformat date-time

Payment link expiration date.


extendedFieldsExtendedFields

Custom field data for the payment link.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUIDimmutable

Payment link ID.


lastPaymentDatestringRead-onlyformat date-time

Last payment date.


linksLinksRead-only

Links generated for payment link, to enable sharing.


noteNote

Free text note attached to the payment link.


paymentsLimitintegerimmutableminimum 1maximum 1000000format int32

Limit on the total number of payments that can be processed using this payment link.


recipientsArray <Recipient>maxItems 50

Recipients of the payment link.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the payment link is updated. To prevent conflicting changes, the existing revision must be specified when updating a payment link.


sourceSource

Payment link source.


statusstringRead-only

Payment link status.


tagsTags

Tags.


titlestringminLength 1maxLength 200

Title of the payment link. Non-visible characters will be trimmed upon creation.


totalReceivedTotalReceivedRead-only

Total payments received.


typestring

Payment link type. Must be passed in accordance with either ecomPaymentLink or ecomOrderPaymentLink. If ecomPaymentLink is selected, then payment link type must be 'ECOM', if ecomOrderPaymentLink is selected, then payment link type must be 'ECOM_ORDER'.


One Of

ecomOrderPaymentLinkEcomOrder

Details about the existing Wix eCommerce order being paid for.


ecomPaymentLinkEcom

Details about the items being paid for.


updatedDatestringRead-onlyformat date-time

Date and time the payment link was updated.

Did this help?