The PaymentQueries API from Worldpay — 3 operation(s) for paymentqueries.
openapi: 3.0.1
info:
title: 3DS 3DS actions PaymentQueries API
description: "Protect your business and meet regulatory requirements by verifying your customer's identity.\n\n__Authentication header__\n ```\n Authorization: {your_credentials}\n ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our 3DS API.\n\n__Accept/Content-Type header__\n ```\n Content-Type: application/vnd.worldpay.verifications.customers-v3.hal+json\n Accept: application/vnd.worldpay.verifications.customers-v3.hal+json\n ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our 3DS API.\n\nWe require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.\n<br /><br />\n\n\n__DNS whitelisting__ \nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting."
version: '3'
x-metadata:
category:
- 3DS
- SCA Exemptions
business:
- Enterprise
catalog-list: true
generated: false
servers:
- url: https://try.access.worldpay.com
description: Test (Try)
- url: https://access.worldpay.com
description: Live
security:
- BasicAuth: []
tags:
- name: PaymentQueries
paths:
/paymentQueries/payments:
get:
summary: Query payments
description: '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](/products/payment-queries/@v1/query-archive.md).'
operationId: queryByDateRange
parameters:
- in: header
name: Accept
required: true
schema:
type: string
example: application/vnd.worldpay.payment-queries-v1.hal+json
- name: startDate
in: query
description: An ISO 8601 date-time supplied as a string. Filters for payments that occurred after the specified date-time. Must be supplied alongside endDate.
required: true
schema:
type: string
example: '2024-04-28T21:30:20Z'
- name: endDate
in: query
description: An ISO 8601 date-time supplied as a string. Filters for payments that occurred below the specified date-time. Must be supplied alongside startDate.
required: true
schema:
type: string
example: '2024-05-31T21:30:20Z'
- name: pageSize
in: query
description: The maximum number of payments to be returned in the response (max 300).
required: false
schema:
maxLength: 300
type: integer
example: 10
- name: currency
in: query
description: The three digit currency code.
required: false
schema:
type: string
example: GBP
- name: minAmount
in: query
description: This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`).
required: false
schema:
type: integer
example: 0
- name: maxAmount
in: query
description: This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`).
required: false
schema:
type: integer
example: 1000
- name: last4Digits
in: query
description: The last four digits of the card number.
required: false
schema:
type: string
example: '1111'
- name: entityReferences
in: query
description: Your entity reference(s).
required: false
schema:
type: string
example: entityReference1,entityReference2
- name: receivedEvents
in: query
description: Name of the event.
required: false
schema:
type: string
example: authorizationRequested, authorizationSucceeded
- name: transactionReference
in: query
description: A unique reference generated by you, used to identify a payment throughout its lifecycle. This shouldn't be used in conjunction with the above fields. Use it as a single parameter to query data.
required: false
schema:
type: string
example: Memory265-13/08/1876
responses:
'200':
description: Summary information of list of payments within a specified date range.
content:
application/vnd.worldpay.payment-queries-v1.hal+json:
schema:
$ref: '#/components/schemas/pq_querybydaterange_200_response'
examples:
Query payments within a specified date time range:
description: Query payments within a specified date time range
value:
_links:
self:
href: /paymentQueries/payments?startDate=2025-11-05T21:30:20Z&endDate=2025-11-18T21:30:20Z&pageSize=10
next:
href: /paymentQueries/payments?startDate=2025-11-05T21:30:20Z&endDate=2025-11-14T10:07:41.715Z&paymentId=payx_k6N2SVBXGau0Xcw5Q-V0&entityReferences=AccessWP&pageSize=10
_embedded:
payments:
- timestamp: '2025-11-18T10:22:02.673Z'
paymentId: payaE1a3RqUPFUI5g4tOyoaY0
transactionReference: abc-123
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '491203'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payaE1a3RqUPFUI5g4tOyoaY0
- timestamp: '2025-11-18T10:21:48.094Z'
paymentId: payGxRvBfPojyGTXfYPiR4Nv0
transactionReference: ff4ee1bc-2d8b-463b-8958-bad5c94aea89
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '900598'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payGxRvBfPojyGTXfYPiR4Nv0
- timestamp: '2025-11-17T14:28:33.714Z'
paymentId: paygHUMkxzZ58Md9hEICgUIH0
transactionReference: 59e9fc9e-fadd-4bb8-8fcd-d562070d4038
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '241035'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/paygHUMkxzZ58Md9hEICgUIH0
- timestamp: '2025-11-17T13:02:06.733Z'
paymentId: payjee5QHua9cgIu6m2xkERt0
transactionReference: 3f87965e-4710-41d7-af56-6225677f36ea
transactionType: cardOnFile
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '703984'
scheme:
reference: '060720116005060'
paymentInstrument:
type: card/network+masked
card:
number:
last4Digits: '9224'
cardBin: '483196'
brand: visa
expiryDate:
month: 12
year: 2028
countryCode: SG
fundingType: debit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payjee5QHua9cgIu6m2xkERt0
- timestamp: '2025-11-17T10:32:26.906Z'
paymentId: payZs-cUL0vECYdW75V5e9gY0
transactionReference: 8e40b184-de8d-4009-94b2-a42b3ec02439
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
paymentInstrument:
type: card/wallet+googlepay
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payZs-cUL0vECYdW75V5e9gY0
- timestamp: '2025-11-17T10:32:21.166Z'
paymentId: payMtrFzP40TnI71R6j3NH5q0
transactionReference: 3dd8f935-3073-417e-8f9c-0eefb3c33ed4
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '350156'
scheme:
reference: '123456789012345'
paymentInstrument:
type: card/network+masked
card:
number:
last4Digits: '3434'
cardBin: '343434'
brand: amex
expiryDate:
month: 12
year: 2027
fundingType: debit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payMtrFzP40TnI71R6j3NH5q0
- timestamp: '2025-11-17T10:25:45.937Z'
paymentId: payfGuaUB_v05btqv2WMKdez0
transactionReference: fd20ef16-8135-4ab6-8b5c-e2bda02fa17d
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '606829'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/network+masked
card:
number:
last4Digits: '9224'
cardBin: '483196'
brand: visa
expiryDate:
month: 12
year: 2028
countryCode: SG
fundingType: debit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payfGuaUB_v05btqv2WMKdez0
- timestamp: '2025-11-14T10:08:54.726Z'
paymentId: payZWwsfjsDFY9T7E3lvPMfL0
transactionReference: d87841af-7f67-40d2-89ad-f1b8c98ef797
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '972487'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payZWwsfjsDFY9T7E3lvPMfL0
- timestamp: '2025-11-14T10:08:50.493Z'
paymentId: payHz1RW94TROEcxBpBgnsZU0
transactionReference: c1f8c8fc-140c-4d54-8fa7-5e86e4eda32b
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '371652'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payHz1RW94TROEcxBpBgnsZU0
- timestamp: '2025-11-14T10:07:41.715Z'
paymentId: payx_k6N2SVBXGau0Xcw5Q-V0
transactionReference: 22a0b037-7be0-40e1-b88d-026eceddabe1
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '756169'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payx_k6N2SVBXGau0Xcw5Q-V0
Query payments within a specified date time range filtered by currency:
description: Query payments within a specified date time range filtered by currency
value:
_links:
self:
href: /paymentQueries/payments?startDate=2025-11-05T21:30:20Z&endDate=2025-11-18T21:30:20Z¤cy=GBP&pageSize=10
next:
href: /paymentQueries/payments?startDate=2025-11-05T21:30:20Z&endDate=2025-11-14T10:07:41.715Z&paymentId=payx_k6N2SVBXGau0Xcw5Q-V0¤cy=GBP&entityReferences=AccessWP&pageSize=10
_embedded:
payments:
- timestamp: '2025-11-18T10:22:02.673Z'
paymentId: payaE1a3RqUPFUI5g4tOyoaY0
transactionReference: abc-123
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '491203'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payaE1a3RqUPFUI5g4tOyoaY0
- timestamp: '2025-11-18T10:21:48.094Z'
paymentId: payGxRvBfPojyGTXfYPiR4Nv0
transactionReference: ff4ee1bc-2d8b-463b-8958-bad5c94aea89
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '900598'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payGxRvBfPojyGTXfYPiR4Nv0
- timestamp: '2025-11-17T14:28:33.714Z'
paymentId: paygHUMkxzZ58Md9hEICgUIH0
transactionReference: 59e9fc9e-fadd-4bb8-8fcd-d562070d4038
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '241035'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/paygHUMkxzZ58Md9hEICgUIH0
- timestamp: '2025-11-17T13:02:06.733Z'
paymentId: payjee5QHua9cgIu6m2xkERt0
transactionReference: 3f87965e-4710-41d7-af56-6225677f36ea
transactionType: cardOnFile
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '703984'
scheme:
reference: '060720116005060'
paymentInstrument:
type: card/network+masked
card:
number:
last4Digits: '9224'
cardBin: '483196'
brand: visa
expiryDate:
month: 12
year: 2028
countryCode: SG
fundingType: debit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payjee5QHua9cgIu6m2xkERt0
- timestamp: '2025-11-17T10:32:26.906Z'
paymentId: payZs-cUL0vECYdW75V5e9gY0
transactionReference: 8e40b184-de8d-4009-94b2-a42b3ec02439
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
paymentInstrument:
type: card/wallet+googlepay
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payZs-cUL0vECYdW75V5e9gY0
- timestamp: '2025-11-17T10:32:21.166Z'
paymentId: payMtrFzP40TnI71R6j3NH5q0
transactionReference: 3dd8f935-3073-417e-8f9c-0eefb3c33ed4
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '350156'
scheme:
reference: '123456789012345'
paymentInstrument:
type: card/network+masked
card:
number:
last4Digits: '3434'
cardBin: '343434'
brand: amex
expiryDate:
month: 12
year: 2027
fundingType: debit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payMtrFzP40TnI71R6j3NH5q0
- timestamp: '2025-11-17T10:25:45.937Z'
paymentId: payfGuaUB_v05btqv2WMKdez0
transactionReference: fd20ef16-8135-4ab6-8b5c-e2bda02fa17d
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '606829'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/network+masked
card:
number:
last4Digits: '9224'
cardBin: '483196'
brand: visa
expiryDate:
month: 12
year: 2028
countryCode: SG
fundingType: debit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 250
_links:
self:
href: /paymentQueries/payments/payfGuaUB_v05btqv2WMKdez0
- timestamp: '2025-11-14T10:08:54.726Z'
paymentId: payZWwsfjsDFY9T7E3lvPMfL0
transactionReference: d87841af-7f67-40d2-89ad-f1b8c98ef797
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '972487'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payZWwsfjsDFY9T7E3lvPMfL0
- timestamp: '2025-11-14T10:08:50.493Z'
paymentId: payHz1RW94TROEcxBpBgnsZU0
transactionReference: c1f8c8fc-140c-4d54-8fa7-5e86e4eda32b
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '371652'
scheme:
reference: '060720116005062'
paymentInstrument:
type: card/plain+masked
card:
number:
last4Digits: '1111'
cardBin: '444433'
brand: visa
expiryDate:
month: 9
year: 2029
fundingType: credit
issuerName: UNKNOWN
paymentAccountReference: Q1HJZ28RKA1EBL470G9XYG90R5D3E
category: consumer
value:
currency: GBP
amount: 650
_links:
self:
href: /paymentQueries/payments/payHz1RW94TROEcxBpBgnsZU0
- timestamp: '2025-11-14T10:07:41.715Z'
paymentId: payx_k6N2SVBXGau0Xcw5Q-V0
transactionReference: 22a0b037-7be0-40e1-b88d-026eceddabe1
transactionType: oneTime
authorizationType: authorization
entity: AccessWP
issuer:
authorizationCode: '756169'
# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/worldpay/refs/heads/main/openapi/worldpay-paymentqueries-api-openapi.yml