POST

Query Payment Links

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of up to 100 payment links, given the specified filters, sorting, and paging (SDK | REST).

PropertyFiltersSort
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
paymentsLimit$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
status$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
source$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
totalReceived.paymentCount$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Paylinks
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?