---
title: "Retrieve an Order"
method: GET
path: "/api/v2_1/orders/{orderId}"
tags: ["Order"]
---

# Retrieve an Order

`GET /api/v2_1/orders/{orderId}`

## Request

- Base URL: `https://secure.payu.com`
- URL: `https://secure.payu.com/api/v2_1/orders/{orderId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/docs/api/v2_1/orders/:orderId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve status and details of an order. By adding query parameter <code>with</code>, you can enrich order data with additional information.
Enrichment may slightly increase the response time.

Note: retrieved order data have the same model as the order data sent in notifications (which can also be enriched).

## Query parameters

- `with` 'authorization' | 'buyer' | 'capture' | 'fees' | 'payMethod' | 'mcp': Additional object to be provided in order details: - authorization - authorization details - buyer - buyer details (by default only provided for order in status COMPLETED) - capture - capture details - fees - array of fees associated with the order (transaction fee, chargeback fee etc.) - payMethod - payMethod details (by default only provided for order in status COMPLETED) - mcp - Multi-Currency Pricing details

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Response `200`

- union
  - object
    - `orders` Order[]: Array of order objects.
      - `shippingMethod` object
        - `country` string: Two-letter country code compliant with ISO-3166
        - `price` string: Shipping cost
        - `name` string: Shipping method name
      - `orderId` string: Order ID generated by the PayU system.
      - `extOrderId` string: External order ID (assigned by your system).
      - `orderCreateDate` string: Order creation timestamp.
      - `notifyUrl` string: Address for sending notifications.
      - `customerIp` string: Customer's IP address. Note: 0.0.0.0 is not accepted.
      - `merchantPosId` string: Point of sale ID.
      - `description` string: Description for order.
      - `additionalDescription` string: Additional description for order.
      - `validityTime` string: Time in seconds after which payment page redirection URL expires and order is canceled if payment has not been initiated.
      - `currencyCode` string: Currency code compliant with ISO 4217.
      - `totalAmount` string: Total price of the order.
      - `capturedAmount` string: Amount already captured for the order.
      - `buyer` Buyer: Section containing buyer data.
        - `extCustomerId` string: ID of the customer used in merchant system
        - `email` string: Buyer's email address. **Required for Installments (PL), Pay Later (PL), Pay Later with Twisto (CZ), 3DS 2 authentication.**
        - `phone` string: Buyer's telephone number. Please use +[country code] [number] format. **Required for Pay Later with Twisto (CZ), 3DS 2 authentication.**
        - `firstName` string: Buyer's first name. </br>**Required for Pay Later with Twisto (CZ) and AFT card authorization (Account Funding Transaction)** </br></br>**In case of AFT card authorization you have to use ISO/IEC 8859-1 encoding**.
        - `lastName` string: Buyer's last name. </br>**Required for Pay Later with Twisto (CZ) and AFT card authorization (Account Funding Transaction)**</br></br>**In case of AFT card authorization you have to use ISO/IEC 8859-1 encoding**.
        - `nin` string: National Identification Number
        - `language` string: Language code, ISO-639-1 compliant. Denotes the language version of PayU hosted payment page and of e-mail messages sent from PayU to the payer.
        - `birthDate` string, ISO 8601: Buyer's date of birth. **Required for AFT card authorization (Account Funding Transaction)**.
        - `delivery` Delivery: Section containing delivery address. For a list of parameters, see section delivery
          - `street` string: Full street address, incl. apartment number. <b>Section recommended for the 3DS 2 authentication</b>.
          - `postalBox` string: Postal box
          - `postalCode` string: Postal code. <b>Section recommended for the 3DS 2 authentication</b>.
          - `city` string: City, <b>section recommended for the 3DS 2 authentication</b>.
          - `state` string: Country principal subdivision like "state" or "province". If provided, must be a valid ISO 3166-2 code (e.g. "UT" for Utah in the USA or "30" for "Wielkopolskie" in Poland). <b>Section recommended for the 3DS 2 authentication</b>.
          - `countryCode` string: Two-letter country code compliant with <b><a href="https://www.iso.org/iso-3166-country-codes.html">ISO-3166</a></b>. <b>Section recommended for the 3DS 2 authentication</b>.
          - `name` string: Address description
          - `recipientName` string: Recipient name
          - `recipientEmail` string: Ecipient email
          - `recipientPhone` string: Recipient phone number
      - `payMethod` object
        - `amount` string
        - `type` 'PBL' | 'CARD_TOKEN' | 'INSTALLMENTS'
      - `products` object[]: Section containing data of the ordered products. Section <code>products</code> is an array of objects of type product.
        - `name` string, required: Name of the product.
        - `unitPrice` string, required: Unit price.
        - `quantity` string, required: Quantity of given product
        - `virtual` boolean: Product type, which can be virtual or material. **Even if sent, the virtual parameter is not returned in PAYU notifications.**
      - `shoppingCarts` object[]: Array of objects related to transaction identification.
        - `extCustomerId` string, required: Submerchant identifier
        - `amount` number, required: Total amount for given submerchant
        - `fee` string: Marketplace fee. Value should be in range <0, amount>
        - `shippingMethods` object[]: Array of objects related to shipping method.
          - `country` string, required: Two-letter shipping country code compliant with <b><a href="https://www.iso.org/iso-3166-country-codes.html">ISO-3166</a></b>.
          - `price` number, required: Shipping price.
          - `name` string, required: Shipping method name
        - `products` object[], required: Section containing data of the ordered products. Section <code>products</code> is an array of objects of type product.
          - `name` string, required: Name of the product.
          - `unitPrice` string, required: Unit price.
          - `quantity` string, required: Quantity of given product
          - `virtual` boolean: Product type, which can be virtual or material. **Even if sent, the virtual parameter is not returned in PAYU notifications.**
      - `merchantFunds` object[]: List of merchant funds associated with the order.
        - `type` 'COUPON': Merchant fund type.
        - `value` string: Identifier or code of the fund.
        - `amount` string: Fund amount.
      - `status` 'NEW' | 'PENDING' | 'WAITING_FOR_CONFIRMATION' | 'COMPLETED' | 'CANCELED': Order status.
    - `properties` object[]: Array of objects related to transaction identification.
      - `name` string: Static value. The payment identifier, displayed on transaction statements as "Trans ID" and available as a search option in the Management Panel.
      - `value` string: Transaction ID in PayU system.
  - object
    - `orders` EnrichedOrder[]: Array of order objects with all possible enrichments.
      - `shippingMethod` object
        - `country` string: Two-letter country code compliant with ISO-3166
        - `price` string: Shipping cost
        - `name` string: Shipping method name
      - `orderId` string: Order ID generated by the PayU system.
      - `extOrderId` string: External order ID (assigned by your system).
      - `orderCreateDate` string: Order creation timestamp.
      - `notifyUrl` string: Address for sending notifications.
      - `customerIp` string: Customer's IP address. Note: 0.0.0.0 is not accepted.
      - `merchantPosId` string: Point of sale ID.
      - `description` string: Description for order.
      - `additionalDescription` string: Additional description for order.
      - `validityTime` string: Time in seconds after which payment page redirection URL expires and order is canceled if payment has not been initiated.
      - `currencyCode` string: Currency code compliant with ISO 4217.
      - `totalAmount` string: Total price of the order.
      - `orderUrl` string: URL of the payment page for this order.
      - `capturedAmount` string: Amount already captured for the order.
      - `buyer` Buyer: Section containing buyer data.
        - `extCustomerId` string: ID of the customer used in merchant system
        - `email` string: Buyer's email address. **Required for Installments (PL), Pay Later (PL), Pay Later with Twisto (CZ), 3DS 2 authentication.**
        - `phone` string: Buyer's telephone number. Please use +[country code] [number] format. **Required for Pay Later with Twisto (CZ), 3DS 2 authentication.**
        - `firstName` string: Buyer's first name. </br>**Required for Pay Later with Twisto (CZ) and AFT card authorization (Account Funding Transaction)** </br></br>**In case of AFT card authorization you have to use ISO/IEC 8859-1 encoding**.
        - `lastName` string: Buyer's last name. </br>**Required for Pay Later with Twisto (CZ) and AFT card authorization (Account Funding Transaction)**</br></br>**In case of AFT card authorization you have to use ISO/IEC 8859-1 encoding**.
        - `nin` string: National Identification Number
        - `language` string: Language code, ISO-639-1 compliant. Denotes the language version of PayU hosted payment page and of e-mail messages sent from PayU to the payer.
        - `birthDate` string, ISO 8601: Buyer's date of birth. **Required for AFT card authorization (Account Funding Transaction)**.
        - `delivery` Delivery: Section containing delivery address. For a list of parameters, see section delivery
          - `street` string: Full street address, incl. apartment number. <b>Section recommended for the 3DS 2 authentication</b>.
          - `postalBox` string: Postal box
          - `postalCode` string: Postal code. <b>Section recommended for the 3DS 2 authentication</b>.
          - `city` string: City, <b>section recommended for the 3DS 2 authentication</b>.
          - `state` string: Country principal subdivision like "state" or "province". If provided, must be a valid ISO 3166-2 code (e.g. "UT" for Utah in the USA or "30" for "Wielkopolskie" in Poland). <b>Section recommended for the 3DS 2 authentication</b>.
          - `countryCode` string: Two-letter country code compliant with <b><a href="https://www.iso.org/iso-3166-country-codes.html">ISO-3166</a></b>. <b>Section recommended for the 3DS 2 authentication</b>.
          - `name` string: Address description
          - `recipientName` string: Recipient name
          - `recipientEmail` string: Ecipient email
          - `recipientPhone` string: Recipient phone number
      - `payMethod` object
        - `amount` string
        - `type` 'PBL' | 'CARD_TOKEN' | 'INSTALLMENTS'
      - `products` object[]: Section containing data of the ordered products. Section <code>products</code> is an array of objects of type product.
        - `name` string, required: Name of the product.
        - `unitPrice` string, required: Unit price.
        - `quantity` string, required: Quantity of given product
        - `virtual` boolean: Product type, which can be virtual or material. **Even if sent, the virtual parameter is not returned in PAYU notifications.**
      - `shoppingCarts` object[]: Array of objects related to transaction identification.
        - `extCustomerId` string, required: Submerchant identifier
        - `amount` number, required: Total amount for given submerchant
        - `fee` string: Marketplace fee. Value should be in range <0, amount>
        - `shippingMethods` object[]: Array of objects related to shipping method.
          - `country` string, required: Two-letter shipping country code compliant with <b><a href="https://www.iso.org/iso-3166-country-codes.html">ISO-3166</a></b>.
          - `price` number, required: Shipping price.
          - `name` string, required: Shipping method name
        - `products` object[], required: Section containing data of the ordered products. Section <code>products</code> is an array of objects of type product.
          - `name` string, required: Name of the product.
          - `unitPrice` string, required: Unit price.
          - `quantity` string, required: Quantity of given product
          - `virtual` boolean: Product type, which can be virtual or material. **Even if sent, the virtual parameter is not returned in PAYU notifications.**
      - `merchantFunds` object[]: List of merchant funds associated with the order.
        - `type` 'COUPON': Merchant fund type.
        - `value` string: Identifier or code of the fund.
        - `amount` string: Fund amount.
      - `authorization` Authorization: Authorization details.
        - `amount` string: Authorization amount in minor units.
        - `currencyCode` string: Currency code compliant with ISO 4217. Note: currency may differ if Multi-Currency Pricing was applied.
        - `serviceProcessingType` 'PSP' | 'TSP': Indicates whether PayU acts as payment service provider (PSP) to process and settle the payment, or is technical service provider (TSP) only.
        - `status` 'AUTHORIZED' | 'SOFT_DECLINED' | 'REJECTED' | 'PENDING': Authorization status.
        - `createDate` string: Authorization creation timestamp.
        - `resultDate` string: Date of successful authorization or rejection.
        - `validUntil` string: Date until successful authorization may be captured and order completed.
        - `payType` string: Payment type assigned to authorization.
        - `paymentFlow` 'APPLE_PAY' | 'CARD' | 'CARD_INSTALLMENTS' | 'CLICK_TO_PAY' | 'FIRST_ONE_CLICK_CARD' | 'GOOGLE_PAY' | 'GOOGLE_PAY_TOKENIZED' | 'VISA_MOBILE' | 'ONE_CLICK_CARD' | 'ONE_CLICK_CARD_RECURRING' | 'ONE_CLICK_MAIL_ORDER' | 'ONE_CLICK_MAIL_RECURRING' | 'ONE_CLICK_PHONE_ORDER' | 'ONE_CLICK_PHONE_RECURRING' | 'BLIK_PBL' | 'BLIK_AUTHORIZATION_CODE' | 'BLIK_AUTHORIZATION_CODE_WITH_UID_TOKEN_REGISTERING' | 'BLIK_UID_TOKEN' | 'BLIK_AUTHORIZATION_CODE_WITH_PAYID_TOKEN_TYPE_O_REGISTERING' | 'BLIK_PAYID_TOKEN_TYPE_O' | 'PBL': Describes how the payment was processed.
        - `payTypeDetails` union: Additional details related to the payment type used for authorization.
          - object: Card authorization details.
            - `responseCode` string: Response code assigned by PayU.
            - `responseCodeDescription` string
            - `firstTransactionId` string: Card scheme identifier of first payment for future MIT (Merchant-Initiated Transaction) subsequent transactions. Depends on card scheme, value should be interpreted as: - Mastercard - as Trace ID - Visa - as Visa's Transaction Identifier
            - `schemeTransactionId` string: Card scheme's unique transaction identifier. Available for every processed authorization by card scheme, including declined ones (if reach card scheme and/or issuer). Depends on card scheme value should be interpreted as: - Mastercard - as Transaction Link Identifier (TLID) - Visa - as Visa's Transaction Identifier
            - `schemeResponseCode` string: Response code from the card scheme.
            - `retrievalReferenceNumber` string: Transaction identifier assigned by the acquirer, in case PayU is not processing directly with the card scheme (e.g., TSP processing).
            - `acquirerCode` string: Acquirer identifier code.
            - `card` Card: Details of card used for authorization.
              - …
            - `authentication` Authentication: Authentication details.
              - …
          - object: Blik authorization details.
            - `resultCode` string: Descriptive result code.
            - `txRef` string: Transaction reference assigned by Blik.
            - `extTxRef` string: External transaction reference in Blik system assigned by PayU.
            - `buid` string: Blik user identifier.
          - object: PayPal capture details.
            - `orderId` string: Order identifier assigned by PayPal.
            - `invoiceId` string: Invoice identifier within PayPal system, assigned by PayU (equals to PayU payment id).
      - `capture` Capture: Capture details.
        - `amount` string: Captured amount.
        - `currencyCode` string: Currency code compliant with ISO 4217.
        - `date` string: Capture timestamp.
        - `payTypeDetails` union
          - object: Card authorization details.
            - `retrievalReferenceNumber` string: Transaction identifier assigned by the acquirer, in case PayU is not processing directly with the card scheme (e.g., TSP processing).
            - `acquirerCode` string: Acquirer identifier code.
          - object: PayPal capture details.
            - `orderId` string: Order identifier assigned by PayPal.
            - `invoiceId` string: Invoice identifier within PayPal system, assigned by PayU (equals to PayU payment id).
            - `feeAmount` string: Fee amount applied by PayPal.
            - `sellerProtectionStatus` string: Seller protection status.
            - `sellerProtectionDisputeCategories` string[]: List of dispute categories covered by seller protection.
      - `fees` Fee[]
        - `amount` string: Fee amount in minor units.
        - `currencyCode` string: Currency code compliant with ISO 4217.
        - `type` string: Descriptive type of the fee, possible values include, but are not limited to: TRANSACTION, REFUND, CHARGEBACK
      - `mcpData` object: Multi-Currency Pricing details of the order.
        - `amount` string: Amount charged to the customer.
        - `currencyCode` string: Currency code the order amount was converted to, compliant with ISO 4217.
        - `rate` string: Applied currency conversion rate.
      - `status` 'NEW' | 'PENDING' | 'WAITING_FOR_CONFIRMATION' | 'COMPLETED' | 'CANCELED': Order status.
    - `properties` object[]: Array of objects related to transaction identification.
      - `name` string: Static value. The payment identifier, displayed on transaction statements as "Trans ID" and available as a search option in the Management Panel.
      - `value` string: Transaction ID in PayU system.

## Other responses

- `400`
- `401`
- `404`

---

[API](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api.md) - [All operations](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/revisions/185e74d5e007?raw)