> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # SearchPaymentLinkPayments # Package: paymentLinks # Namespace: PaymentLinkPayments # Method link: https://dev.wix.com/docs/api-reference/business-management/get-paid/payment-links/payment-link-payments/search-payment-link-payments.md ## Permission Scopes: Manage Paylinks: SCOPE.PAYLINKS.MANAGE ## Introduction Retrieves a list of up to 100 payment links, given the specified filtering, search expression, sorting, and cursor paging ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language.md) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)). --- ## REST API ### Schema ``` Method: searchPaymentLinkPayments Description: Retrieves a list of up to 100 payment links, given the specified filtering, search expression, sorting, and cursor paging ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language.md) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)). URL: https://www.wixapis.com/payment-links/v1/payment-link-payments/search Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: search Method parameters: param name: search | type: CursorSearch | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: List of sort objects. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: aggregations | type: array | description: Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. - ONE-OF: - name: includeOptions | type: IncludeMissingValuesOptions | description: Options for including missing values in results. - name: addToBucket | type: string | description: Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans. - name: sortType | type: SortType | description: Sort type. - enum: - COUNT: Number of matches in the results. - VALUE: Alphabetically by the field value. - name: sortDirection | type: SortDirection | description: Sort direction. - enum: - DESC: Descending order. - ASC: Ascending order. - name: limit | type: integer | description: Number of aggregation results to return. Min: `1` Max: `250` Default: `10` - name: missingValues | type: MissingValues | description: Whether to include or exclude missing values in the aggregation results. Default: `EXCLUDE`. - enum: - EXCLUDE: Exclude missing values from the aggregation results. - INCLUDE: Include missing values in the aggregation results. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. - name: buckets | type: array | description: List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds. - name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not specified. - name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not specified. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: type | type: ScalarType | description: Operator type for the scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. - name: interval | type: Interval | description: Interval for date histogram aggregation. - enum: YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND - name: nested | type: NestedAggregation | description: A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. - name: nestedAggregations | type: array | description: Flattened list of aggregations, where each next aggregation is nested within the previous one. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: name | type: string | description: Unique, caller-defined aggregation name, returned in `aggregations.results`. - name: type | type: NestedAggregationType | description: Type of aggregation to perform. The matching aggregation field must be passed. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: name | type: string | description: Aggregation name, returned in `aggregations.results.name`. - name: type | type: AggregationType | description: Type of aggregation to perform. Must align with the corresponding aggregation field. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: search | type: SearchDetails | description: Free text to match in searchable fields. - name: mode | type: Mode | description: Search mode. Defines the search logic for combining multiple terms in the `expression`. - enum: - OR: Any of the search terms must be present. - AND: All search terms must be present. - name: expression | type: string | description: Search term or expression. - name: fields | type: array | description: Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`. - name: fuzzy | type: boolean | description: Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. - name: timeZone | type: string | description: Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone GUIDs) format. Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z". Return type: SearchPaymentLinkPaymentsResponse - name: paymentLinkPayments | type: array | description: Retrieved payment link payments. - ONE-OF: - name: regularPaymentLinkPayment | type: RegularPaymentLinkPayment | description: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways). - ONE-OF: - name: creditCardPaymentMethodData | type: CreditCardPaymentMethodData | description: Credit card payment method data. - name: network | type: string | description: Card network. - name: maskedCreditCard | type: string | description: Masked card number. - name: holderName | type: string | description: Card holder name. - name: walletPaymentMethodData | type: WalletPaymentMethodData | description: Wallet payment method data. - name: buyerAccountEmail | type: string | description: Buyer account email. - name: paymentMethod | type: string | description: Payment method. - name: paymentProvider | type: string | description: Payment service provider. - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details. - name: firstName | type: string | description: Contact's first name. - name: lastName | type: string | description: Contact's last name. - name: phone | type: string | description: Contact's phone number. - name: company | type: string | description: Contact's company name. - name: email | type: string | description: Email associated with the address. - name: vatId | type: VatId | description: Tax info. - name: id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: contactId | type: string | description: Buyer contact GUID, if relevant. - name: billingAddress | type: Address | description: Buyer's billing address. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street name and number. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line, usually street and number as free text. - name: country | type: string | description: Country code. - name: subdivision | type: string | description: Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip/postal code. - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. - name: method | type: PaymentMethod | description: Payment method type. - enum: - UNKNOWN_METHOD_DATA: - CREDIT_CARD: Credit card. - WALLET: Wallet. - name: order | type: PaymentOrder | description: Payment order. - ONE-OF: - name: ecomOrder | type: Ecom | description: Wix eCommerce order details. - name: ecomOrderId | type: string | description: Wix eCommerce order GUID. - name: cashierOrder | type: Cashier | description: Wix Cashier order details. - name: cashierOrderId | type: string | description: Wix Cashier payment order GUID. - name: type | type: OrderType | description: Payment order type. - enum: - UNKNOWN_ORDER_TYPE: - ECOM: Wix eCommerce order type. - CASHIER: Wix Cashier order type. - name: giftCardPaymentLinkPayment | type: GiftCardPaymentLinkPayment | description: Wix eCommerce gift card payment details. - name: ecomOrderId | type: string | description: Wix eCommerce order GUID associated with the gift card payment. - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details. - name: contactId | type: string | description: Buyer contact GUID, if relevant. - name: billingAddress | type: Address | description: Buyer's billing address. - ONE-OF: - name: ecomCheckout | type: EcomCheckout | description: Wix eCommerce checkout. - name: ecomCheckoutId | type: string | description: Wix eCommerce checkout GUID. - name: ecomOrderCheckout | type: EcomOrderCheckout | description: Wix eCommerce order checkout. - name: orderPaymentRequestId | type: string | description: Wix eCommerce order payment request GUID. - name: id | type: string | description: Payment link payment GUID. When a gift card is used, this is the gift card payment GUID. Otherwise, this is the transaction GUID associated with the relevant payment type. - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link payment is updated. - name: createdDate | type: string | description: Date and time the payment was created. - name: amount | type: string | description: Payment amount. - name: paymentLinkId | type: string | description: Payment link GUID associated with the payment. - name: receiptId | type: string | description: Receipt GUID associated with the payment, available in the Get Paid Receipts API. - name: type | type: PaymentLinkPaymentType | description: Payment type. - enum: - UNKNOWN_PAYMENT_TYPE: Unknown payment type. - REGULAR: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways). - GIFT_CARD: Payment using a Wix eCommerce gift card. - name: currency | type: string | description: Currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. - name: transactionDate | type: string | description: Date and time the payment transaction was created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the payment link. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: PagingMetadataV2 | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: aggregationData | type: AggregationData | description: Response aggregation data. - name: results | type: array | description: List of the aggregated data results. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: results | type: array | description: List of value aggregations. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Number of entities with this value. - name: ranges | type: RangeResults | description: Range aggregation results. - name: results | type: array | description: List of ranges returned in same order as requested. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Total number of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: type | type: ScalarType | description: Type of scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: value | type: number | description: Value of the scalar aggregation. - name: groupedByValue | type: GroupByValueResults | description: Group by value aggregation results. - name: results | type: array | description: List of value aggregations. - name: value | type: string | description: Value of the field. - name: nestedResults | type: NestedAggregationResults | description: Nested aggregations. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: ranges | type: RangeResults | description: Range aggregation results. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: name | type: string | description: Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. - name: type | type: AggregationType | description: Aggregation type. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field which the data was aggregated by. - name: dateHistogram | type: DateHistogramResults | description: Date histogram aggregation results. - name: results | type: array | description: List of date histogram aggregations. - name: value | type: string | description: Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - name: count | type: integer | description: Number of entities in the bucket. - name: nested | type: NestedResults | description: Nested aggregation results. - name: results | type: array | description: List of nested aggregations. - name: results | type: Map | description: List of nested aggregations. - ONE-OF: - name: value | type: ValueResult | description: Value aggregation result. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Number of entities with this value. - name: range | type: RangeResult | description: Range aggregation result. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Number of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation result. - name: value | type: number | description: Value of the scalar aggregation. - name: dateHistogram | type: ValueResult | description: Date histogram aggregation result. - name: name | type: string | description: Aggregation name, returned in `aggregations.results.name`. - name: type | type: AggregationType | description: Aggregation type. Must align with the corresponding aggregation field. - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. ``` ### Examples ### Search Payment Link Payments Retrieves relevant payment link payments, given the provided paging, filtering, sorting and aggregations. ```curl curl -X POST \ 'https://www.wixapis.com/payment-links/v1/payment-link-payments/search' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-binary '{ "search": { "sort": [ { "fieldName": "createdDate", "order": "DESC" } ], "search": { "expression": "Joh", "fields": [ "regularPaymentLinkPayment.contactDetails.firstName" ], "fuzzy": true }, "cursorPaging": { "limit": 1 } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.paymentLinks.PaymentLinkPayments.searchPaymentLinkPayments(search) Description: Retrieves a list of up to 100 payment links, given the specified filtering, search expression, sorting, and cursor paging ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language.md) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: search Method parameters: param name: search | type: CursorSearch | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: List of sort objects. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: aggregations | type: array | description: Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. - ONE-OF: - name: includeOptions | type: IncludeMissingValuesOptions | description: Options for including missing values in results. - name: addToBucket | type: string | description: Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans. - name: sortType | type: SortType | description: Sort type. - enum: - COUNT: Number of matches in the results. - VALUE: Alphabetically by the field value. - name: sortDirection | type: SortDirection | description: Sort direction. - enum: - DESC: Descending order. - ASC: Ascending order. - name: limit | type: integer | description: Number of aggregation results to return. Min: `1` Max: `250` Default: `10` - name: missingValues | type: MissingValues | description: Whether to include or exclude missing values in the aggregation results. Default: `EXCLUDE`. - enum: - EXCLUDE: Exclude missing values from the aggregation results. - INCLUDE: Include missing values in the aggregation results. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. - name: buckets | type: array | description: List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds. - name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not specified. - name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not specified. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: type | type: ScalarType | description: Operator type for the scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. - name: interval | type: Interval | description: Interval for date histogram aggregation. - enum: YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND - name: nested | type: NestedAggregation | description: A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. - name: nestedAggregations | type: array | description: Flattened list of aggregations, where each next aggregation is nested within the previous one. - ONE-OF: - name: value | type: ValueAggregation | description: A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. - name: range | type: RangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: scalar | type: ScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - name: dateHistogram | type: DateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. - name: name | type: string | description: Unique, caller-defined aggregation name, returned in `aggregations.results`. - name: type | type: NestedAggregationType | description: Type of aggregation to perform. The matching aggregation field must be passed. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: name | type: string | description: Aggregation name, returned in `aggregations.results.name`. - name: type | type: AggregationType | description: Type of aggregation to perform. Must align with the corresponding aggregation field. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. - name: search | type: SearchDetails | description: Free text to match in searchable fields. - name: mode | type: Mode | description: Search mode. Defines the search logic for combining multiple terms in the `expression`. - enum: - OR: Any of the search terms must be present. - AND: All search terms must be present. - name: expression | type: string | description: Search term or expression. - name: fields | type: array | description: Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`. - name: fuzzy | type: boolean | description: Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. - name: timeZone | type: string | description: Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone GUIDs) format. Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z". Return type: PROMISE - name: paymentLinkPayments | type: array | description: Retrieved payment link payments. - ONE-OF: - name: regularPaymentLinkPayment | type: RegularPaymentLinkPayment | description: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways). - ONE-OF: - name: creditCardPaymentMethodData | type: CreditCardPaymentMethodData | description: Credit card payment method data. - name: network | type: string | description: Card network. - name: maskedCreditCard | type: string | description: Masked card number. - name: holderName | type: string | description: Card holder name. - name: walletPaymentMethodData | type: WalletPaymentMethodData | description: Wallet payment method data. - name: buyerAccountEmail | type: string | description: Buyer account email. - name: paymentMethod | type: string | description: Payment method. - name: paymentProvider | type: string | description: Payment service provider. - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details. - name: firstName | type: string | description: Contact's first name. - name: lastName | type: string | description: Contact's last name. - name: phone | type: string | description: Contact's phone number. - name: company | type: string | description: Contact's company name. - name: email | type: string | description: Email associated with the address. - name: vatId | type: VatId | description: Tax info. - name: _id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: contactId | type: string | description: Buyer contact GUID, if relevant. - name: billingAddress | type: Address | description: Buyer's billing address. - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: addressLine1 | type: string | description: none - name: addressLine2 | type: string | description: none - name: method | type: PaymentMethod | description: Payment method type. - enum: - UNKNOWN_METHOD_DATA: - CREDIT_CARD: Credit card. - WALLET: Wallet. - name: order | type: PaymentOrder | description: Payment order. - ONE-OF: - name: ecomOrder | type: Ecom | description: Wix eCommerce order details. - name: ecomOrderId | type: string | description: Wix eCommerce order GUID. - name: cashierOrder | type: Cashier | description: Wix Cashier order details. - name: cashierOrderId | type: string | description: Wix Cashier payment order GUID. - name: type | type: OrderType | description: Payment order type. - enum: - UNKNOWN_ORDER_TYPE: - ECOM: Wix eCommerce order type. - CASHIER: Wix Cashier order type. - name: giftCardPaymentLinkPayment | type: GiftCardPaymentLinkPayment | description: Wix eCommerce gift card payment details. - name: ecomOrderId | type: string | description: Wix eCommerce order GUID associated with the gift card payment. - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details. - name: contactId | type: string | description: Buyer contact GUID, if relevant. - name: billingAddress | type: Address | description: Buyer's billing address. - ONE-OF: - name: ecomCheckout | type: EcomCheckout | description: Wix eCommerce checkout. - name: ecomCheckoutId | type: string | description: Wix eCommerce checkout GUID. - name: ecomOrderCheckout | type: EcomOrderCheckout | description: Wix eCommerce order checkout. - name: orderPaymentRequestId | type: string | description: Wix eCommerce order payment request GUID. - name: _id | type: string | description: Payment link payment GUID. When a gift card is used, this is the gift card payment GUID. Otherwise, this is the transaction GUID associated with the relevant payment type. - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link payment is updated. - name: _createdDate | type: Date | description: Date and time the payment was created. - name: amount | type: string | description: Payment amount. - name: paymentLinkId | type: string | description: Payment link GUID associated with the payment. - name: receiptId | type: string | description: Receipt GUID associated with the payment, available in the Get Paid Receipts API. - name: type | type: PaymentLinkPaymentType | description: Payment type. - enum: - UNKNOWN_PAYMENT_TYPE: Unknown payment type. - REGULAR: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways). - GIFT_CARD: Payment using a Wix eCommerce gift card. - name: currency | type: string | description: Currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. - name: transactionDate | type: Date | description: Date and time the payment transaction was created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the payment link. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: pagingMetadata | type: PagingMetadataV2 | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: aggregationData | type: AggregationData | description: Response aggregation data. - name: results | type: array | description: List of the aggregated data results. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: results | type: array | description: List of value aggregations. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Number of entities with this value. - name: ranges | type: RangeResults | description: Range aggregation results. - name: results | type: array | description: List of ranges returned in same order as requested. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Total number of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: type | type: ScalarType | description: Type of scalar aggregation. - enum: - COUNT_DISTINCT: Total number of distinct values. - MIN: Minimum value. - MAX: Maximum value. - name: value | type: number | description: Value of the scalar aggregation. - name: groupedByValue | type: GroupByValueResults | description: Group by value aggregation results. - name: results | type: array | description: List of value aggregations. - name: value | type: string | description: Value of the field. - name: nestedResults | type: NestedAggregationResults | description: Nested aggregations. - ONE-OF: - name: values | type: ValueResults | description: Value aggregation results. - name: ranges | type: RangeResults | description: Range aggregation results. - name: scalar | type: ScalarResult | description: Scalar aggregation results. - name: name | type: string | description: Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. - name: type | type: AggregationType | description: Aggregation type. - enum: - VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. - RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. - SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. - DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). - NESTED: Flattened list of aggregations, where each aggregation is nested within previous one. - name: fieldPath | type: string | description: Field which the data was aggregated by. - name: dateHistogram | type: DateHistogramResults | description: Date histogram aggregation results. - name: results | type: array | description: List of date histogram aggregations. - name: value | type: string | description: Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - name: count | type: integer | description: Number of entities in the bucket. - name: nested | type: NestedResults | description: Nested aggregation results. - name: results | type: array | description: List of nested aggregations. - name: results | type: Map | description: List of nested aggregations. - ONE-OF: - name: value | type: ValueResult | description: Value aggregation result. - name: value | type: string | description: Value of the field. - name: count | type: integer | description: Number of entities with this value. - name: range | type: RangeResult | description: Range aggregation result. - name: from | type: number | description: Inclusive lower bound of the range. - name: to | type: number | description: Exclusive upper bound of the range. - name: count | type: integer | description: Number of entities in this range. - name: scalar | type: ScalarResult | description: Scalar aggregation result. - name: value | type: number | description: Value of the scalar aggregation. - name: dateHistogram | type: ValueResult | description: Date histogram aggregation result. - name: name | type: string | description: Aggregation name, returned in `aggregations.results.name`. - name: type | type: AggregationType | description: Aggregation type. Must align with the corresponding aggregation field. - name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`. ``` ### Examples ### searchPaymentLinkPayments ```javascript import { paymentLinkPayments } from '@wix/get-paid'; async function searchPaymentLinkPayments(search) { const response = await paymentLinkPayments.searchPaymentLinkPayments(search); }; ``` ### searchPaymentLinkPayments (with elevated permissions) ```javascript import { paymentLinkPayments } from '@wix/get-paid'; import { auth } from '@wix/essentials'; async function mySearchPaymentLinkPaymentsMethod(search) { const elevatedSearchPaymentLinkPayments = auth.elevate(paymentLinkPayments.searchPaymentLinkPayments); const response = await elevatedSearchPaymentLinkPayments(search); } ``` ### searchPaymentLinkPayments (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { paymentLinkPayments } from '@wix/get-paid'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { paymentLinkPayments }, // Include the auth strategy and host as relevant }); async function searchPaymentLinkPayments(search) { const response = await myWixClient.paymentLinkPayments.searchPaymentLinkPayments(search); }; ``` ---