# Retrieve a payment

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.

Endpoint: GET /paymentQueries/payments/{paymentId}
Version: 1
Security: BasicAuth

## Header parameters:

  - `Accept` (string, required)
    Example: "application/vnd.worldpay.payment-queries-v1.hal+json"

## Path parameters:

  - `paymentId` (string, required)
    Unique identifier generated for each payment. Historic paymentId values in UUID format.
    Example: "payv0A4Hx2eY1-5P2_CpV7qy0"

## Response 200 fields (application/vnd.worldpay.payment-queries-v1.hal+json):

  - `timestamp` (string)
    Payment initial authorization time.
    Example: "2024-05-30T09:49:45.962Z"

  - `paymentId` (string)
    Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
    Example: "pay4u_lHl2jobU5S1T2pWkq10"

  - `transactionReference` (string)
    A unique reference, generated by you, used to identify a payment throughout its lifecycle.

  - `orderReference` (string)
    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.

  - `narrative` (object)
    The text that appears on your customer's statement. Used to identify the merchant.

  - `narrative.line1` (string, required)
    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).

  - `narrative.line2` (string)
    Additional details about the payment e.g. order number, telephone number.

  - `transactionType` (string)
    The transaction type of the payment.
    Enum: "oneTime", "cardOnFile", "recurring"

  - `authorizationType` (string)
    The authorization type of the payment.
    Enum: "authorization", "sale"

  - `entity` (string)
    Merchant entity name.
    Example: "default"

  - `lastEvent` (string)
    The last event received for the payment
    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"

  - `scheme` (object)
    An object containing information returned by the card scheme.

  - `scheme.reference` (string, required)
    The reference returned by the scheme for this particular payment authorization.
    Example: "MCCOLXT1C0104  "

  - `issuer` (object)
    An object containing information returned by the issuer.

  - `issuer.authorizationCode` (string, required)
    A code returned by the card issuer for a successful authorization. Used in reconciliation and dispute management.
    Example: "T31306"

  - `token` (object)
    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](/products/modular/) only.

  - `token.href` (string)
    An https address for an Access Worldpay Token.
    Example: "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"

  - `token.tokenId` (string)
    Worldpay's internal identifier for a token.
    Example: "9897039852081922819"

  - `paymentInstrument` (object)
    An object that contains information about the payment type.

  - `paymentInstrument.type` (string)
    The type of payment instrument used for this payment.
    Enum: "card/plain", "card/token", "card/checkout", "card/wallet+applepay", "card/wallet+googlepay", "card/networkToken", "card/networkToken+applepay", "card/networkToken+googlepay", "card/network", "card/plain+masked", "card/network+masked"

  - `paymentInstrument.card` (object)
    An object that contains information about the card used.

  - `paymentInstrument.card.number` (object)
    An object that contains information about the card number.

  - `paymentInstrument.card.number.cardBin` (string)
    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) (e.g. Visa, Cartes Bancaires), and the country. Card BINs are used to route transactions, check card capabilities, and in fraud assessments.
    Example: "444433"

  - `paymentInstrument.card.number.last4Digits` (string)
    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"

  - `paymentInstrument.card.number.fpanLastFour` (string)
    The last four digits of the actual card, where this was submitted in an authorization request that used a network token or a [mobile wallet](/products/wallets#submitting-card-metadata-to-worldpay) (encrypted or decrypted) paymentInstrument. Commonly referred to as the Funding Primary Account Number (FPAN).
    Example: "1111"

  - `paymentInstrument.card.category` (string)
    Whether the card is classed as a consumer card or a card for commercial use.
    Enum: "commercial", "consumer"

  - `paymentInstrument.card.countryCode` (string)
    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"

  - `paymentInstrument.card.expiryDate` (object)
    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).

  - `paymentInstrument.card.expiryDate.month` (integer)

  - `paymentInstrument.card.expiryDate.year` (integer)

  - `paymentInstrument.card.issuerName` (string)
    The name of the card issuer.
    Example: "AN ISSUING BANK LTD"

  - `paymentInstrument.card.fundingType` (string)
    How the card is funded.
    Enum: "credit", "debit", "prepaid", "chargeCard", "deferredDebit"

  - `paymentInstrument.card.brand` (string)
    The card brand that the transaction was processed with. Sometimes referred to as the network or scheme.
    Example: "visa"

  - `paymentInstrument.card.paymentAccountReference` (string)
    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` (object)
    The payment instrument supplied in the authorization request.

  - `updatedPaymentInstrument.type` (string)
    The type of payment instrument supplied in the authorization request.
    Enum: "card/networkToken", "card/plain+masked"

  - `updatedPaymentInstrument.card` (object)
    An object that contains information about the card used.

  - `updatedPaymentInstrument.card.number` (object)
    An object that contains information about the card number.

  - `updatedPaymentInstrument.card.number.cardBin` (string)
    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"

  - `updatedPaymentInstrument.card.number.last4Digits` (string)
    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"

  - `updatedPaymentInstrument.card.expiryDate` (object)
    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).

  - `updatedPaymentInstrument.card.expiryDate.month` (integer)

  - `updatedPaymentInstrument.card.expiryDate.year` (integer)

  - `updatedPaymentInstrument.card.fundingType` (string)
    How the card is funded.
    Enum: same as `paymentInstrument.card.fundingType` (5 values)

  - `updatedPaymentInstrument.card.brand` (string)
    The card brand that the transaction was processed with. Sometimes referred to as the network or scheme.
    Example: "visa"

  - `updatedPaymentInstrument.accountUpdaterMessage` (string)
    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"

  - `value` (object)
    An object that contains payment amount and currency.

  - `value.amount` (integer, required)
    This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250).

  - `value.currency` (string, required)
    The 3 digit currency code.

  - `events` (array) — one of (discriminator: eventName):
    An array that contains the history of events of a payment.
    - authorizationRequested:
      - `eventName` (string, required)
        Worldpay has received your authorization request.
        Enum: "authorizationRequested"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - authorizationSucceeded:
      - `eventName` (string, required)
        Your authorization request was successfully approved by the card issuer.
        Enum: "authorizationSucceeded"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `outcome` (string)
        Outcome of the event. For every requested event there can be a successful or refused event outcome.
        Enum: "authorized"
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - authorizationRefused:
      - `eventName` (string, required)
        Your authorization request was refused by the card issuer.
        Enum: "authorizationRefused"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `outcome` (string)
        Outcome of the event. For every requested event there can be a successful or refused event outcome.
        Enum: "refused"
      - `code` (string)
        The response code, used to identify the refusal reason.
        Example: "65"
      - `description` (string)
        The description of the refusal reason.
        Example: "Authentication Requested"
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - authorizationFailed:
      - `eventName` (string, required)
        Your authorization request failed.
        Enum: "authorizationFailed"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `error` (object)
        All Failed events return error object with name and message.
      - `error.name` (string)
        Example values are,
        Enum: "internalErrorOccurred", "transactionReferenceIsADuplicate", "transactionHasAlreadyBeenProcessed", "channelIsNotSupported", "currencyIsNotSupported", "paymentInstrumentIsNotSupported", "fieldHasInvalidValue", "fieldIsEmpty", "cardNumberIsNotRecognized", "underlyingPaymentInstrumentHasExpired", "entityIsNotConfigured"
      - `error.message` (string)
        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` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - authorizationTimedOut:
      - `eventName` (string, required)
        Your authorization request timed out.
        Enum: "authorizationTimedOut"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - saleRequested:
      - `eventName` (string, required)
        Worldpay has received your sale request.
        Enum: "saleRequested"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - saleSucceeded:
      - `eventName` (string, required)
        Your authorization request was successfully approved by the card issuer.
        Enum: "saleSucceeded"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `outcome` (string)
        Outcome of the event. For every requested event there can be a successful or refused event outcome.
        Enum: same as `outcome` in "authorizationSucceeded" (1 values)
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - saleRefused:
      - `eventName` (string, required)
        Your sale request was refused by the card issuer.
        Enum: "saleRefused"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `outcome` (string)
        Outcome of the event. For every requested event there can be a successful or refused event outcome.
        Enum: same as `outcome` in "authorizationRefused" (1 values)
      - `code` (string)
        The response code, used to identify the refusal reason.
        Example: "65"
      - `description` (string)
        The description of the refusal reason.
        Example: "Authentication Requested"
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - saleFailed:
      - `eventName` (string, required)
        Your sale request failed.
        Enum: "saleFailed"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `error` (object)
        All Failed events return error object with name and message.
      - `error.name` (string)
        Example values are,
        Enum: same as `error.name` in "authorizationFailed" (11 values)
      - `error.message` (string)
        Example values are,
        Enum: same as `error.message` in "authorizationFailed" (5 values)
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - saleTimedOut:
      - `eventName` (string, required)
        Your sale request timed out.
        Enum: "saleTimedOut"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - settlementRequested:
      - `eventName` (string, required)
        Worldpay has received your settlement request.
        Enum: "settlementRequested"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `type` (string)
        Enum: "fullSettlement", "partialSettlement"
      - `settlementReference` (string)
        Your settlement reference
      - `value` (object)
        An object that contains the amount and currency requested for settlement.
      - `value.amount` (integer, required)
        This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250).
      - `value.currency` (string, required)
        The 3 digit currency code.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - settlementRequestSubmitted:
      - `eventName` (string, required)
        Your settlement request was successfully sent for processing.
        Enum: "settlementRequestSubmitted"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - settlementRequestSubmissionFailed:
      - `eventName` (string, required)
        Your settlement request failed.
        Enum: "settlementRequestSubmissionFailed"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - settlementRequestSubmissionTimedOut:
      - `eventName` (string, required)
        Your settlement request timed out.
        Enum: "settlementRequestSubmissionTimedOut"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - refundRequested:
      - `eventName` (string, required)
        Worldpay has received your refund request.
        Enum: "refundRequested"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `type` (string)
        Enum: "fullRefund", "partialRefund"
      - `refundReference` (string)
        Your refund reference
      - `value` (object)
        An object that contains the amount and currency requested for refund.
      - `value.amount` (integer, required)
        This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250).
      - `value.currency` (string, required)
        The 3 digit currency code.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - refundRequestSubmitted:
      - `eventName` (string, required)
        Your refund request was successfully sent for processing.
        Enum: "refundRequestSubmitted"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - refundRequestSubmissionFailed:
      - `eventName` (string, required)
        Your refund request failed.
        Enum: "refundRequestSubmissionFailed"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - refundRequestSubmissionTimedOut:
      - `eventName` (string, required)
        Your refund request timed out.
        Enum: "refundRequestSubmissionTimedOut"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - cancellationRequested:
      - `eventName` (string, required)
        Worldpay has received your cancellation request.
        Enum: "cancellationRequested"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - cancellationRequestSubmitted:
      - `eventName` (string, required)
        Your cancellation request was successfully sent for processing.
        Enum: "cancellationRequestSubmitted"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - cancellationRequestSubmissionFailed:
      - `eventName` (string, required)
        Your cancellation request failed.
        Enum: "cancellationRequestSubmissionFailed"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - cancellationRequestSubmissionTimedOut:
      - `eventName` (string, required)
        Your cancellation request timed out.
        Enum: "cancellationRequestSubmissionTimedOut"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - reversalRequested:
      - `eventName` (string, required)
        Worldpay has received your reversal request.
        Enum: "reversalRequested"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `value` (object)
        An object that contains the amount and currency requested for reversal.
      - `value.amount` (integer, required)
        This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250).
      - `value.currency` (string, required)
        The 3 digit currency code.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - reversalRequestSubmitted:
      - `eventName` (string, required)
        Your reversal request was successfully sent for processing.
        Enum: "reversalRequestSubmitted"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - reversalRequestSubmissionFailed:
      - `eventName` (string, required)
        Your reversal request failed.
        Enum: "reversalRequestSubmissionFailed"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"
    - reversalRequestSubmissionTimedOut:
      - `eventName` (string, required)
        Your reversal request timed out.
        Enum: "reversalRequestSubmissionTimedOut"
      - `timestamp` (string)
        The ISO 8601 date-time at which the event was created.
      - `commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
        Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"

  - `_links` (object) — one of (discriminator: self):
    Self link and next action links.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.
    - Self link:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
    - Authorized:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:cancel` (object)
        An action link to cancel the full authorized amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:cancel.
      - `self.cardPayments:cancel.href` (string)
        An action link to cancel the full authorized amount.
        Example: "https://try.access.worldpay.com/payments/authorizations/cancellations/{linkData}"
      - `self.cardPayments:partialCancel` (object)
        An action link to cancel a portion of the authorized amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialCancel.
      - `self.cardPayments:partialCancel.href` (string)
        An action link to cancel a portion of the authorized amount.
        Example: "https://try.access.worldpay.com/payments/authorizations/cancellations/partials/{linkData}"
      - `self.cardPayments:settle` (object)
        An action link to send the full authorized amount for settlement.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:settle.
      - `self.cardPayments:settle.href` (string)
        An action link to send the full authorized amount for settlement.
        Example: "https://try.access.worldpay.com/payments/settlements/full/{linkData}"
      - `self.cardPayments:partialSettle` (object)
        An action link to send a portion of the authorized amount for settlement. For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialSettle.
      - `self.cardPayments:partialSettle.href` (string)
        An action link to send a portion of the authorized amount for settlement.
        Example: "https://try.access.worldpay.com/payments/settlements/partials/{linkData}"
      - `self.cardPayments:reverse` (object)
        An action link to cancel or refund the full amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:reverse.
      - `self.cardPayments:reverse.href` (string)
        An action link to cancel or refund the full amount.
        Example: "https://try.access.worldpay.com/payments/authorizations/reversals/{linkData}"
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Sent for settlement:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:refund` (object)
        An action link to refund the full settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:refund.
      - `self.cardPayments:refund.href` (string)
        An action link to refund the full settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/full/{linkData}"
      - `self.cardPayments:partialRefund` (object)
        An action link to refund a portion of the settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialRefund.
      - `self.cardPayments:partialRefund.href` (string)
        An action link to refund a portion of the settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/partials/{linkData}"
      - `self.cardPayments:reverse` (object)
        An action link to cancel or refund the full amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:reverse.
      - `self.cardPayments:reverse.href` (string)
        An action link to cancel or refund the full amount.
        Example: "https://try.access.worldpay.com/payments/sales/reversals/{linkData}"
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Settle for full amount:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:refund` (object)
        An action link to refund the full settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:refund.
      - `self.cardPayments:refund.href` (string)
        An action link to refund the full settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/full/{linkData}"
      - `self.cardPayments:partialRefund` (object)
        An action link to refund a portion of the settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialRefund.
      - `self.cardPayments:partialRefund.href` (string)
        An action link to refund a portion of the settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/partials/{linkData}"
      - `self.cardPayments:reverse` (object)
        An action link to cancel or refund the full amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:reverse.
      - `self.cardPayments:reverse.href` (string)
        An action link to cancel or refund the full amount.
        Example: "https://try.access.worldpay.com/payments/sales/reversals/{linkData}"
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Settle for partial amount:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:refund` (object)
        An action link to refund the full settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:refund.
      - `self.cardPayments:refund.href` (string)
        An action link to refund the full settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/full/{linkData}"
      - `self.cardPayments:partialRefund` (object)
        An action link to refund a portion of the settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialRefund.
      - `self.cardPayments:partialRefund.href` (string)
        An action link to refund a portion of the settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/partials/{linkData}"
      - `self.cardPayments:partialSettle` (object)
        An action link to send a portion of the authorized amount for settlement. For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialSettle.
      - `self.cardPayments:partialSettle.href` (string)
        An action link to send a portion of the authorized amount for settlement.
        Example: "https://try.access.worldpay.com/payments/settlements/partials/{linkData}"
      - `self.cardPayments:cancel` (object)
        An action link to cancel the full authorized amount. For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:cancel.
      - `self.cardPayments:cancel.href` (string)
        An action link to cancel the full authorized amount.
        Example: "https://try.access.worldpay.com/payments/authorizations/cancellations/{linkData}"
      - `self.cardPayments:reverse` (object)
        An action link to cancel or refund the full amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:reverse.
      - `self.cardPayments:reverse.href` (string)
        An action link to cancel or refund the full amount.
        Example: "https://try.access.worldpay.com/payments/sales/reversals/{linkData}"
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Refund full amount:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Refund partial amount:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:partialRefund` (object)
        An action link to refund a portion of the settled amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialRefund.
      - `self.cardPayments:partialRefund.href` (string)
        An action link to refund a portion of the settled amount.
        Example: "https://try.access.worldpay.com/payments/settlements/refunds/partials/{linkData}"
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Cancel full authorization:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Cancel partial authorization:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:cancel` (object)
        An action link to cancel the full authorized amount. For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:cancel.
      - `self.cardPayments:cancel.href` (string)
        An action link to cancel the full authorized amount.
        Example: "https://try.access.worldpay.com/payments/authorizations/cancellations/{linkData}"
      - `self.cardPayments:partialCancel` (object)
        An action link to cancel a portion of the authorized amount.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialCancel.
      - `self.cardPayments:partialCancel.href` (string)
        An action link to cancel a portion of the authorized amount.
        Example: "https://try.access.worldpay.com/payments/authorizations/cancellations/partials/{linkData}"
      - `self.cardPayments:settle` (object)
        An action link to send the full authorized amount for settlement. For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:settle.
      - `self.cardPayments:settle.href` (string)
        An action link to send the full authorized amount for settlement.
        Example: "https://try.access.worldpay.com/payments/settlements/full/{linkData}"
      - `self.cardPayments:partialSettle` (object)
        An action link to send a portion of the authorized amount for settlement.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:partialSettle.
      - `self.cardPayments:partialSettle.href` (string)
        An action link to send a portion of the authorized amount for settlement.
        Example: "https://try.access.worldpay.com/payments/settlements/partials/{linkData}"
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"
    - Reversal:
      - `self` (object, required)
        Self link to the page.
      - `self.href` (string)
        Self link to the page.
      - `self.cardPayments:events` (object)
        An action link to retrieve the last event of the payment.For any payment query against a payment processed on Card Payments v6 or lower, the action link we return is payments:events.
      - `self.cardPayments:events.href` (string)
        An action link to retrieve the last event of the payment.
        Example: "https://try.access.worldpay.com/payments/events/{linkData}"

## Response 404 fields (application/vnd.worldpay.payment-queries-v1.hal+json):

  - `errorName` (string)
    Example: "paymentNotFound"

  - `message` (string)
    Example: "The payment you are trying to access does not exist."