Last updated: 17 October 2025 | Change log

Query historical payments

Query card payments processed before 25 June 2024.

Request

Provide a transactionReference and entityReference to find the matching payment.

GET https://try.access.worldpay.com/paymentQueries/archivedPayments?transactionReference={transactionReference}&entityReference={entityReference}

Example

GET https://try.access.worldpay.com/paymentQueries/archivedPayments?transactionReference=PayFac20230302-3charState&entity=entityReference123

Parameter descriptions

Parameter	Required	Description
`transactionReference`	✅	A unique reference generated by you. It is used to identify a payment throughout its lifecycle.
`entityReference`	✅	Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication of a payment. Contact your Worldpay Implementation Manager for more details. Note You might have supplied this as `entity` in your original payment request.

The response contains summary information about the payment associated with the request parameters.

Response

Response schema

_linksobjectrequired

Self link and next action links. The next action links are dependent on the lastEvent. Refer to the 'query for historical payments response' section for more details.

_links.selfobjectrequired

Self link to the page.

_links.self.hrefstring

Self link to the page.

_links.payments:cancelobject

Next action links.

_links.payments:settleobject

Next action links.

_links.payments:partialSettleobject

Next action links.

_embeddedobjectrequired

_embedded.paymentsArray of objects

Array of payments.

Response examples

{
    "_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=AccessWP&transactionReference=Test123"
        }
    }
}

lastEvent mapping

We return a lastEvent in the response from Payment Queries for queries on historical payments, and also for GET requests made from Payments API. In these scenarios, the lastEvent is the outcome of a payment command (eg Authorized,Refused etc).

Query payments by transaction reference also provides lastEvent in the API response, which is the last eventName received in the payment life cycle.

The table below shows a mapping between these.

Payment Queries eventName	Payments API lastEvent
`authorizationRequested`	N/A
`authorizationSucceeded`	`Authorized`/`Sent for Settlement`/`Expired`
`authorizationRefused`	`Refused`
`authorizationFailed`	`Error`
`authorizationTimedOut`	`Authorized`/`Sent for Settlement`/`Refused`/`Error`/`Expired`
`saleRequested`	N/A
`saleSucceeded`	N/A
`saleRefused`	N/A
`saleFailed`	N/A
`saleTimedOut`	N/A
`settlementRequested`	N/A
`settlementRequestSubmitted`	`Sent for Settlement`/`Expired`
`settlementRequestSubmissionFailed`	`Authorized`/`Error`
`settlementRequestSubmissionTimedOut`	`Authorized`/`Error`/`Sent for Settlement`/`Expired`
`refundRequested`	N/A
`refundRequestSubmitted`	`Sent for Refund`/`Expired`
`refundRequestSubmissionFailed`	`Sent for Settlement`/`Error`
`refundRequestSubmissionTimedOut`	`Sent for Refund`/`Error`/`Sent for Settlement`/`Expired`
`reversalRequested`	N/A
`reversalRequestSubmitted`	`Sent for Refund`/`Sent for Cancellation`/`Expired`
`reversalRequestSubmissionFailed`	`Sent for Settlement`/`Error`
`reversalRequestSubmissionTimedOut`	`Sent for Refund`/`Error`/`Sent for Cancellation`/`Expired`
`cancellationRequested`	N/A
`cancellationRequestSubmitted`	`Authorized`/`Sent for Cancellation`/`Expired`
`cancellationRequestSubmissionFailed`	`Authorized`/`Error`
`cancellationRequestSubmissionTimedOut`	`Sent for Cancellation`/`Error`/`Expired`

Note

Status updates for Payments API GET requests and Payment Queries historical transactions may take up to 15 minutes.

Query historical payments

Request

Example

Parameter descriptions

Response

Response schema

Response examples

lastEvent mapping

Do you like our page?