Skip to content
APIs/Payment Queries/
Query historical payments

Query historical payments

Request

Query payments processed before 25 June 2024.

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

Security
BasicAuth
Query
transactionReferencestringrequired

A unique reference generated by you, used to identify a payment throughout its lifecycle.

Example:transactionReference=89197aeb-c94a-456e-8014-1272fbcb64eb
entityReferencestringrequired

A merchant entity.

Example:entityReference=default
Headers
Acceptstringrequired
Example:application/vnd.worldpay.payment-queries-v1.hal+json
curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/paymentQueries/archivedPayments?transactionReference=89197aeb-c94a-456e-8014-1272fbcb64eb&entityReference=default' \
  -H 'Accept: application/vnd.worldpay.payment-queries-v1.hal+json'

Responses

Summary information of a payment.

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

Query historical payments with a transactionReference & entityReference

{
  "_embedded": {
    "payments": [
      {
        "lastEvent": "Authorized",
        "value": {
          "amount": 500,
          "currency": "GBP"
        },
        "paymentInstrument": {
          "type": "card/plain",
          "card": {
            "number": {
              "last4Digits": "1111"
            },
            "brand": "visa"
          }
        },
        "_links": {
          "payments:cancel": {
            "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:miQ42Na870582T9ERg+1ZUryhkE+qW88hu1DdDl2T76sf:VXab5cMYWO6LS0UzlfoW8PkXm9A8Gx:X:2vAwKFXFzKnt23AOHd1MAcGi2rYDmNWql5dV+zBj9zyT7GZXrLmjasoJJfxtEasqXGr:dzHa6q9jMukzvEX+SLmppl6itAGDMxqvmBKsIqEipLj126"
          },
          "payments:settle": {
            "href": "https://try.access.worldpay.com/payments/settlements/full/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:miQ42Na870582T9ERg+1ZUryhkE+qW88hu1DdDl2T76sf:VXab5cMYWO6LS0UzlfoW8PkXm9A8Gx:X:2vAwKFXFzKnt23AOHd1MAcGi2rYDmNWql5dV+zBj9zyT7GZXrLmjasoJJfxtEasqXGr:dzHa6q9jMukzvEX+SLmppl6itAGDMxqvmBKsIqEipLj126"
          },
          "payments:partialSettle": {
            "href": "https://try.access.worldpay.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:miQ42Na870582T9ERg+1ZUryhkE+qW88hu1DdDl2T76sf:VXab5cMYWO6LS0UzlfoW8PkXm9A8Gx:X:2vAwKFXFzKnt23AOHd1MAcGi2rYDmNWql5dV+zBj9zyT7GZXrLmjasoJJfxtEasqXGr:dzHa6q9jMukzvEX+SLmppl6itAGDMxqvmBKsIqEipLj126"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/paymentQueries/archivedPayments?entityReference=default&transactionReference=Test123"
    }
  }
}