Last Updated: 09 July 2025 | Change Log
Provide the paymentId for a card payment to retrieve all information about the payment.
The API returns detailed data for payments processed after 25 June 2024. For payments processed before then, you can query for historical payments.
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}
GET https://try.access.worldpay.com/paymentQueries/payments/paycGeAtsYssrrtgieKBA3Pi0
| Parameter | Required | Description |
|---|---|---|
paymentId | ✅ | A unique paymentId generated for each payment. |
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.
Payment initial authorization time.
A unique reference generated by you, used to identify a payment throughout its lifecycle.
The text that appears on your customer's statement. Used to identify the merchant.
The transaction type of the payment.
The authorization type of the payment.
Merchant entity name.
An object containing information returned by the card scheme.
An object containing information returned by the issuer.
The payment instrument supplied in the authorization request.
The payment instrument supplied in the authorization request.
An object that contains payment amount and currency.
An array that contains the history of events of a payment.
Self link and next action links.
{
"timestamp":"2025-06-08T16:11:13.164Z",
"transactionReference":"89197aeb-c94a-456e-8014-1272fbcb64eb",
"narrative":{
"line1":"trading name",
"line2":"order number"
},
"transactionType":"oneTime",
"authorizationType":"authorization",
"entity":"default",
"issuer":{
"authorizationCode":"T31306"
},
"scheme":{
"reference":"MCCOLXT1C0104 "
},
"paymentInstrument":{
"type":"card/plain+masked",
"card":{
"number":{
"last4Digits":"1111",
"cardBin":"444433"
},
"brand":"visa",
"expiryDate":{
"month":5,
"year":2030
},
"countryCode":"GB",
"fundingType":"credit",
"issuerName":"AN ISSUING BANK LTD",
"paymentAccountReference":"Q1HJZ28RKA1EBL470G9XYG90R5D3E",
"category":"consumer"
}
},
"value":{
"currency":"GBP",
"amount":1200
},
"events":[
{
"eventName":"authorizationRequested",
"timestamp":"2025-06-08T16:11:13.164Z"
},
{
"eventName":"authorizationSucceeded",
"timestamp":"2025-06-08T16:11:14.229Z",
"outcome":"authorized"
},
{
"eventName":"settlementRequested",
"timestamp":"2025-06-09T08:14:23.138Z",
"type":"partialSettlement",
"settlementReference":"mySettleRef",
"value":{
"currency":"GBP",
"amount":1000
}
},
{
"eventName":"settlementRequestSubmitted",
"timestamp":"2025-06-09T08:14:23.224Z"
},
{
"eventName":"refundRequested",
"timestamp":"2025-07-01T09:14:28.009Z",
"type":"partialRefund",
"refundReference":"myRefundRef",
"value":{
"currency":"GBP",
"amount":1000
}
},
{
"eventName":"refundRequestSubmitted",
"timestamp":"2025-07-01T09:14:28.151Z"
}
],
"_links":{
"self":{
"href":"/paymentQueries/payments/payVGX28GOT7iDY5qanttPWF0"
},
"payments:events":{
"href":"https://access.worldpay.com/payments/events/{linkData}"
},
"payments:partialRefund":{
"href":"https://access.worldpay.com/payments/settlements/refunds/partials/{linkData}"
}
}
}