API Reference
Start typing to search…

Preauthorize Transaction - Seamless

The Collect Payment API (v2 Payment API) with the preAuthorize=1 in the additionalInfo object.

📘

Note:

You must use the additionalInfo.txnFlow must be set to nonseamless for PayU Hosted Checkout.

📘

Reference:

To handle redirect URLs (surl and furl), refer to Handling the Redirect URLs.

Environment

Test Environment<https://apitest.payu.in/v2/payments
Production Environment<https://api.payu.in/v2/payments>

Request header

ParameterDescription
dateThe current date and time. For example, format of the date is Wed, 28 Jun 2023 11:25:19 GMT.
authorizationThe actual HMAC signature generated using the specified algorithm (sha512) and includes the hashed data. For more information, refer to authorization fields description.

authorization fields description

FieldDescription
usernameRepresents the username or identifier for the client or merchant, for example smsplus.
algorithmUse SHA512 algorithm for hashing and send this as header value.
headersSpecifies which headers have been used in generating the hash, for example date.
signatureThe HMAC signature generated using the specified algorithm. For more information, refer to hashing algorithm.

hashing algorithm

You must hash the request parameters using the following hash logic:

Hash logic: sha512(<Body data> + '|' + date + '|' + merchant_secret)

Where <Body data> contains the request body posted with the request.

Sample header code
var merchant_key = 'smsplus';
var merchant_secret = 'izF09TlpX4ZOwmf9MvXijwYsBPUmxYHD';
// date
var date = new Date();
date = date.toUTCString();

// authorization
var authorization = getAuthHeader(date);

function getAuthHeader(date) {
    var AUTH_TYPE = 'sha512';
    var data = isEmpty(request['data']) ? "" : request['data'];
    var hash_string = data + '|' + date + '|' + merchant_secret;
    var hash = CryptoJS.SHA512(hash_string).toString(CryptoJS.enc.Hex);
    return `hmac username="${merchant_key}", algorithm="${AUTH_TYPE}", headers="date", signature="${hash}"`;
}

Body

Parameter Description

accountId
mandatory

StringThe merchant key provided by PayU during onboarding.

referenceId
mandatory

StringReference ID for transaction tracking. This must be unique for each transaction.

amount
optional

StringAmount of the transaction.
Note: This value will not be considered as the transaction. Only the details in the order.paymentChargeSpecification.price field will be considered.

currency
mandatory

StringCurrency of the transaction. For example, INR.

paymentSource optional

StringContains the payment source. For example, WEB.

order
mandatory

JSON ObjectDetails about the transaction order including product information, ordered items, user defined fields, and payment charge specifications. For more information, refer to order object fields description

additionalInfo
mandatory

JSON ObjectAdditional information including enforced payment methods and various options for user preferences during the transaction. For more information, refer to additionalInfo object fields description.
Note: The txnFlow field in this JSON object must be set to nonseamless.

callBackActions
mandatory

JSON ObjectActions to perform on the payment server in different scenarios. For example, success, failure, cancellation, cash on delivery, etc. For more information, refer to callbackActions object fields description

billingDetails
mandatory

JSON ObjectBilling details of the customer including name, address, phone number, email, etc. For more information, refer to billingDetails object fields descriptions.

additionalInfo object fields description

Field Description

enforcePaymethod
optional

StringMethods of payment that are enforced in the payment process. For more information, refer to Enforce Pay Method or Remove Category.

txnFlow
mandatory

String Specify "seamless" for Seamless integration

preAuthorize
optional

String When set to "1", the transaction will be in pre-authorized state and funds will be captured later.

callbackActions object

Parameter Description Example
successAction
mandatory		 URL to be called on payment success. https://example.com/success
failureAction
mandatory		 URL to be called on payment failure. https://example.com/failure
cancelAction
mandatory		 URL to be called if user cancels the payment. https://example.com/cancel
codAction
optional		 URL for Cash on Delivery (COD) action. https://example.com/cod

❗️

Error Handling

If any error message is displayed with an error code, refer to the Error Codes section to understand the reason for these error codes.

order object

