PApayu-com
Order

Create an Order

Create a new order request.

post/api/v2_1/orders

Request

Headers

Content-Typestring required

Content type

Authorizationstring required

Auth token

Request body

continueUrlstring RFC 3986

Address for redirecting the customer after payment is commenced.

notifyUrlstring RFC 3986

The address for sending notifications

customerIpstring required

Payer's IP address. Value is accepted in following formats:<ul> <li> IPv4 - address represented in the dotted decimal format of 4 sets of decimal numbers separated by dots. The decimal number in each and every set is in the range 0 - 255. Example: 1.12.123.255.</li> <li> IPv6 - address represented as eight groups of four hexadecimal digits, each group representing 16 bits (two octets). The groups are separated by colons (:). Example: 2011:0db8:85a3:0101:0101:8a2e:0370:7334.</li></ul>

merchantPosIdstring required

Point of sale ID.

descriptionstring required

Description of the order.

additionalDescriptionstring

Additional description of the order.

visibleDescriptionstring

Order/Payment description visible for Buyer on the PayU payment page.

statementDescriptionstring

Payment recipient name followed by payment description (order ID, ticket number etc) visible on card statement. The name should be easy to recognize by the cardholder. If field is not provided, static name configured by PayU will be used.

extOrderIdstring

ID of an order used in merchant system. Order identifier assigned by the merchant. It enables merchants to find a specific order in their system. This value must be unique within a single POS.

currencyCodestring required

Currency code compliant with ISO 4217 (e.g EUR).

totalAmountstring required

Total price of the order in pennies (e.g. 1000 is 10.00 EUR). Applies also to currencies without subunits (e.g. 1000 is 10 HUF).

validityTimestring

Duration for the validity of an order (in seconds), during which time payment must be made. Default value 86400.

cardOnFile'FIRST' | 'STANDARD_CARDHOLDER' | 'STANDARD_MERCHANT'

Information about party initializing order or a transaction with Buyer consent to save card token. "cardOnFile" parameter cannot be used with "recurring" parameter.

recurring'FIRST' | 'STANDARD'

Marks the order as recurring payment: <ul> <li><b>FIRST</b> - payment initialized by the card owner who agreed to save card for future use in recurring plan. You can expect full authentication (3D Secure and/or CVV). If you want to use multi-use token (TOKC_) later, you have to be confident, that first recurring payment was successful.</li> <li><b>STANDARD</b> - subsequent recurring payment (user is not present). This transaction has multi use token (TOKC_). You cannot use it if FIRST recurring payment failed.</li> </ul> <b><code>recurring</code> parameter cannot be used with <code>cardOnFile</code> parameter</b> .

deviceFingerprintstring

Hashed identifier of the user or its device.

Example request

