searchPaymentLinkPayments( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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`
`amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`giftCardPaymentLinkPayment.contactDetails.vatId.type`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`regularPaymentLinkPayment.contactDetails.vatId.type`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`regularPaymentLinkPayment.method`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`regularPaymentLinkPayment.order.type`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`regularPaymentLinkPayment.paymentMethod`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`regularPaymentLinkPayment.paymentProvider`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`transactionDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`type`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`_id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`giftCardPaymentLinkPayment.contactDetails.vatId._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`giftCardPaymentLinkPayment.ecomOrderId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`paymentLinkId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`regularPaymentLinkPayment.contactDetails.vatId._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`regularPaymentLinkPayment.order.ecomOrder.ecomOrderId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`giftCardPaymentLinkPayment.contactDetails.company`	Search: ✓ Aggregate: ✗ Sort: ✗
`giftCardPaymentLinkPayment.contactDetails.email`	Search: ✓ Aggregate: ✗ Sort: ✗
`giftCardPaymentLinkPayment.contactDetails.firstName`	Search: ✓ Aggregate: ✗ Sort: ✗
`giftCardPaymentLinkPayment.contactDetails.fullName`	Search: ✓ Aggregate: ✗ Sort: ✗
`giftCardPaymentLinkPayment.contactDetails.lastName`	Search: ✓ Aggregate: ✗ Sort: ✗
`regularPaymentLinkPayment.contactDetails.company`	Search: ✓ Aggregate: ✗ Sort: ✗
`regularPaymentLinkPayment.contactDetails.email`	Search: ✓ Aggregate: ✗ Sort: ✗
`regularPaymentLinkPayment.contactDetails.firstName`	Search: ✓ Aggregate: ✗ Sort: ✗
`regularPaymentLinkPayment.contactDetails.fullName`	Search: ✓ Aggregate: ✗ Sort: ✗
`regularPaymentLinkPayment.contactDetails.lastName`	Search: ✓ Aggregate: ✗ Sort: ✗

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

searchCursorSearchRequired

Search options.

Returns

Return Type:Promise<SearchPaymentLinkPaymentsResponse>

Errors

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

Did this help?