Skip to content
APIs/Payment Queries/
Query payments

Query payments

Request

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.

Security
BasicAuth
Query
startDatestringrequired

An ISO 8601 date-time supplied as a string. Filters for payments that occurred after the specified date-time. Must be supplied alongside endDate.

Example:startDate=2024-04-28T21:30:20Z
endDatestringrequired

An ISO 8601 date-time supplied as a string. Filters for payments that occurred below the specified date-time. Must be supplied alongside startDate.

Example:endDate=2024-05-31T21:30:20Z
pageSizeinteger, <= 300 characters

The maximum number of payments to be returned in the response (max 300).

Example:pageSize=10
currencystring

The three digit currency code.

Example:currency=GBP
minAmountinteger

This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250).

Example:minAmount=0
maxAmountinteger

This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250).

Example:maxAmount=1000
last4Digitsstring

The last four digits of the card number.

Example:last4Digits=1111
entityReferencesstring

Your entity reference(s).

Example:entityReferences=entityReference1,entityReference2
receivedEventsstring

Name of the event.

Example:receivedEvents=authorizationRequested, authorizationSucceeded
transactionReferencestring

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.

Example:transactionReference=Memory265-13/08/1876
orderReferencestring

A reference, generated by you, that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

  • the total amount for a single order is split across multiple payments
  • you use a single reference for each payment in a recurring agreement or split shipment scenario

This shouldn't be used in conjunction with the above fields. Use it as a single parameter to query data.

Note: Querying by orderReference returns data for payments processed after 20 August 2026.

Example:orderReference=order-12345
Headers
Acceptstringrequired
Example:application/vnd.worldpay.payment-queries-v1.hal+json
curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/paymentQueries/payments?startDate=2024-04-28T21%3A30%3A20Z&endDate=2024-05-31T21%3A30%3A20Z&pageSize=10&currency=GBP&minAmount=0&maxAmount=1000&last4Digits=1111&entityReferences=entityReference1%2CentityReference2&receivedEvents=authorizationRequested%2C%20authorizationSucceeded&transactionReference=Memory265-13%2F08%2F1876&orderReference=order-12345' \
  -H 'Accept: application/vnd.worldpay.payment-queries-v1.hal+json'

Responses

Summary information of list of payments within a specified date range.

Bodyapplication/vnd.worldpay.payment-queries-v1.hal+json
_embeddedobjectrequired
Response

Query payments within a specified date time range

