Develop Websites
Go Headless

/

REST
Articles
Getting Started
What's New

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

Business Solutions
eCommerce
Stores
Bookings
CMS
Events
Restaurants
Blog
Forum
Pricing Plans
Portfolio

Assets
Media
HTTP Functions
Pro Gallery

CRM
Members & Contacts
Forms
Community
Communication
Loyalty Program
CRM

Business Management
AI Site-Chat
Analytics
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
Payment Link Payments
Introduction
Sample Flows
Filtering and Sorting
Payment Link Payment Object
P
Query Payment Link Payments
P
Search Payment Link Payments
P
Issue Receipt
Link Payment Created
Link Payment Updated
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 Payment Object


A payment link payment contains details of a payment made using payment links.

Properties
idstringformat GUID

Payment link payment ID. When a gift card is used, this is the gift card payment ID. Otherwise, this is the transaction ID associated with the relevant payment type.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the payment link payment is updated.


createdDatestringRead-onlyformat date-time

Date and time the payment was created.


amountstringformat DECIMAL_VALUEdecimalValue {"gte":"0","lte":"1000000000000000","maxScale":3}

Payment amount.


paymentLinkIdstringformat GUID

Payment link ID associated with the payment.


receiptIdstringRead-onlyformat GUID

Receipt ID associated with the payment, available in the Get Paid Receipts API.


typestring

Payment type.


currencystringRead-onlyformat CURRENCY

Currency code in ISO-4217 alphabetic format.


transactionDatestringformat date-time

Date and time the payment transaction was created.


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.


One Of
Choose one of the following parameters

regularPaymentLinkPaymentRegularPaymentLinkPayment

Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all supported payment gateways.


giftCardPaymentLinkPaymentGiftCardPaymentLinkPayment

Wix eCommerce gift card payment details.


One Of
Choose one of the following parameters

ecomCheckoutEcomCheckout

Wix eCommerce checkout.


ecomOrderCheckoutEcomOrderCheckout

Wix eCommerce order checkout.

Did this help?