Parameter Description Example
productInfo
mandatory		 Product details. Product details
orderedItem
optional		 Details about the items ordered. Array of Objects
userDefinedFields
optional		 Custom fields for additional information. Fields: udf1, udf2, udf3, udf4, udf5, udf6, udf7, udf8, udf9, udf10. For more information, refer to Object
paymentChargeSpecification
mandatory		 Includes amount and charges. For more information, refer to paymentChargeSpecification object fields description Object
paymentChargeSpecification object fields description
Parameter Description Example
price
mandatory		 The transaction amount. 1000
netAmountDebit
optional		 Net amount to be debited. 1000
taxSpecification
optional		 Tax details of the product/order. Object
convenienceFee
optional		 Fees format (e.g., CC:12). CC:12
offers
optional		 Offers applied or available for the payment. Object
userDefinedFields object fields description
FieldDescription
udf1User defined field.
udf2User defined field.
udf3User defined field.
udf4User defined field.
udf5User defined field.
udf6User defined field.
udf7User defined field.
udf8User defined field.
udf9User defined field.
udf10User defined field.

billingDetails object

Parameter Description Example
firstName
mandatory		 First name of the billing contact. Ashish
lastName
optional		 Last name of the billing contact. Kumar
address1
mandatory		 Primary billing address. 123 Main Street
address2
optional		 Secondary billing address. Apt 4B
phone
optional		 Phone number of the billing contact. 9123456789
email
mandatory		 Email address of the billing contact. [email protected]
city
optional		 City of the billing address. Bharatpur
state
optional		 State of the billing address. Rajasthan
country
optional		 Country of the billing address. India
zipCode
optional		 Postal/Zip code of the billing address. 321028

Sample request

curl --location 'https://apitest.payu.in/v2/payments' \
--header 'date: Tue, 05 Nov 2024 06:12:57 GMT' \
--header 'authorization: hmac username="smsplus", algorithm="sha512", headers="date", signature="d583ff8069c7dfa8340464a24bdd01cbebf4432b4dfe4de862065cc9c9dc622c24c77cb1ac1142bf581ec07eca8d0ec78a66db93f6cd557d0da552f05c0825e3"' \
--header 'Content-Type: application/json' \
--header 'mid: 8390470' \
--header 'X-CREDENTIAL-USERNAME: UMXDPA' \
{
  "accountId": "smsplus",
  "referenceId": "b5f2d8785768087678fm9",
  "paymentStatus": "SUCCESS",
  "amount": 10,
  "currency": "INR",
  "paymentSource": "WEB",
  },
  "order": {
    "productInfo": "string",
    "orderedItem": [
      {
        "itemId": null,
        "description": "AAA",
        "quantity": null
      }
    ],
    "userDefinedFields": {
      "udf1": "",
      "udf2": "",
      "udf3": "",
      "udf4": "",
      "udf5": "",
      "udf6": "",
      "udf7": "",
      "udf8": "",
      "udf9": "",
      "udf10": ""
    },
    "paymentChargeSpecification": {
      "price": 10
  },
  "additionalInfo": {
    "txnFlow": "seamless",
    "createOrder" : "false",
    "preAuthorize": "1"
  },
  "callBackActions": {
    "successAction": "https://pp78admin.payu.in/test_response",
    "failureAction": "https://pp78admin.payu.in/test_response",
    "cancelAction": "https://testapi.payu.in/admin/testresponsev2?action=cancelAction"
  },
  "billingDetails": {
    "firstName": "sartaj",
    "lastName": "",
    "address1": "Test Payu Gurgaon",
    "address2": "",
    "city": "Bharatpur",
    "state": "Rajasthan",
    "country": "India",
    "zipCode": "321028",
    "phone": "9876543210",
    "email": "[email protected]"
  }
}

Response parameters

Parameter Description
txnId This parameter contains the transaction ID of the transaction.
paymentId This parameter contains the payment ID of the transaction.
message This parameter contains the status message of the transaction.

Sample response

{
  "result": {
    "paymentId": "1999110000001769",
    "redirectUrl": "https://secure.payu.in/ResponseHandler.php",
    "authAction": "https://apitest.payu.in/v2/payments/1999110000001769/auth"
  },
  "status": "PENDING"
}

📘

Reference:

To check the transaction status, refer to Verify Payment API.