**Last updated**: 17 October 2025 | [**Change log**](/products/payment-queries/changelog/)

# 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](/products/payment-queries/query-archive).

## 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-bsh.securedataplatform.com/paymentQueries/payments/{paymentId}`

### Example

`GET` `https://try.access.worldpay-bsh.securedataplatform.com/paymentQueries/payments/paycGeAtsYssrrtgieKBA3Pi0`

### 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


```json
{
  "$ref": "#/components/schemas/pq_querybypaymentid_200_response",
  "components": {
    "schemas": {
      "paymentId": {
        "maxLength": 36,
        "minLength": 25,
        "pattern": "^[A-Za-z0-9_-]*$",
        "type": "string",
        "description": "Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.",
        "example": "pay4u_lHl2jobU5S1T2pWkq10"
      },
      "lastEvent": {
        "type": "string",
        "description": "The last event received for the payment",
        "example": "authorizationSucceeded",
        "enum": [
          "authorizationRequested",
          "authorizationSucceeded",
          "authorizationRefused",
          "authorizationFailed",
          "authorizationTimedOut",
          "saleRequested",
          "saleSucceeded",
          "saleRefused",
          "saleFailed",
          "saleTimedOut",
          "settlementRequested",
          "settlementRequestSubmitted",
          "settlementRequestSubmissionFailed",
          "settlementRequestSubmissionTimedOut",
          "refundRequested",
          "refundRequestSubmitted",
          "refundRequestSubmissionFailed",
          "refundRequestSubmissionTimedOut",
          "cancellationRequested",
          "cancellationRequestSubmitted",
          "cancellationRequestSubmissionFailed",
          "cancellationRequestSubmissionTimedOut",
          "reversalRequested",
          "reversalRequestSubmitted",
          "reversalRequestSubmissionFailed",
          "reversalRequestSubmissionTimedOut"
        ],
        "x-enumDescriptions": {
          "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.",
          "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."
        }
      },
      "commandId": {
        "maxLength": 36,
        "minLength": 25,
        "pattern": "^[A-Za-z0-9_-]*$",
        "type": "string",
        "description": "Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.",
        "example": "cmdRvD-OxCyXgJLQ9_jbqXAC0"
      },
      "authorizationRequested": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Worldpay has received your authorization request.",
            "enum": [
              "authorizationRequested"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "authorizationSucceeded": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your authorization request was successfully approved by the card issuer.",
            "enum": [
              "authorizationSucceeded"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "outcome": {
            "type": "string",
            "description": "Outcome of the event. For every requested event there can be a successful or refused event outcome.",
            "enum": [
              "authorized"
            ]
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "authorizationRefused": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your authorization request was refused by the card issuer.",
            "enum": [
              "authorizationRefused"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "outcome": {
            "type": "string",
            "description": "Outcome of the event. For every requested event there can be a successful or refused event outcome.",
            "enum": [
              "refused"
            ]
          },
          "code": {
            "type": "string",
            "description": "The response code, used to identify the refusal reason.",
            "example": "65"
          },
          "description": {
            "type": "string",
            "description": "The description of the refusal reason.",
            "example": "Authentication Requested"
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "authorizationFailed": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your authorization request failed.",
            "enum": [
              "authorizationFailed"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "error": {
            "type": "object",
            "description": "All Failed events return error object with name and message.",
            "properties": {
              "name": {
                "type": "string",
                "description": "Example values are,",
                "enum": [
                  "internalErrorOccurred",
                  "transactionReferenceIsADuplicate",
                  "transactionHasAlreadyBeenProcessed",
                  "channelIsNotSupported",
                  "currencyIsNotSupported",
                  "paymentInstrumentIsNotSupported",
                  "fieldHasInvalidValue",
                  "fieldIsEmpty",
                  "cardNumberIsNotRecognized",
                  "underlyingPaymentInstrumentHasExpired",
                  "entityIsNotConfigured"
                ]
              },
              "message": {
                "type": "string",
                "description": "Example values are,",
                "enum": [
                  "Payment failed to be authorized",
                  "Token is unrecognized",
                  "The transaction reference is a duplicate",
                  "The transaction has already been processed",
                  "Currency not supported"
                ]
              }
            }
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "authorizationTimedOut": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your authorization request timed out.",
            "enum": [
              "authorizationTimedOut"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "saleRequested": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Worldpay has received your sale request.",
            "enum": [
              "saleRequested"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "saleSucceeded": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your authorization request was successfully approved by the card issuer.",
            "enum": [
              "saleSucceeded"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "outcome": {
            "type": "string",
            "description": "Outcome of the event. For every requested event there can be a successful or refused event outcome.",
            "enum": [
              "authorized"
            ]
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "saleRefused": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your sale request was refused by the card issuer.",
            "enum": [
              "saleRefused"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "outcome": {
            "type": "string",
            "description": "Outcome of the event. For every requested event there can be a successful or refused event outcome.",
            "enum": [
              "refused"
            ]
          },
          "code": {
            "type": "string",
            "description": "The response code, used to identify the refusal reason.",
            "example": "65"
          },
          "description": {
            "type": "string",
            "description": "The description of the refusal reason.",
            "example": "Authentication Requested"
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "saleFailed": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your sale request failed.",
            "enum": [
              "saleFailed"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "error": {
            "type": "object",
            "description": "All Failed events return error object with name and message.",
            "properties": {
              "name": {
                "type": "string",
                "description": "Example values are,",
                "enum": [
                  "internalErrorOccurred",
                  "transactionReferenceIsADuplicate",
                  "transactionHasAlreadyBeenProcessed",
                  "channelIsNotSupported",
                  "currencyIsNotSupported",
                  "paymentInstrumentIsNotSupported",
                  "fieldHasInvalidValue",
                  "fieldIsEmpty",
                  "cardNumberIsNotRecognized",
                  "underlyingPaymentInstrumentHasExpired",
                  "entityIsNotConfigured"
                ]
              },
              "message": {
                "type": "string",
                "description": "Example values are,",
                "enum": [
                  "Payment failed to be authorized",
                  "Token is unrecognized",
                  "The transaction reference is a duplicate",
                  "The transaction has already been processed",
                  "Currency not supported"
                ]
              }
            }
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "saleTimedOut": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your sale request timed out.",
            "enum": [
              "saleTimedOut"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "settlementRequested": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Worldpay has received your settlement request.",
            "enum": [
              "settlementRequested"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "type": {
            "type": "string",
            "enum": [
              "fullSettlement",
              "partialSettlement"
            ]
          },
          "settlementReference": {
            "type": "string",
            "description": "Your settlement reference"
          },
          "value": {
            "required": [
              "amount",
              "currency"
            ],
            "type": "object",
            "description": "An object that contains the amount and currency requested for settlement.",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."
              },
              "currency": {
                "type": "string",
                "description": "The 3 digit currency code."
              }
            }
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "settlementRequestSubmitted": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your settlement request was successfully sent for processing.",
            "enum": [
              "settlementRequestSubmitted"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "settlementRequestSubmissionFailed": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your settlement request failed.",
            "enum": [
              "settlementRequestSubmissionFailed"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "settlementRequestSubmissionTimedOut": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your settlement request timed out.",
            "enum": [
              "settlementRequestSubmissionTimedOut"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "refundRequested": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Worldpay has received your refund request.",
            "enum": [
              "refundRequested"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "type": {
            "type": "string",
            "enum": [
              "fullRefund",
              "partialRefund"
            ]
          },
          "refundReference": {
            "type": "string",
            "description": "Your refund reference"
          },
          "value": {
            "required": [
              "amount",
              "currency"
            ],
            "type": "object",
            "description": "An object that contains the amount and currency requested for refund.",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."
              },
              "currency": {
                "type": "string",
                "description": "The 3 digit currency code."
              }
            }
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "refundRequestSubmitted": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your refund request was successfully sent for processing.",
            "enum": [
              "refundRequestSubmitted"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "refundRequestSubmissionFailed": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your refund request failed.",
            "enum": [
              "refundRequestSubmissionFailed"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "refundRequestSubmissionTimedOut": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your refund request timed out.",
            "enum": [
              "refundRequestSubmissionTimedOut"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "cancellationRequested": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Worldpay has received your cancellation request.",
            "enum": [
              "cancellationRequested"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "cancellationRequestSubmitted": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your cancellation request was successfully sent for processing.",
            "enum": [
              "cancellationRequestSubmitted"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "cancellationRequestSubmissionFailed": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your cancellation request failed.",
            "enum": [
              "cancellationRequestSubmissionFailed"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "cancellationRequestSubmissionTimedOut": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your cancellation request timed out.",
            "enum": [
              "cancellationRequestSubmissionTimedOut"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "reversalRequested": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Worldpay has received your reversal request.",
            "enum": [
              "reversalRequested"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "value": {
            "required": [
              "amount",
              "currency"
            ],
            "type": "object",
            "description": "An object that contains the amount and currency requested for reversal.",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."
              },
              "currency": {
                "type": "string",
                "description": "The 3 digit currency code."
              }
            }
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "reversalRequestSubmitted": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your reversal request was successfully sent for processing.",
            "enum": [
              "reversalRequestSubmitted"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "reversalRequestSubmissionFailed": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your reversal request failed.",
            "enum": [
              "reversalRequestSubmissionFailed"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "reversalRequestSubmissionTimedOut": {
        "required": [
          "eventName"
        ],
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string",
            "description": "Your reversal request timed out.",
            "enum": [
              "reversalRequestSubmissionTimedOut"
            ]
          },
          "timestamp": {
            "type": "string",
            "description": "The ISO 8601 date-time at which the event was created."
          },
          "commandId": {
            "$ref": "#/components/schemas/commandId"
          }
        }
      },
      "selfLinkOnly": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              }
            }
          }
        }
      },
      "authorizationSucceededLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:cancel": {
                "type": "object",
                "description": "An action link to cancel the full authorized amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:cancel`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel the full authorized amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/{linkData}"
                  }
                }
              },
              "cardPayments:partialCancel": {
                "type": "object",
                "description": "An action link to cancel a portion of the authorized amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialCancel`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel a portion of the authorized amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/partials/{linkData}"
                  }
                }
              },
              "cardPayments:settle": {
                "type": "object",
                "description": "An action link to send the full authorized amount for settlement.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:settle`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to send the full authorized amount for settlement.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/{linkData}"
                  }
                }
              },
              "cardPayments:partialSettle": {
                "type": "object",
                "description": "An action link to send a portion of the authorized amount for settlement. <br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialSettle`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to send a portion of the authorized amount for settlement.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/{linkData}"
                  }
                }
              },
              "cardPayments:reverse": {
                "type": "object",
                "description": "An action link to cancel or refund the full amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:reverse`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel or refund the full amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/reversals/{linkData}"
                  }
                }
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "sentForSettlementLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:refund": {
                "type": "object",
                "description": "An action link to refund the full settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:refund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund the full settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/full/{linkData}"
                  }
                }
              },
              "cardPayments:partialRefund": {
                "type": "object",
                "description": "An action link to refund a portion of the settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialRefund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund a portion of the settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/{linkData}"
                  }
                }
              },
              "cardPayments:reverse": {
                "type": "object",
                "description": "An action link to cancel or refund the full amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:reverse`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel or refund the full amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/sales/reversals/{linkData}"
                  }
                }
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "fullSettleLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:refund": {
                "type": "object",
                "description": "An action link to refund the full settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:refund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund the full settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/full/{linkData}"
                  }
                }
              },
              "cardPayments:partialRefund": {
                "type": "object",
                "description": "An action link to refund a portion of the settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialRefund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund a portion of the settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/{linkData}"
                  }
                }
              },
              "cardPayments:reverse": {
                "type": "object",
                "description": "An action link to cancel or refund the full amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:reverse`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel or refund the full amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/sales/reversals/{linkData}"
                  }
                }
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "partialSettleLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:refund": {
                "type": "object",
                "description": "An action link to refund the full settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:refund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund the full settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/full/{linkData}"
                  }
                }
              },
              "cardPayments:partialRefund": {
                "type": "object",
                "description": "An action link to refund a portion of the settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialRefund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund a portion of the settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/{linkData}"
                  }
                }
              },
              "cardPayments:partialSettle": {
                "type": "object",
                "description": "An action link to send a portion of the authorized amount for settlement. <br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialSettle`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to send a portion of the authorized amount for settlement.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/{linkData}"
                  }
                }
              },
              "cardPayments:cancel": {
                "type": "object",
                "description": "An action link to cancel the full authorized amount. <br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:cancel`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel the full authorized amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/{linkData}"
                  }
                }
              },
              "cardPayments:reverse": {
                "type": "object",
                "description": "An action link to cancel or refund the full amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:reverse`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel or refund the full amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/sales/reversals/{linkData}"
                  }
                }
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "fullRefundLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "partialRefundLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:partialRefund": {
                "type": "object",
                "description": "An action link to refund a portion of the settled amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialRefund`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to refund a portion of the settled amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/{linkData}"
                  }
                }
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "fullCancelLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "partialCancelLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:cancel": {
                "type": "object",
                "description": "An action link to cancel the full authorized amount.<br><br> For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:cancel`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel the full authorized amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/{linkData}"
                  }
                }
              },
              "cardPayments:partialCancel": {
                "type": "object",
                "description": "An action link to cancel a portion of the authorized amount.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialCancel`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to cancel a portion of the authorized amount.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/partials/{linkData}"
                  }
                }
              },
              "cardPayments:settle": {
                "type": "object",
                "description": "An action link to send the full authorized amount for settlement. <br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:settle`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to send the full authorized amount for settlement.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/{linkData}"
                  }
                }
              },
              "cardPayments:partialSettle": {
                "type": "object",
                "description": "An action link to send a portion of the authorized amount for settlement.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:partialSettle`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to send a portion of the authorized amount for settlement.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/{linkData}"
                  }
                }
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "reversalLinks": {
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "description": "Self link to the page.",
            "properties": {
              "href": {
                "type": "string",
                "description": "Self link to the page."
              },
              "cardPayments:events": {
                "type": "object",
                "description": "An action link to retrieve the last event of the payment.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:events`.",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "An action link to retrieve the last event of the payment.",
                    "example": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
                  }
                }
              }
            }
          }
        }
      },
      "pq_querybypaymentid_200_response": {
        "type": "object",
        "properties": {
          "timestamp": {
            "type": "string",
            "description": "Payment initial authorization time.",
            "example": "2024-05-30T09:49:45.962Z"
          },
          "paymentId": {
            "$ref": "#/components/schemas/paymentId"
          },
          "transactionReference": {
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$",
            "type": "string",
            "description": "A unique reference generated by you, used to identify a payment throughout its lifecycle."
          },
          "narrative": {
            "required": [
              "line1"
            ],
            "type": "object",
            "description": "The text that appears on your customer's statement. Used to identify the merchant.",
            "properties": {
              "line1": {
                "type": "string",
                "description": "The first line of the narrative which appears on your customer's statement (24 characters max. If character is not supported it is replaced with a space)."
              },
              "line2": {
                "type": "string",
                "description": "Additional details about the payment e.g. order number, telephone number."
              }
            }
          },
          "transactionType": {
            "enum": [
              "oneTime",
              "cardOnFile",
              "recurring"
            ],
            "type": "string",
            "description": "The transaction type of the payment."
          },
          "authorizationType": {
            "enum": [
              "authorization",
              "sale"
            ],
            "type": "string",
            "description": "The authorization type of the payment."
          },
          "entity": {
            "maxLength": 32,
            "minLength": 1,
            "pattern": "^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$",
            "type": "string",
            "description": "Merchant entity name.",
            "example": "default"
          },
          "lastEvent": {
            "$ref": "#/components/schemas/lastEvent"
          },
          "scheme": {
            "required": [
              "reference"
            ],
            "type": "object",
            "description": "An object containing information returned by the card scheme.",
            "properties": {
              "reference": {
                "type": "string",
                "description": "The reference returned by the scheme for this particular payment authorization.",
                "example": "MCCOLXT1C0104  "
              }
            }
          },
          "issuer": {
            "required": [
              "authorizationCode"
            ],
            "type": "object",
            "description": "An object containing information returned by the issuer.",
            "properties": {
              "authorizationCode": {
                "pattern": "^[a-zA-Z0-9]+$",
                "type": "string",
                "description": "A code returned by the card issuer for a successful authorization. Used in reconciliation and dispute management.",
                "example": "T31306"
              }
            }
          },
          "paymentInstrument": {
            "type": "object",
            "description": "The payment instrument supplied in the authorization request.",
            "properties": {
              "type": {
                "enum": [
                  "card/plain",
                  "card/network",
                  "card/networkToken",
                  "card/networkToken+applepay",
                  "card/networkToken+googlepay",
                  "card/plain+masked"
                ],
                "type": "string",
                "description": "The type of payment instrument supplied in the authorization request."
              },
              "card": {
                "type": "object",
                "description": "An object that contains information about the card used.",
                "properties": {
                  "number": {
                    "type": "object",
                    "description": "An object that contains information about the card number.",
                    "properties": {
                      "cardBin": {
                        "pattern": "^[0-9*]+$",
                        "type": "string",
                        "description": "The card BIN (Bank Identification Number) is the first 6 or 8 digits of the card number, and can be used to identify the card issuer, the card brand(s) (eg Visa, Cartes Bancaires), and the country. Card BINs are used to route transactions, check card capabilities, and in fraud assessments.",
                        "example": "444433"
                      },
                      "last4Digits": {
                        "pattern": "^[0-9*]+$",
                        "type": "string",
                        "description": "The last four digits of the card. Some characters may be obfuscated with a `*` if the PAN length is less than 16 characters.",
                        "example": "1111"
                      }
                    }
                  },
                  "category": {
                    "type": "string",
                    "description": "Whether the card is classed as a consumer card or a card for commercial use.",
                    "enum": [
                      "commercial",
                      "consumer"
                    ]
                  },
                  "countryCode": {
                    "maxLength": 2,
                    "minLength": 2,
                    "pattern": "^[A-Z]+$",
                    "type": "string",
                    "description": "The [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes) country code that the card was issued in. May return `N/A` where the country is unknown.",
                    "example": "GB"
                  },
                  "expiryDate": {
                    "type": "object",
                    "description": "The expiry date of the card or network token (where the supplied paymentInstrument was `card/wallet+applepay`, `card/wallet+googlepay`, `card/networkToken`, `card/networkToken+applepay` or `card/networkToken+googlepay`).",
                    "properties": {
                      "month": {
                        "type": "integer"
                      },
                      "year": {
                        "type": "integer"
                      }
                    }
                  },
                  "issuerName": {
                    "type": "string",
                    "description": "The name of the card issuer.",
                    "example": "AN ISSUING BANK LTD"
                  },
                  "fundingType": {
                    "type": "string",
                    "description": "How the card is funded.",
                    "enum": [
                      "credit",
                      "debit",
                      "prepaid",
                      "chargeCard",
                      "deferredDebit"
                    ]
                  },
                  "brand": {
                    "type": "string",
                    "description": "The card brand that the transaction was processed with. Sometimes referred to as the network or scheme.",
                    "example": "visa"
                  },
                  "paymentAccountReference": {
                    "type": "string",
                    "description": "The payment account reference (PAR) is a non-financial reference that uniquely identifies the underlying cardholder account. This allows you to correlate payments made from the same account with differing instruments (e.g. `card/plain` and `card/wallet+applepay`), where the same account funds the transaction. A PAR cannot be used to initiate a payment.",
                    "example": "Q1HJZ28RKA1EBL470G9XYG90R5D3E"
                  }
                }
              }
            }
          },
          "updatedPaymentInstrument": {
            "type": "object",
            "description": "The payment instrument supplied in the authorization request.",
            "properties": {
              "type": {
                "enum": [
                  "card/networkToken",
                  "card/plain+masked"
                ],
                "type": "string",
                "description": "The type of payment instrument supplied in the authorization request."
              },
              "card": {
                "type": "object",
                "description": "An object that contains information about the card used.",
                "properties": {
                  "number": {
                    "type": "object",
                    "description": "An object that contains information about the card number.",
                    "properties": {
                      "cardBin": {
                        "pattern": "^[0-9*]+$",
                        "type": "string",
                        "description": "The card BIN (Bank Identification Number) is the first 6 or 8 digits of the card number, and can be used to identify the card issuer, the card brand(s) (eg Visa, Cartes Bancaires), and the country. Card BINs are used to route transactions, check card capabilities, and in fraud assessments.",
                        "example": "444433"
                      },
                      "last4Digits": {
                        "pattern": "^[0-9*]+$",
                        "type": "string",
                        "description": "The last four digits of the card. Some characters may be obfuscated with a `*` if the PAN length is less than 16 characters.",
                        "example": "1111"
                      }
                    }
                  },
                  "expiryDate": {
                    "type": "object",
                    "description": "The expiry date of the card or network token (where the supplied paymentInstrument was `card/wallet+applepay`, `card/wallet+googlepay`, `card/networkToken`, `card/networkToken+applepay` or `card/networkToken+googlepay`).",
                    "properties": {
                      "month": {
                        "type": "integer"
                      },
                      "year": {
                        "type": "integer"
                      }
                    }
                  },
                  "fundingType": {
                    "type": "string",
                    "description": "How the card is funded.",
                    "enum": [
                      "credit",
                      "debit",
                      "prepaid",
                      "chargeCard",
                      "deferredDebit"
                    ]
                  },
                  "brand": {
                    "type": "string",
                    "description": "The card brand that the transaction was processed with. Sometimes referred to as the network or scheme.",
                    "example": "visa"
                  }
                }
              },
              "accountUpdaterMessage": {
                "type": "string",
                "description": "Details on the type of payment instrument update.",
                "enum": [
                  "The merchant is not registered in the update program",
                  "The account number was changed",
                  "The account was closed",
                  "The expiry was changed",
                  "The issuing bank does not participate in the update program",
                  "Contact the cardholder for updated information",
                  "No match found",
                  "No changes found"
                ],
                "x-enumDescriptions": {
                  "The merchant is not registered in the update program": "Returned for Real Time Account Updater only. Contact Worldpay to enroll in the service.",
                  "The account number was changed": "A new card has been issued with a change in the card number.",
                  "The account was closed": "The account is closed and the card is no longer valid. Ask your customer for an alternative payment method.",
                  "The expiry was changed": "A new card has been issued with an updated expiry date. In most cases the card number remains unchanged.",
                  "The issuing bank does not participate in the update program": "Returned for Real Time Account Updater only. It is not known whether an account update is available.",
                  "Contact the cardholder for updated information": "A match was found but you may need to contact the cardholder for updated card details. This could be due to cardholder opt-out or other reasons.",
                  "No match found": "The BIN range is enrolled for account updates, but no match was found for the card account. One reason for this may be that the card issuer has recently changed.",
                  "No changes found": "No changes to the card account were found."
                }
              }
            }
          },
          "value": {
            "required": [
              "amount",
              "currency"
            ],
            "type": "object",
            "description": "An object that contains payment amount and currency.",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."
              },
              "currency": {
                "type": "string",
                "description": "The 3 digit currency code."
              }
            }
          },
          "events": {
            "required": [
              "eventName",
              "timestamp"
            ],
            "type": "array",
            "description": "An array that contains the history of events of a payment.",
            "items": {
              "type": "object",
              "description": "Name of the event.",
              "oneOf": [
                {
                  "$ref": "#/components/schemas/authorizationRequested"
                },
                {
                  "$ref": "#/components/schemas/authorizationSucceeded"
                },
                {
                  "$ref": "#/components/schemas/authorizationRefused"
                },
                {
                  "$ref": "#/components/schemas/authorizationFailed"
                },
                {
                  "$ref": "#/components/schemas/authorizationTimedOut"
                },
                {
                  "$ref": "#/components/schemas/saleRequested"
                },
                {
                  "$ref": "#/components/schemas/saleSucceeded"
                },
                {
                  "$ref": "#/components/schemas/saleRefused"
                },
                {
                  "$ref": "#/components/schemas/saleFailed"
                },
                {
                  "$ref": "#/components/schemas/saleTimedOut"
                },
                {
                  "$ref": "#/components/schemas/settlementRequested"
                },
                {
                  "$ref": "#/components/schemas/settlementRequestSubmitted"
                },
                {
                  "$ref": "#/components/schemas/settlementRequestSubmissionFailed"
                },
                {
                  "$ref": "#/components/schemas/settlementRequestSubmissionTimedOut"
                },
                {
                  "$ref": "#/components/schemas/refundRequested"
                },
                {
                  "$ref": "#/components/schemas/refundRequestSubmitted"
                },
                {
                  "$ref": "#/components/schemas/refundRequestSubmissionFailed"
                },
                {
                  "$ref": "#/components/schemas/refundRequestSubmissionTimedOut"
                },
                {
                  "$ref": "#/components/schemas/cancellationRequested"
                },
                {
                  "$ref": "#/components/schemas/cancellationRequestSubmitted"
                },
                {
                  "$ref": "#/components/schemas/cancellationRequestSubmissionFailed"
                },
                {
                  "$ref": "#/components/schemas/cancellationRequestSubmissionTimedOut"
                },
                {
                  "$ref": "#/components/schemas/reversalRequested"
                },
                {
                  "$ref": "#/components/schemas/reversalRequestSubmitted"
                },
                {
                  "$ref": "#/components/schemas/reversalRequestSubmissionFailed"
                },
                {
                  "$ref": "#/components/schemas/reversalRequestSubmissionTimedOut"
                }
              ],
              "discriminator": {
                "propertyName": "eventName",
                "mapping": {
                  "authorizationRequested": "#/components/schemas/authorizationRequested",
                  "authorizationSucceeded": "#/components/schemas/authorizationSucceeded",
                  "authorizationRefused": "#/components/schemas/authorizationRefused",
                  "authorizationFailed": "#/components/schemas/authorizationFailed",
                  "authorizationTimedOut": "#/components/schemas/authorizationTimedOut",
                  "saleRequested": "#/components/schemas/saleRequested",
                  "saleSucceeded": "#/components/schemas/saleSucceeded",
                  "saleRefused": "#/components/schemas/saleRefused",
                  "saleFailed": "#/components/schemas/saleFailed",
                  "saleTimedOut": "#/components/schemas/saleTimedOut",
                  "settlementRequested": "#/components/schemas/settlementRequested",
                  "settlementRequestSubmitted": "#/components/schemas/settlementRequestSubmitted",
                  "settlementRequestSubmissionFailed": "#/components/schemas/settlementRequestSubmissionFailed",
                  "settlementRequestSubmissionTimedOut": "#/components/schemas/settlementRequestSubmissionTimedOut",
                  "refundRequested": "#/components/schemas/refundRequested",
                  "refundRequestSubmitted": "#/components/schemas/refundRequestSubmitted",
                  "refundRequestSubmissionFailed": "#/components/schemas/refundRequestSubmissionFailed",
                  "refundRequestSubmissionTimedOut": "#/components/schemas/refundRequestSubmissionTimedOut",
                  "cancellationRequested": "#/components/schemas/cancellationRequested",
                  "cancellationRequestSubmitted": "#/components/schemas/cancellationRequestSubmitted",
                  "cancellationRequestSubmissionFailed": "#/components/schemas/cancellationRequestSubmissionFailed",
                  "cancellationRequestSubmissionTimedOut": "#/components/schemas/cancellationRequestSubmissionTimedOut",
                  "reversalRequested": "#/components/schemas/reversalRequested",
                  "reversalRequestSubmitted": "#/components/schemas/reversalRequestSubmitted",
                  "reversalRequestSubmissionFailed": "#/components/schemas/reversalRequestSubmissionFailed",
                  "reversalRequestSubmissionTimedOut": "#/components/schemas/reversalRequestSubmissionTimedOut"
                }
              }
            }
          },
          "_links": {
            "required": [
              "self"
            ],
            "type": "object",
            "description": "Self link and next action links.<br><br>For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is `payments:cancel`,`payments:refund` etc.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/selfLinkOnly"
              },
              {
                "$ref": "#/components/schemas/authorizationSucceededLinks"
              },
              {
                "$ref": "#/components/schemas/sentForSettlementLinks"
              },
              {
                "$ref": "#/components/schemas/fullSettleLinks"
              },
              {
                "$ref": "#/components/schemas/partialSettleLinks"
              },
              {
                "$ref": "#/components/schemas/fullRefundLinks"
              },
              {
                "$ref": "#/components/schemas/partialRefundLinks"
              },
              {
                "$ref": "#/components/schemas/fullCancelLinks"
              },
              {
                "$ref": "#/components/schemas/partialCancelLinks"
              },
              {
                "$ref": "#/components/schemas/reversalLinks"
              }
            ],
            "discriminator": {
              "propertyName": "self",
              "mapping": {
                "Self link": "#/components/schemas/selfLinkOnly",
                "Authorized": "#/components/schemas/authorizationSucceededLinks",
                "Sent for settlement": "#/components/schemas/sentForSettlementLinks",
                "Settle for full amount": "#/components/schemas/fullSettleLinks",
                "Settle for partial amount": "#/components/schemas/partialSettleLinks",
                "Refund full amount": "#/components/schemas/fullRefundLinks",
                "Refund partial amount": "#/components/schemas/partialRefundLinks",
                "Cancel full authorization": "#/components/schemas/fullCancelLinks",
                "Cancel partial authorization": "#/components/schemas/partialCancelLinks",
                "Reversal": "#/components/schemas/reversalLinks"
              }
            }
          }
        }
      }
    }
  }
}
```

### Response example


```json
{
  "timestamp":"2025-06-08T16:11:13.164Z",
  "paymentId":"payVGX28GOT7iDY5qanttPWF0",
  "transactionReference":"89197aeb-c94a-456e-8014-1272fbcb64eb",
  "narrative":{
    "line1":"trading name",
    "line2":"order number"
  },
  "transactionType":"oneTime",
  "authorizationType":"authorization",
  "lastEvent": "refundRequestSubmitted",
  "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"
    },
    "cardPayments:events":{
      "href":"https://access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"
    },
    "cardPayments:partialRefund":{
      "href":"https://access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/{linkData}"
    }
  }
}
```

Recovery
If you are unable to locate a payment or you think your authorization request has timed out, you can query your payment through our [recovery endpoint](/products/card-payments/openapi/query-a-payment/eventrecovery). If the query returns results, you can manage the payment using the next action links returned in that response.

**Next steps**

[Manage follow on actions](/products/card-payments/openapi/manage-payments) such as refunding, cancelling, reversing and settling your payment.