PApayu-com
Order

Retrieve an Order

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

get/api/v2_1/orders/{orderId}

Request

Path parameters

Order ID generated by the PayU system

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

Comma-separated array of additional information to retrieve with the order details.

Headers

Content-Typestring required

Content type

Authorizationstring required

Auth token

Response

OR

Example response

{
  "orders": [
    {
      "shippingMethod": {
        "country": "PL",
        "name": "parcel"
      },
      "orderId": "VVLR1HXK2S160929GUEST000P01",
      "extOrderId": "343242",
      "orderCreateDate": "2023-01-03T14:58:17.443+01:00",
      "notifyUrl": "http://localhost/OrderNotify/",
      "customerIp": "127.0.0.1",
      "merchantPosId": "145227",
      "description": "New Order",
      "additionalDescription": "New Order",
      "currencyCode": "PLN",
      "totalAmount": "3200",
      "capturedAmount": "3200",
      "buyer": {
        "email": "email@email.com",
        "phone": "+48 225108001",
        "firstName": "John",
        "lastName": "Doe",
        "language": "pl",
        "birthDate": "2006-12-03T00:00:00.000+01:00",
        "delivery": {
          "state": "30"
        }
      },
      "products": [
        {
          "name": "My product",
          "virtual": true
        }
      ],
      "shoppingCarts": [
        {
          "extCustomerId": "ext-customer-1",
          "amount": 24950,
          "shippingMethods": [
            {
              "country": "PL",
              "price": 250,
              "name": "Postal package"
            }
          ],
          "products": [
            {
              "name": "My product",
              "virtual": true
            }
          ]
        }
      ],
      "merchantFunds": [
        {
          "amount": "500"
        }
      ],
      "status": "COMPLETED"
    }
  ],
  "properties": [
    {
      "name": "PAYMENT_ID",
      "value": "1234567890"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.