{
  "_links": {
    "self": {
      "href": "/paymentQueries/payments?startDate=2026-08-17T21:30:20Z&endDate=2026-08-19T21:30:20Z&pageSize=10"
    },
    "next": {
      "href": "/paymentQueries/payments?startDate=2026-08-17T21:30:20Z&endDate=2026-08-19T13:44:26.328Z&paymentId=pay4Vx0Ft1OYWtXq-43OrZdy0&pageSize=10"
    }
  },
  "_embedded": {
    "payments": [
      {
        "timestamp": "2026-08-19T13:47:52.365Z",
        "paymentId": "payOoT928hHR9OwZh-iisTuR0",
        "transactionReference": "78f1c782-2816-45ca-bb1f-c46e789a9c81",
        "orderReference": "order-12345",
        "transactionType": "oneTime",
        "authorizationType": "authorization",
        "entity": "default",
        "paymentInstrument": {
          "type": "card/plain+masked",
          "card": {
            "number": {
              "last4Digits": "1111",
              "cardBin": "444433"
            },
            "brand": "visa",
            "fundingType": "credit",
            "issuerName": "UNKNOWN",
            "category": "consumer"
          }
        },
        "value": {
          "currency": "GBP",
          "amount": 650
        },
        "_links": {
          "self": {
            "href": "/paymentQueries/payments/payOoT928hHR9OwZh-iisTuR0"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:43.630Z",
        "paymentId": "payxrP-FyWbsg-Xs0QZL9WK-0",
        "transactionReference": "07689df2-7e68-4e94-828c-3a43c38fae4c",
        "transactionType": "recurring",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "262033"
        },
        "scheme": {
          "reference": "060720116005062"
        },
        "paymentInstrument": {
          "type": "card/plain+masked",
          "card": {
            "number": {
              "last4Digits": "1111",
              "cardBin": "4444**"
            },
            "brand": "visa",
            "fundingType": "credit",
            "issuerName": "UNKNOWN",
            "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E",
            "category": "consumer"
          }
        },
        "value": {
          "currency": "GBP",
          "amount": 650
        },
        "_links": {
          "self": {
            "href": "/paymentQueries/payments/payxrP-FyWbsg-Xs0QZL9WK-0"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:40.924Z",
        "paymentId": "paydyrGHSMWynO_V0b1ZAKHb0",
        "transactionReference": "c5180092-fa58-4771-9770-108aafadd6ac",
        "transactionType": "recurring",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "922641"
        },
        "scheme": {
          "reference": "060720116005062"
        },
        "paymentInstrument": {
          "type": "card/plain+masked",
          "card": {
            "number": {
              "last4Digits": "1111",
              "cardBin": "4444**"
            },
            "brand": "visa",
            "fundingType": "credit",
            "issuerName": "UNKNOWN",
            "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E",
            "category": "consumer"
          }
        },
        "value": {
          "currency": "GBP",
          "amount": 650
        },
        "_links": {
          "self": {
            "href": "/paymentQueries/payments/paydyrGHSMWynO_V0b1ZAKHb0"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:38.161Z",
        "paymentId": "paygSAoftgF_bjP7FCUCbhRQ0",
        "transactionReference": "6cc5d236-116c-4132-a075-41aaa0fdd8c8",
        "orderReference": "order-12345",
        "transactionType": "oneTime",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "305730"
        },
        "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/paygSAoftgF_bjP7FCUCbhRQ0"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:36.934Z",
        "paymentId": "payiMoeQ5me59ykcLi4Op14m0",
        "transactionReference": "58ded0e2-bc44-4ae9-8cb1-e00d9b7386f9",
        "orderReference": "order-12345",
        "transactionType": "oneTime",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "793150"
        },
        "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/payiMoeQ5me59ykcLi4Op14m0"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:33.209Z",
        "paymentId": "paye_Xb84SCoQVodEMOLQEs10",
        "transactionReference": "e9b50c9a-ae4e-4afb-ab8a-721af781bf05",
        "orderReference": "order-12345",
        "transactionType": "oneTime",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "393558"
        },
        "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/paye_Xb84SCoQVodEMOLQEs10"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:31.966Z",
        "paymentId": "paynRxC16ALQ7UiCKWGaJGSf0",
        "transactionReference": "09dc405c-7d5e-4176-a2f1-43f387bd3744",
        "orderReference": "order-12345",
        "transactionType": "oneTime",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "701855"
        },
        "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/paynRxC16ALQ7UiCKWGaJGSf0"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:29.996Z",
        "paymentId": "payGlJwNBPaqGtGva7CCzhb40",
        "transactionReference": "b199db6b-adf8-4d48-ba87-2b3aff95760e",
        "orderReference": "order-12345",
        "transactionType": "oneTime",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "500160"
        },
        "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/payGlJwNBPaqGtGva7CCzhb40"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:28.005Z",
        "paymentId": "payiD5ku26v8X1QE454fQc250",
        "transactionReference": "6855dd44-743f-4cbc-aebc-804f3cb3cd8a",
        "transactionType": "recurring",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "962017"
        },
        "scheme": {
          "reference": "060720116005062"
        },
        "paymentInstrument": {
          "type": "card/plain+masked",
          "card": {
            "number": {
              "last4Digits": "1111",
              "cardBin": "4444**"
            },
            "brand": "visa",
            "fundingType": "credit",
            "issuerName": "UNKNOWN",
            "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E",
            "category": "consumer"
          }
        },
        "value": {
          "currency": "GBP",
          "amount": 650
        },
        "_links": {
          "self": {
            "href": "/paymentQueries/payments/payiD5ku26v8X1QE454fQc250"
          }
        }
      },
      {
        "timestamp": "2026-08-19T13:44:26.328Z",
        "paymentId": "pay4Vx0Ft1OYWtXq-43OrZdy0",
        "transactionReference": "1b5a7757-1a32-441a-b06c-18574eee4014",
        "transactionType": "recurring",
        "authorizationType": "authorization",
        "entity": "default",
        "issuer": {
          "authorizationCode": "406747"
        },
        "scheme": {
          "reference": "060720116005062"
        },
        "paymentInstrument": {
          "type": "card/plain+masked",
          "card": {
            "number": {
              "last4Digits": "1111",
              "cardBin": "4444**"
            },
            "brand": "visa",
            "fundingType": "credit",
            "issuerName": "UNKNOWN",
            "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E",
            "category": "consumer"
          }
        },
        "value": {
          "currency": "GBP",
          "amount": 650
        },
        "_links": {
          "self": {
            "href": "/paymentQueries/payments/pay4Vx0Ft1OYWtXq-43OrZdy0"
          }
        }
      }
    ]
  }
}