{
  "continueUrl": "www.example.com/path",
  "notifyUrl": "https://your.eshop.com/notify",
  "customerIp": "127.0.0.1",
  "merchantPosId": "140332",
  "currencyCode": "EUR",
  "totalAmount": "1000",
  "validityTime": "100000",
  "cardOnFile": "FIRST",
  "recurring": "FIRST",
  "donation": {
    "amount": 500
  },
  "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"
    }
  },
  "shoppingCarts": [
    {
      "extCustomerId": "ext-customer-1",
      "amount": 24950,
      "shippingMethods": [
        {
          "country": "PL",
          "price": 250,
          "name": "Postal package"
        }
      ],
      "products": [
        {
          "name": "My product",
          "virtual": true
        }
      ]
    }
  ],
  "products": [
    {
      "name": "My product",
      "virtual": true
    }
  ],
  "payMethods": {
    "payMethod": {
      "value": "c",
      "clickToPay": {
        "visa": {
          "srcCorrelationId": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "authorizationCode": "777123",
      "card": {
        "number": "5100052384536818",
        "expirationMonth": "02",
        "expirationYear": "29",
        "cvv": "123",
        "firstTransactionId": "MCC0111LL1121",
        "schemeTransactionId": "LzVYm4HlSDaYsHMFmAp4Jg"
      },
      "blikData": {
        "countryCode": "PL",
        "recurring": {
          "initializationDate": "2026-10-01T00:00:00+02:00",
          "expirationDate": "2026-10-01T00:00:00+02:00"
        }
      },
      "threeDsData": {
        "status3Ds": "Y",
        "status3DsDescription": "Authentication successful",
        "dsTransactionId": "3b31b19d-1c06-4ea4-a85a-00af10c66588",
        "eciCode": 5,
        "cavv": "AAABBBEAUAAAABgICABQAAAAAAA=",
        "tavv": "AgAAABBEAUAAAABg8CABQAAQEAAA="
      },
      "sourcePaymentFlow": "VISA_MOBILE",
      "cardInstallments": {
        "provider": "BRD_INSTALLMENTS",
        "number": 6
      }
    }
  },
  "mcpData": {
    "mcpCurrency": "EUR",
    "mcpPartnerId": "6283a549-8b1a-430d-8a62-eea64327440e"
  },
  "threeDsAuthentication": {
    "exemption": {
      "value": "LOW_RISK",
      "rejectionHandling": "PERFORM_AUTHENTICATION",
      "riskScore": "120 - low risk score calculated in Merchants antifraud tool"
    },
    "browser": {
      "requestIP": "127.0.0.1",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36",
      "language": "pl_PL"
    },
    "sdk": {
      "sdkReferenceNumber": "DS_LOA_SDK_ADBV_739485_94783",
      "sdkAppID": "9063b12c-fcde-43c7-b28e-8d0af5520e8a",
      "sdkEncData": "9063b12c-fcde-43c7-b28e-8d0af5520e8a",
      "sdkTransID": "b60c9879-ac77-4918-a317-7b01c4317053/8Q==.",
      "sdkEphemPubKey": {
        "y": "MRy7wofaw77myc7hZef23hmmEOE",
        "x": "MRy7wofaw77myc7hZef23hmmEOE",
        "kty": "EC",
        "crv": "P-256"
      }
    },
    "merchantRiskIndicator": {
      "orderType": "LOAN",
      "shipIndicator": "TICKETS",
      "preOrderedDate": "2019-03-27T10:57:59.000+01:00",
      "deliveryTimeFrame": "OVERNIGHT",
      "merchantFunds": {
        "currencyCode": "PLN"
      }
    },
    "recurring": {
      "frequency": "7",
      "expiry": "2025-03-27T00:00:00.000Z"
    },
    "cardholder": {
      "name": "John Doe",
      "accountInformation": {
        "createDate": "2019-03-27T10:57:59.000+01:00",
        "deliveryAddressFirstUsedDate": "2019-03-27T10:57:59.000+01:00",
        "deliveryAdressUsageIndicator": "THIS_TRANSACTION",
        "pastOrdersYear": 46,
        "pastOrdersDay": 125,
        "purchasesLastSixMonths": 12,
        "changeDate": "2019-03-27T10:57:59.000+01:00",
        "changeIndicator": "THIS_TRANSACTION",
        "passwordChanged": "2019-03-27T10:57:59.000+01:00",
        "passwordChangeIndicator": "NO_CHANGE",
        "nameToRecipientMatch": true,
        "authMethod": "GUEST",
        "authDateTime": "2019-03-27T10:57:59.000+01:00",
        "cardAddedDate": "2019-03-27T10:57:59.000+01:00",
        "cardAddedIndicator": "THIS_TRANSACTION"
      },
      "billingAddress": {
        "street": "Test Street",
        "postalCode": "01-000",
        "city": "Test City",
        "countryCode": "PL"
      }
    }
  },
  "riskData": {
    "browser": {
      "requestIP": "127.0.0.1",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36",
      "language": "pl_PL"
    }
  },
  "credit": {
    "shoppingCarts": [
      {
        "shippingMethod": {
          "address": {
            "pointId": "Parcel locker POZ29A"
          }
        }
      }
    ],
    "applicant": {
      "email": "test@test.com",
      "firstName": "Joe",
      "lastName": "Doe",
      "language": "pl",
      "address": {
        "street": "Test Street",
        "postalCode": "01-000",
        "city": "Test City",
        "countryCode": "PL"
      },
      "additionalInfo": {
        "hasSuccessfullyFinishedOrderInShop": "YES"
      }
    }
  },
  "deviceFingerprint": "3e9fae0b3e6003a4093358167bc1079e"
}

Response

SUCCESS

OR
OR

Example response

{
  "status": {
    "statusCode": "SUCCESS"
  },
  "orderId": "WZHF5FFDRJ140731GUEST000P01"
}

Changes

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