POST

Query Payment Link Payments

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 link payments given the specified paging, filtering, and sorting (SDK | REST).

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Paylinks
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/payment-links/v1/payment-link-payments/query
Body Params
queryQueryRequired

Query options.

Response Object
paymentLinkPaymentsArray <PaymentLinkPayment>

Retrieved payment link payments.

pagingMetadataPagingMetadata

Paging metadata.

Query Payment Link Payments

Retrieves relevant payment link payments, given the provided paging, filtering and sorting.

Request
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
      }
    }
  }'
Response
JSON
{
  "paymentLinkPayments": [
    {
      "id": "afb2f6c0-e497-4c69-9ddb-be8c82351456",
      "revision": "2",
      "createdDate": "2025-01-21T09:18:11.648Z",
      "amount": "10.99",
      "paymentLinkId": "6a206d71-52f5-4012-b3dd-8a283fea052e",
      "receiptId": "92161421-7897-40ed-9af5-5bc3b1f1fdeb",
      "type": "REGULAR",
      "regularPaymentLinkPayment": {
        "paymentMethod": "creditCard",
        "paymentProvider": "Credit/Debit Cards",
        "contactDetails": {
          "firstName": "John",
          "lastName": "Doe",
          "phone": "0123456789",
          "company": "Green Car Toys",
          "email": "business@example.com",
          "vatId": {
            "id": "12345678",
            "type": "CPF"
          },
          "fullName": "John Doe"
        },
        "billingAddress": {
          "country": "US",
          "subdivision": "NY",
          "city": "New York City",
          "postalCode": "10000",
          "streetAddress": {
            "number": "1234",
            "name": "Example",
            "apt": "12A"
          },
          "formattedAddress": "NY, Example 12A"
        },
        "creditCardPaymentMethodData": {
          "network": "visa",
          "maskedCreditCard": "**** **** **** 5678",
          "holderName": "John Doe"
        },
        "order": {
          "type": "ECOM",
          "ecomOrder": {
            "ecomOrderId": "095159f9-9f44-4ce0-a06f-312d59d56760"
          }
        },
        "method": "CREDIT_CARD"
      },
      "currencyCode": "USD",
      "ecomCheckout": {
        "ecomCheckoutId": "e19d84b5-dd8d-4621-92af-abc04b8903d9"
      }
    }
  ],
  "pagingMetadata": {
    "count": 1,
    "cursors": {
      "next": "4345521e3755de483c934d1c618543f5f46ba737.EjkqNwo1CgxfY3JlYXRlZERhdGUSJSojCiEKAyRsdBIaGhgyMDI1LTAxLTIxVDEwOjU5OjM3LjQ0OVoaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAAGx7gkh5QiIkYWZiMmY2YzAtZTQ5Ny00YzY5LTlkZGItYmU4YzgyMzUxNDU2"
    },
    "hasNext": true
  }
}
Errors

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

Did this help?