Last Updated: 18 July 2024 | Change Log

Retrieve a payment by payment ID

Provide the paymentId for a card payment to retrieve all information about the payment.

Note

The API returns detailed data for payments processed after 25 June 2024. For payments processed before then, you can query for historical payments.

Request

Retrieve a payment using the unique paymentId generated for each payment. The date range query response contains a paymentId for every payment. You can use this to retrieve detailed payment information along with list of events.

GET https://try.access.worldpay.com/paymentQueries/payments/{paymentId}

Example

GET https://try.access.worldpay.com/paymentQueries/payments/88bf3dd0-5056-4662-8f2a-5c7a9818a61c

Parameter description

Parameter	Required	Description
`paymentId`	✅	A unique `paymentId` generated for each payment.

Response

The response contains detailed information about the payment associated with the paymentId. This includes the event history and next action links.

If the paymentId does not exist then an empty response will be returned.

Response schema

timestampstring

Payment initial authorization time.

transactionReferencestring

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

narrativeobject

An object that contains identification and further details of the merchant.

transactionTypestring

An object that contains transaction type.

Enum"oneTime""cardOnFile""recurring"

authorizationTypestring

An object that contains authorization type.

Enum"authorization""sale"

entitystring

Merchant entity name.

paymentInstrumentobject

An object that contains information about the payment type.

valueobject

An object that contains payment amount and currency.

eventsArray of objects

An array that contains the history of events of a payment.

_linksobject

Self link and next action links.

Response example

{
    "timestamp": "2024-05-02T07:10:58.319Z",
    "transactionReference": "33070868-3608-4a71-8ad8-e7c8fdb83ae8",
    "narrative": {
        "line1": "trading name",
        "line2": "trading name"
    },
    "transactionType": "cardOnFile",
    "authorizationType": "authorization",
    "entity": "default",
    "paymentInstrument": {
        "type": "card/plain+masked",
        "card": {
            "number": {
                "last4Digits": "1000"
            },
            "brand": "visa",
            "fundingType": "debit"
        }
    },
    "value": {
        "currency": "GBP",
        "amount": 42
    },
    "events": [
        {
            "eventName": "authorizationRequested",
            "timestamp": "2024-05-02T07:10:58.319Z"
        },
        {
            "eventName": "authorizationSucceeded",
            "timestamp": "2024-05-02T07:10:58.583Z",
            "outcome": "authorized"
        }
    ],
    "_links": {
        "self": {
            "href": "/paymentQueries/payments/d629e528-2236-46ea-b393-0d6777028b2b"
        },
        "payments:recurringAuthorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations/recurring/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.b:PbaL:olUwfaZXZTI:3+wANh5y2LP9Qf3fg67b3wIhu6RMuvydMC7uf:0pZumE1hS5BrqGR:skQF2FA+7mFLw=="
        },
        "payments:partialSettle": {
            "href": "https://try.access.worldpay.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:m:yo2JOH4cbKdQxo1UvtHSPJ7jl6mDnWU:t3lilZIbZBPzCrJHynCo1xeJWTtKXeaW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQzx4RwcaGZe1dhDQevNu15s7SuiZFBF7ZFXeXaqUicH+8:1NIPjihTsRAo6D04hRcrZ:VhRHFzbbwymcuTiRbNw="
        },
        "payments:settle": {
            "href": "https://try.access.worldpay.com/payments/settlements/full/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:m:yo2JOH4cbKdQxo1UvtHSPJ7jl6mDnWU:t3lilZIbZBPzCrJHynCo1xeJWTtKXeaW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQzx4RwcaGZe1dhDQevNu15s7SuiZFBF7ZFXeXaqUicH+8:1NIPjihTsRAo6D04hRcrZ:VhRHFzbbwymcuTiRbNw="
        },
        "payments:cardOnFileAuthorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations/cardOnFile/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.b:PbaL:olUwfaZXZTI:3+wANh5y2LP9Qf3fg67b3wIhu6RMuvydMC7uf:0pZumE1hS5BrqGR:skQF2FA+7mFLw=="
        },
        "payments:events": {
            "href": "https://try.access.worldpay.com/payments/events/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:m:yo2JOH4cbKdQxo1UvtHSPJ7jl6mDnWU:t3lilZIbZBPzCrJHynCo1xeJWTtKXeaW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQzx4RwcaGZe1dhDQevNu15s7SuiZFBF7ZFXeXaqUicH+8:1NIPjihTsRAo6D04hRcrZ:VhRHFzbbwymcuTiRbNw="
        },
        "payments:cancel": {
            "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:m:yo2JOH4cbKdQxo1UvtHSPJ7jl6mDnWU:t3lilZIbZBPzCrJHynCo1xeJWTtKXeaW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQzx4RwcaGZe1dhDQevNu15s7SuiZFBF7ZFXeXaqUicH+8:1NIPjihTsRAo6D04hRcrZ:VhRHFzbbwymcuTiRbNw="
        }
    }
}