Go Headless

/

SDK
Articles
Get Started
Work with the SDK
Set up a Client
Use the Wix MCP
What's New

Core Modules
About Core Modules
sdk
sdk-react (deprecated)
essentials
web-methods

Host Modules
About Host Modules
dashboard
dashboard-react (deprecated)
editor
site

Backend Modules
About Backend Modules
activity-counters
analytics
async-jobs
ai-site-chat
app-management
auth-management
automations
benefit-programs
billing
blog
bookings
business-tools
cache
calendar
captcha
categories
comments
consent-policy
crm
dashboard-management
data
data-extension-schemas
ecom
email-marketing
email-subscriptions
embeds
events
forms
forum
get-paid
Payment Links
About the Payment Links APIs
PaymentLinks
PaymentLinkPayments
Introduction
Setup
SampleFlows
issueReceipt()
queryPaymentLinkPayments()
searchPaymentLinkPayments()
onPaymentLinkPaymentCreated()
onPaymentLinkPaymentUpdated()
PaymentLinkPaymentsQueryBuilder
PaymentLinkPaymentsQueryResult
PaymentLinksSettings
Receipts
BulkDownloads
groups
http-functions
identity
inbox
loyalty
marketing
marketing-consent
marketing-tags
media
members
moderation-rules
multilingual
notifications
payments
portfolio
pricing-plans
pro-gallery
redirects
reports
restaurants
reviews
search
secrets
stores
tags
urls
site-plugins
sender-details
sender-emails
realtime

Account Level Modules
About Account Level APIs
b2b-site-management
domains
resellers
user-management
sites

Frontend Modules
About Frontend Modules
bookings
crm
ecom
events
location
members
mobile
navigate-mobile
pay
pricing-plans
seo
site
storage
stores
window
site-realtime

Sample Use Cases and Flows

This article shares some possible use cases you can support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your implementation.

Display all payments for a payment link

You can display all payment data for a specified payment link by completing the following steps:

  1. Call Search Payment Links to retrieve all payment links.
  2. Display all payment links.
  3. When the Wix user selects a specific payment link, call either of the following and specify the requested paymentLinkId:
    • Query Payment Link Payments.
    • Search Payment Link Payments.
  4. Display the returned data.

Issue a receipt for payment

You can issue a receipt for a payment made using a payment link by completing the following steps:

  1. Call Search Payment Link Payments to retrieve all payments.
  2. Display all payments.
  3. When the Wix user selects a payment to create a receipt, call Issue Receipt.
  4. If relevant, send the receipt to the buyer. Call Get Contact with the buyer's contact ID to get their email address.
Did this help?