# Payment Queries

Query your payments data based on a variety of parameters.

__Authentication__ 

Set your headers:

  ```
    Authorization: {your_credentials}
    Accept: application/vnd.worldpay.payment-queries-v1.hal+json
  ```
Replace `{your_credentials}` with your base64-encoded Basic Auth username and password.

<br><br>
__DNS whitelisting__

Whitelist the following URLs:
* `https://try.access.worldpay.com/`
* `https://access.worldpay.com/`

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

Version: 1
Metadata:
  - category: ["Query Payments"]
  - business: ["Enterprise"]
  - catalog-list: true
  - generated: false

## Servers

Test (Try)
```
https://try.access.worldpay.com
```

Live
```
https://access.worldpay.com
```

## Security

### BasicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[Payment Queries](https://worldpay-portal.eu.redocly.app/access/_bundle/products/payment-queries/@v1/openapi.yaml)

## Other

### Query payments

 - [GET /paymentQueries/payments](https://worldpay-portal.eu.redocly.app/access/products/payment-queries/openapi/other/querybydaterange.md): Query payments within a specified date time range.

These payments can be filtered by currency, minAmount, maxAmount, last4Digits & receivedEvents.

The API returns data for payments processed after 25 June 2024. For payments processed before then use our query for historical payments.

### Retrieve a payment

 - [GET /paymentQueries/payments/{paymentId}](https://worldpay-portal.eu.redocly.app/access/products/payment-queries/openapi/other/retrievebypaymentid.md): Retrieve a single payment by payment ID.

The API returns detailed data for payments processed after 25 June 2024. For payments processed before then use our query for historical payments.

### Query historical payments

 - [GET /paymentQueries/archivedPayments](https://worldpay-portal.eu.redocly.app/access/products/payment-queries/openapi/other/queryarchivedpayments.md): Query payments processed before 25 June 2024.

Provide a transactionReference and entityReference for a payment to find the matching payment in the archive.