Access Worldpay
/
Query historical payments

Last Updated: 18 July 2024 | 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

ParameterRequiredDescription
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 Implementation Manager for more details.

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

Reponse

Response schema

_linksobjectrequired

Self link and next action links.The Next action links are dependant on the lastEvent, refer to '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"
        }
    }
}