Skip to content
APIs/Payment Queries/
Retrieve a payment

Retrieve a payment

Request

Retrieve a single payment by payment ID.

The API returns detailed data for payments processed after 25 June 2024. For payments processed before then use our query for historical payments.

Security
BasicAuth
Path
paymentIdstringrequired

Unique identifier generated for each payment. Historic paymentId values in UUID format.

Example:payv0A4Hx2eY1-5P2_CpV7qy0
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/payv0A4Hx2eY1-5P2_CpV7qy0 \
  -H 'Accept: application/vnd.worldpay.payment-queries-v1.hal+json'

Responses

Retrieve complete details of a single payment including the event history & next action links.

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

Payment initial authorization time.

Example:"2024-05-30T09:49:45.962Z"
paymentIdstring, [ 25 .. 36 ] characters^[A-Za-z0-9_-]*$

Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.

Example:"pay4u_lHl2jobU5S1T2pWkq10"
transactionReferencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$

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

orderReferencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$

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.

narrativeobject

The text that appears on your customer's statement. Used to identify the merchant.

transactionTypestring

The transaction type of the payment.

Enum:"oneTime""cardOnFile""recurring"
authorizationTypestring

The authorization type of the payment.

Enum:"authorization""sale"
entitystring, [ 1 .. 32 ] characters^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$

Merchant entity name.

Example:"default"
lastEventstring

The last event received for the payment

Enum ValueDescription
authorizationRequested

Worldpay has received your authorization request.

authorizationSucceeded

Your authorization request was successfully approved by the card issuer.

authorizationRefused

Your authorization request was refused by the card issuer.

authorizationFailed

Your authorization request failed.

authorizationTimedOut

Your authorization request timed out.

incrementalAuthorizationRequested

Worldpay has received your increase authorized amount request.

incrementalAuthorizationSucceeded

Your increase authorized amount request was successfully approved by the card issuer.

incrementalAuthorizationRefused

Your increase authorized amount request was refused by the card issuer.

incrementalAuthorizationFailed

Your increase authorized amount request failed.

incrementalAuthorizationTimedOut

Your increase authorized amount request timed out.

saleRequested

Worldpay has received your sale request.

saleSucceeded

Your sale request was successfully approved by the card issuer.

saleRefused

Your sale request was refused by the card issuer.

saleFailed

Your sale request failed.

saleTimedOut

Your sale request timed out.

settlementRequested

Worldpay has received your settlement request.

settlementRequestSubmitted

Your settlement request was successfully sent for processing.

settlementRequestSubmissionFailed

Your settlement request failed.

settlementRequestSubmissionTimedOut

Your settlement request timed out.

refundRequested

Worldpay has received your refund request.

refundRequestSubmitted

Your refund request was successfully sent for processing.

refundRequestSubmissionFailed

We failed to process your refund request.

refundRequestSubmissionTimedOut

Your refund request timed out.

cancellationRequested

Worldpay has received your cancellation request.

cancellationRequestSubmitted

Your cancellation request was successfully sent for processing.

cancellationRequestSubmissionFailed

Your cancellation request failed.

cancellationRequestSubmissionTimedOut

Your cancellation request timed out.

reversalRequested

Worldpay has received your reversal request.

reversalRequestSubmitted

Your reversal request was successfully sent for processing.

reversalRequestSubmissionFailed

Your reversal request failed.

reversalRequestSubmissionTimedOut

Your reversal request timed out.

Example:"authorizationSucceeded"
schemeobject

An object containing information returned by the card scheme.

issuerobject

An object containing information returned by the issuer.

tokenobject

If a token was created as part of your payment authorization request, the details are included in this object. This is currently available for modular integrations only.

paymentInstrumentobject

An object that contains information about the payment type.

updatedPaymentInstrumentobject

The payment instrument supplied in the authorization request.

valueobject

An object that contains payment amount and currency.

eventsArray of objects

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

Response

