Retrieves a list of up to 100 payment links, given the specified filtering, search expression, sorting, and cursor paging (SDK | REST).
| Property | Capabilities | Filters |
|---|---|---|
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
currency | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
expirationDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
lastPaymentDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
paymentsLimit | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
status | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
totalReceived.amount | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
totalReceived.paymentCount | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
totals.balance | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
totals.paymentCount | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
recipients.contactId | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
recipients.sendMethods | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
source.appId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
source.ecomReference.orderId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
source.entityId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
description | Search: ✓ Aggregate: ✗ Sort: ✗ | |
links.url.url | Search: ✓ Aggregate: ✗ Sort: ✗ | |
note.text | Search: ✓ Aggregate: ✗ Sort: ✗ | |
price | Search: ✓ Aggregate: ✗ Sort: ✗ | |
title | Search: ✓ Aggregate: ✗ Sort: ✗ |
You can only call this method when authenticated as a Wix app or Wix user identity.
There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.