Go Headless

/

REST
Articles
Get Started
Use the Wix MCP
What's New

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

Assets
Media
HTTP Functions
Pro Gallery

CRM
Members & Contacts
Forms
Community
Communication
Loyalty Program
CRM

Business Management
AI Site-Chat
Analytics
App Installation
Async Job
Automations
Calendar
Captcha
Categories
Cookie Consent Policy
Data Extension Schema
Dashboard
FAQ App
Get Paid
Payment Links
About the Payment Links APIs
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
Deactivate Payment Link
P
Activate Payment Link
P
Initiate Payment
P
Send Payment Link
P
Set Note
P
Update Extended Fields
P
Bulk Update Payment Link Tags
P
Bulk Update Payment Link Tags By Filter
Payment Link Created
Payment Link Deleted
Payment Link Activated
Payment Link Deactivated
Payment Link Note Set
Payment Link Payment Initiated
Payment Link Sent
Payment Link Updated
Payment Link Payments
Payment Link Settings
Receipts
Headless Authentication
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

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
idstringRead-onlyformat GUIDimmutable

Payment link ID.


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.


createdDatestringRead-onlyimmutableformat date-time

Date and time the payment link was created.


updatedDatestringRead-onlyformat date-time

Date and time the payment link was updated.


titlestringminLength 1maxLength 200

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


descriptionstringmaxLength 600

Description of the payment link.


currencystringformat CURRENCY

Currency code in ISO-4217 alphabetic format.


recipientsArray <Recipient>maxItems 50

Recipients of the payment link.


totalReceivedTotalReceivedRead-only

Total payments received.


statusstringRead-only

Payment link status.


linksLinksRead-only

Links generated for payment link, to enable sharing.


expirationDatestringimmutableformat date-time

Payment link expiration date.


paymentsLimitintegerimmutableminimum 1maximum 1000000format int32

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


availableActionsArray <string>Read-only

Available actions for this payment link.


sourceSource

Payment link source.


displayDataDisplayData

Display data for payment link checkout.


lastPaymentDatestringRead-onlyformat date-time

Last payment date.


noteNote

Free text note attached to the payment link.


typestring

Payment link type.


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.


tagsTags

Tags.


One Of
Choose one of the following parameters

ecomPaymentLinkEcomPaymentLink

Details about the items being paid for.


ecomOrderPaymentLinkEcomOrderPaymentLink

Details about the existing Wix eCommerce order being paid for.

Did this help?