Retrieve a single payment using the paymentId where the requested authorization succeeded

{
  "timestamp": "2026-08-19T09:11:13.040Z",
  "paymentId": "payXh3TDn2VF9CjwJ61KCWjV0",
  "transactionReference": "AP-withToken-fpanLastFour-try-01",
  "narrative": {
    "line1": "TEST",
    "line2": "TEST2"
  },
  "transactionType": "oneTime",
  "authorizationType": "authorization",
  "lastEvent": "authorizationSucceeded",
  "entity": "default",
  "issuer": {
    "authorizationCode": "250627"
  },
  "scheme": {
    "reference": "060720116005060"
  },
  "token": {
    "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiTURoWVZBVk1LNk1zWDNIUGYwYU11TExBTkovdTJtVTFRcDkzSlBwTXBEbz0ifQ",
    "tokenId": "9916015785857299715"
  },
  "paymentInstrument": {
    "type": "card/network+masked",
    "card": {
      "number": {
        "last4Digits": "0639",
        "cardBin": "475526",
        "fpanLastFour": "7512"
      },
      "brand": "visa",
      "expiryDate": {
        "month": 6,
        "year": 2031
      },
      "countryCode": "GB",
      "fundingType": "credit",
      "issuerName": "AN ISSUING BANK PLC",
      "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E",
      "category": "consumer"
    }
  },
  "value": {
    "currency": "GBP",
    "amount": 10
  },
  "events": [
    {
      "eventName": "authorizationSucceeded",
      "timestamp": "2026-08-19T09:11:14.030Z",
      "commandId": "cmdpsUGFY4GtpmInC5_q6nuF0",
      "outcome": "authorized"
    },
    {
      "eventName": "authorizationRequested",
      "timestamp": "2026-08-19T09:11:13.040Z",
      "commandId": "cmdpsUGFY4GtpmInC5_q6nuF0"
    }
  ],
  "_links": {
    "self": {
      "href": "/paymentQueries/payments/payXh3TDn2VF9CjwJ61KCWjV0"
    },
    "tokens:token": {
      "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiTURoWVZBVk1LNk1zWDNIUGYwYU11TExBTkovdTJtVTFRcDkzSlBwTXBEbz0ifQ"
    },
    "cardPayments:cancel": {
      "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:mF2JAUF9Z3Qc:dcxpju50nwRzxZvOEmdeYlNNLX:9LWFu+88::o0aHeaJsFlbF9V8Sh3D6QRmmQuaVZB0nhIVHuXn:h5Cs01S+RZXDN4j1RY5uGpudSEc:v2txu5nGjVyQp4+gScVEDjnCwAQCsvAxAajAeXibZ0n191VAhCujl7YvzdpXvHVw4vj97vSvml0biEYHoHrVFxlt81J:CeUWqYB5LBSdGaoY9p7oSrItS2+fM8leuOb+c:vuVTMaCTio2UBGa628quxNnS9eMiLTjhnZWNiAj2ugpUlJrH6iLrbka0qngeZC4kcKM31mXDmfMev+6hSvQrN6MzQWl8r0g=="
    },
    "cardPayments:settle": {
      "href": "https://try.access.worldpay.com/payments/settlements/full/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:mF2JAUF9Z3Qc:dcxpju50nwRzxZvOEmdeYlNNLX:9LWFu+88::o0aHeaJsFlbF9V8Sh3D6QRmmQuaVZB0nhIVHuXn:h5Cs01S+RZXDN4j1RY5uGpudSEc:v2txu5nGjVyQp4+gScVEDjnCwAQCsvAxAajAeXibZ0n191VAhCujl7YvzdpXvHVw4vj97vSvml0biEYHoHrVFxlt81J:CeUWqYB5LBSdGaoY9p7oSrItS2+fM8leuOb+c:vuVTMaCTio2UBGa628quxNnS9eMiLTjhnZWNiAj2ugpUlJrH6iLrbka0qngeZC4kcKM31mXDmfMev+6hSvQrN6MzQWl8r0g=="
    },
    "cardPayments:partialSettle": {
      "href": "https://try.access.worldpay.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:mF2JAUF9Z3Qc:dcxpju50nwRzxZvOEmdeYlNNLX:9LWFu+88::o0aHeaJsFlbF9V8Sh3D6QRmmQuaVZB0nhIVHuXn:h5Cs01S+RZXDN4j1RY5uGpudSEc:v2txu5nGjVyQp4+gScVEDjnCwAQCsvAxAajAeXibZ0n191VAhCujl7YvzdpXvHVw4vj97vSvml0biEYHoHrVFxlt81J:CeUWqYB5LBSdGaoY9p7oSrItS2+fM8leuOb+c:vuVTMaCTio2UBGa628quxNnS9eMiLTjhnZWNiAj2ugpUlJrH6iLrbka0qngeZC4kcKM31mXDmfMev+6hSvQrN6MzQWl8r0g=="
    },
    "cardPayments:events": {
      "href": "https://try.access.worldpay.com/payments/events/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:mF2JAUF9Z3Qc:dcxpju50nwRzxZvOEmdeYlNNLX:9LWFu+88::o0aHeaJsFlbF9V8Sh3D6QRmmQuaVZB0nhIVHuXn:h5Cs01S+RZXDN4j1RY5uGpudSEc:v2txu5nGjVyQp4+gScVEDjnCwAQCsvAxAajAeXibZ0n191VAhCujl7YvzdpXvHVw4vj97vSvml0biEYHoHrVFxlt81J:CeUWqYB5LBSdGaoY9p7oSrItS2+fM8leuOb+c:vuVTMaCTio2UBGa628quxNnS9eMiLTjhnZWNiAj2ugpUlJrH6iLrbka0qngeZC4kcKM31mXDmfMev+6hSvQrN6MzQWl8r0g=="
    },
    "cardPayments:partialCancel": {
      "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/partials/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:mF2JAUF9Z3Qc:dcxpju50nwRzxZvOEmdeYlNNLX:9LWFu+88::o0aHeaJsFlbF9V8Sh3D6QRmmQuaVZB0nhIVHuXn:h5Cs01S+RZXDN4j1RY5uGpudSEc:v2txu5nGjVyQp4+gScVEDjnCwAQCsvAxAajAeXibZ0n191VAhCujl7YvzdpXvHVw4vj97vSvml0biEYHoHrVFxlt81J:CeUWqYB5LBSdGaoY9p7oSrItS2+fM8leuOb+c:vuVTMaCTio2UBGa628quxNnS9eMiLTjhnZWNiAj2ugpUlJrH6iLrbka0qngeZC4kcKM31mXDmfMev+6hSvQrN6MzQWl8r0g=="
    },
    "cardPayments:reverse": {
      "href": "https://try.access.worldpay.com/payments/authorizations/reversals/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y:7njc4649JSrU7+vFDl1J36+cwOkX0lW4Z+fnZKMutoUGX3m1:mF2JAUF9Z3Qc:dcxpju50nwRzxZvOEmdeYlNNLX:9LWFu+88::o0aHeaJsFlbF9V8Sh3D6QRmmQuaVZB0nhIVHuXn:h5Cs01S+RZXDN4j1RY5uGpudSEc:v2txu5nGjVyQp4+gScVEDjnCwAQCsvAxAajAeXibZ0n191VAhCujl7YvzdpXvHVw4vj97vSvml0biEYHoHrVFxlt81J:CeUWqYB5LBSdGaoY9p7oSrItS2+fM8leuOb+c:vuVTMaCTio2UBGa628quxNnS9eMiLTjhnZWNiAj2ugpUlJrH6iLrbka0qngeZC4kcKM31mXDmfMev+6hSvQrN6MzQWl8r0g=="
    }
  }
}