> 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

# QueryPaymentLinkPayments

# Package: paymentLinks

# Namespace: PaymentLinkPayments

# Method link: https://dev.wix.com/docs/api-reference/business-management/get-paid/payment-links/payment-link-payments/query-payment-link-payments.md

## Permission Scopes:
Manage Paylinks: SCOPE.PAYLINKS.MANAGE

## Introduction

Retrieves a list of up to 100 payment link payments given the specified paging, filtering, and sorting ([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: queryPaymentLinkPayments
 Description: Retrieves a list of up to 100 payment link payments given the specified paging, filtering, and sorting ([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/query
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: query | type: CursorQuery   | 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<Sorting> | description: Sort object.  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
 Return type: QueryPaymentLinkPaymentsResponse
  - name: paymentLinkPayments | type: array<PaymentLinkPayment> | 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: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - 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: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### Query Payment Link Payments
Retrieves relevant payment link payments, given the provided paging, filtering and sorting.

```curl
curl -X POST \
  'https://www.wixapis.com/payment-links/v1/payment-link-payments/query' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "query": {
      "sort": [
        {
          "fieldName": "createdDate",
          "order": "DESC"
        }
      ],
      "filter": {
        "createdDate": {
          "$gte": "2025-01-21T09:18:11.648Z"
        }
      },
      "cursorPaging": {
        "limit": 1
      }
    }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.paymentLinks.PaymentLinkPayments.queryPaymentLinkPayments(query)
 Description: Retrieves a list of up to 100 payment link payments given the specified paging, filtering, and sorting ([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:  query
 Method parameters: 
   param name: query | type: PaymentLinkPaymentQuery   | 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<Sorting> | description: Sort object.  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
 Return type: PROMISE<QueryPaymentLinkPaymentsResponse>
  - name: paymentLinkPayments | type: array<PaymentLinkPayment> | 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: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - 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: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### queryPaymentLinkPayments
```javascript
import { paymentLinkPayments } from '@wix/get-paid';

async function queryPaymentLinkPayments(query) {
  const response = await paymentLinkPayments.queryPaymentLinkPayments(query);
};
```

### queryPaymentLinkPayments (with elevated permissions)
```javascript
import { paymentLinkPayments } from '@wix/get-paid';
import { auth } from '@wix/essentials';

async function myQueryPaymentLinkPaymentsMethod(query) {
  const elevatedQueryPaymentLinkPayments = auth.elevate(paymentLinkPayments.queryPaymentLinkPayments);
  const response = await elevatedQueryPaymentLinkPayments(query);
}
```

### queryPaymentLinkPayments (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 queryPaymentLinkPayments(query) {
  const response = await myWixClient.paymentLinkPayments.queryPaymentLinkPayments(query);
};
```

---