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

  - `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", "settlementFailed", "settlementTimedOut", "refundRequested", "refundRequestSubmitted", "refundFailed", "refundTimedOut", "cancellationRequested", "cancellationRequestSubmitted", "cancellationFailed", "cancellationTimedOut", "reversalRequested", "reversalRequestSubmitted", "reversalFailed", "reversalTimedOut"

  - `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"

  - `paymentInstrument` (object)
    The payment instrument supplied in the authorization request.

  - `paymentInstrument.type` (string)
    The type of payment instrument supplied in the authorization request.
    Enum: "card/plain", "card/network", "card/networkToken", "card/networkToken+applepay", "card/networkToken+googlepay", "card/plain+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) (eg 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.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.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)
    An array that contains the history of events of a payment.

  - `_links` (object)
    Self link and next action links.

  - `_links.self` (object, required)
    Self link to the page.

  - `_links.self.href` (string)
    Self link to the page.

  - `_links.payments:cancel` (object)
    Next action links.

  - `_links.payments:cancel.href` (string)
    Next action links.

  - `_links.payments:events` (object)
    Next action links.

  - `_links.payments:settle` (object)
    Next action links.

  - `_links.payments:partialSettle` (object)
    Next action links.

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