Integration Guide
Start typing to search…

Integrate Checkout Plus

PayU Checkout Plus is the most convenient way to collect payment on your website. Add the inline JS script to your website’s header section, then call the bolt.launch() function and pass the transaction data objects when your customers click the payment button. PayU will take care of the payment and returns to your page when it is done.

📘

Notes:

The Checkout Plus integration is not recommended for the app browsers. For example, WebView, Chrome Custom tab, etc. Although there is Redirection Web Checkout which can be integrated. For more information, refer to following:

Steps to integrate

  1. Add the inline script in the HTML Header
  2. Pass the transaction request objects
  3. Fetch the response using the responseHandler function

For more information on handling any errors during a transaction, refer to the CatchException section of this document.

Step 1: Add meta-tags & scripts in the HTML header

Add the following meta-tag & JS script in the HTML header section of your website:

 <meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://jssdk.payu.in/bolt/bolt.min.js"></script>

📘

Test Script

Replace the script mentioned in the earlier code snippet with https://jssdk-uat.payu.in/bolt/bolt.min.js to test the integration.

Step 2: Pass transaction request objects

The bolt.launch() function takes two arguments.

  • In the first argument, the data objects contain the transaction request data see the request parameters section for the details of the parameters to be passed as data objects). The format of the data object is as shown below:
var data = { key: 'O85456',
                    hash: hash,
                    txnid: tnxID,
                    amount: '1',
                    firstname: 'surbhi',
                    email: "[email protected]",
                    phone: "1234567890",
                    productinfo: 'BOLT',
                    surl: 'http://thirdparty.com/testresponse.php',
                    furl: 'http://thirdparty.com/testresponse.php',
                    lastname: 'soni',
                    enforce_paymethod: "creditcard|debitcard|HDFB|AXIB",
                    display_lang: "Hindi",
                    drop_category: "creditcard|debitcard",
                    pg: "CC",
                    custom_note: "You will be charged an extra amount of Rs 100 on this transaction"
                };
var handlers = {responseHandler: function (BOLT) {
                        if(BOLT.response.txnStatus == "SUCCESS"){
                          console.log('Your payment has been successful');
                        }
                        if (BOLT.response.txnStatus == "FAILED") {
                           console.log('Payment failed. Please try again.');
                        }
                        if(BOLT.response.txnStatus == "CANCEL"){
                           console.log('Payment failed. Please try again.');
                        }
                    },
                    catchException: function (BOLT) {
                        console.log('Payment failed. Please try again.');
                    }};

Sample request

$(document).on('click','#submit',function () {
var data = { key: 'O85456',
                    hash: hash,
                    txnid: tnxID,
                    amount: '1',
                    firstname: 'surbhi',
                    email: "[email protected]",
                    phone: "1234567890",
                    productinfo: 'BOLT',
                    surl: 'http://thirdparty.com/testresponse.php',
                    furl: 'http://thirdparty.com/testresponse.php',
                    lastname: 'soni',
                    enforce_paymethod: "creditcard|debitcard|HDFB|AXIB",
                    display_lang: "Hindi",
                    drop_category: "creditcard|debitcard",
                    pg: "CC",
                    custom_note: "You will be charged an extra amount of Rs 100 on this transaction"
                };
var handlers = {responseHandler: function (BOLT) {
                        if(BOLT.response.txnStatus == "SUCCESS"){
                          console.log('Your payment has been successful');
                        }
                        if (BOLT.response.txnStatus == "FAILED") {
                           console.log('Payment failed. Please try again.');
                        }
                        if(BOLT.response.txnStatus == "CANCEL"){
                           console.log('Payment failed. Please try again.');
                        }
                    },
                    catchException: function (BOLT) {
                        console.log('Payment failed. Please try again.');
                    }};                
                bolt.launch( data , handlers );
        });

📘

Note:

Here, when your customer clicks on the payment button (#submit), this code triggers the bolt.launch() function that passes the transaction parameters along with the responseHandler() and catchException()functions as arguments.

Request parameters

Parameter

Description

Example

key
mandatory

String The merchant key is provided by PayU and acts as a unique identifier for a specific merchant account in the PayU’s database.

Your Test Key

hash
mandatory

String This field must contain the has and it is used to avoid the possibility of transaction tampering. For more information on hash generation process, refer to Encryption of Request.

eabec285da28fd
0e3054d41a4d24fe
9f7599c9d0b6664
6f7a9984303fd612
4044b6206daf831
e9a8bda28a6200d
318293a13d6c193
109b60bd4b4f8b09
c90972

txnid
mandatory

String The transaction ID is the order reference number generated by the merchant to track a particular order. It can be used only once and PayU’s system does not accept a duplicate Transaction ID.

s7hhDQVWvbhBdN

amount
mandatory

integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of “299.35” it should be "29935"

29935

firstname
mandatory

String This parameter must contain the first name of the customer.

Ashish

lastname
optional

String This parameter must contain the last name of the customer.

Verma

email
mandatory

String This parameter must contain the email ID of the customer.

[email protected]

phone
mandatory

String This parameter must contain the phone number of the customer.

9876543210

productinfo
mandatory

String This parameter must contain a brief description of the product.`

iPhone

surl
mandatory

String Success URL(surl) – This must contain the URL on which PayU will redirect the final response if the transaction is successful.

https://apiplayground-response.herokuapp.com/

furl
mandatory

String Failure URL (furl) – This must contain the URL on which PayU will redirect the final response in case of failure.

https://apiplayground-response.herokuapp.com/

udf1

optional

String User-defined fields (udf) are used to store any information corresponding to a particular transaction. Merchants can use up to 5 udfs in the post designated as udf1, udf2, udf3, udf4, udf5. For example, you can store customer's preferred payment.

Payment Preference

udf2

optional

String User-defined fields(udf) are used to store any information corresponding to a particular transaction. Merchants can use up to 5 udfs in the post designated as udf1, udf2, udf3, udf4, udf5. For example, you can store customer's preferred payment.

Shipping Method

udf3

optional

String User-defined fields (udf) are used to store any information corresponding to a particular transaction. Merchants can use up to 5 udfs in the post designated as udf1, udf2, udf3, udf4, udf5. For example, you can store customer's preferred payment.

Shipping Address1

udf4

optional

String User-defined fields (udf) are used to store any information corresponding to a particular transaction. Merchants can use up to 5 udfs in the post designated as udf1, udf2, udf3, udf4, udf5. For example, you can store customer's preferred payment.

Shipping City

udf5

optional

String User-defined fields (udf) are used to store any information corresponding to a particular transaction. Merchants can use up to 5 udfs in the post designated as udf1, udf2, udf3, udf4, udf5. For example, you can store customer's preferred payment.

Shipping Zip Code

pg

optional

String Pass the payment category that you want to display on your payment page. The default value for this parameter is CC (Credit Card).

bankcode

optional

StringEach payment option is identified with a unique bank code at PayU. The merchant must post this parameter with the corresponding payment option’s bank code value in it.

codurl
optional

String This field must contains the address of the customer if the Cash on Delivery option is chosen for the payment

drop_category
optional

String This parameter is used if you want to hide one or multiple payment options. For example, if you consider the payment options such as credit card, debit card, and net banking, you can hide the credit card mode of payment.

creditcard|debitcard

enforce _paymethod
optional

String`This parameter allows you to customize the payment options for each transaction. You can enforce specific payment modes, cards scheme, specific banks under Net Banking using this method.

creditcard|debitcard|HDFB|AXIB

custom_note
- optional**

String` This parameter allows yo pass any custom note for the transaction.

You will be charged an extra amount of Rs 100 on this transaction

note_category
optional

String This parameter allows you to define the category of the note. Example - CC, NB will show the custom_note for Credit Card & Net banking only.

Step 3: Fetch the response using responseHandler

The responseHandler() function fetches the response from PayU once the transaction is completed. In case of a successful, failed, or canceled transaction, the response parameters will be returned to the responseHandler() function based on the corresponding logic defined by the merchant.

CatchException

The catchException() function captures the transaction message in case of any exceptions.

Sample response

Sample Response URL

mihpayid: 403993715523615328
mode: CC
status: success
unmappedstatus: captured
key: JPM7Fg
txnid: 50QJq6lBJBmx14
amount: 10.00
cardCategory: domestic
discount: 0.00
net_amount_debit: 10
addedon: 2021-07-28 15:11:37
productinfo: iPhone
firstname: PayU User
lastname: 
address1: 
address2: 
city: 
state: 
country: 
zipcode: 
email: [email protected]
phone: 9876543210
udf1: 
udf2: 
udf3: 
udf4: 
udf5: 
udf6: 
udf7: 
udf8: 
udf9: 
udf10: 
hash: afeab9dcf4e43d47f8fbf5a6838d393c70694a58e30ada08e6cb86ac943236c05717c5f5e4872d671fe81d0d9b2d9facd44e9a061ba621aff6f20c4343ea5dfa
field1: 
field2: 
field3: 
field4: 
field5: 
field6: 
field7: 
field8: 
field9: Transaction Completed Successfully
payment_source: payu
PG_TYPE: CC-PG
bank_ref_num: 7f0d5ada-59bb-41d7-9e41-20a6af2406c9
bankcode: CC
error: E000
error_Message: No Error
name_on_card: test
cardnum: 411111XXXXXX1111
cardhash: This field is no longer supported in postback params.

Response parameters

Parameter

Description

mihpayid

It is a unique reference number created for each transaction at PayU’s end which is used to identify a transaction in case of a refund.

mode

This parameter describes the payment category by which the transaction was completed/attempted by the customer. The values are:
 
• Credit Card – CC

• Debit Card – DC

• Net Banking – NB
• Cash Card – CASH
• EMI – EMI

• Cardless EMI – CLEMI
• Buy Now Pay Later - BNPL

bankcode

This parameter contains the code indicating the payment option used for the transaction. For example, Visa Debit Card – VISA, Master Debit Card – MAST.

status

This parameter returns the status of the transaction and must be used to map the order status. Possible values are success, failure, or pending. The significance of the values for these values are:
 
• Success: If the value of status parameter is ’success’, the transaction is successful.

• Failed: If the value of status parameter is ‘failure’ or ‘pending’, must only be treated as a failed transaction.

unmappedstatus

This parameter holds the status of a transaction in PayU's internal database, which can include intermediate states. Possible values include: dropped, bounced, captured, auth, failed, usercancelled, or pending. For information on status description, refer to  Payment State Explanations.

key

This parameter contains the merchant key.

error

For the failed transactions, this parameter provides the reason for failure.

error_message

This parameter contains the error message. For the list of error message, refer to Error Codes.

bank_ref_num

For each successful transaction – this parameter contains the bank reference number generated by the bank.

txnid

This parameter contains the transaction ID value posted by the merchant during the transaction request.

amount

This parameter contains the original amount which was sent in the transaction request by the merchant.

productinfo

This parameter contains the same value of product information which was sent in the transaction request from the merchant’s end to PayU.

firstname

This parameter contains the same value of first name which was sent in the transaction request from the merchant’s end to PayU.

lastname

This parameter contains the same value of last name which was sent in the transaction request from the merchant’s end to PayU.

email

This parameter contains the same value of email which was sent in the transaction request from the merchant’s end to PayU.

phone

This parameter contains the same value of phone which was sent in the transaction request from the merchant’s end to PayU.

hash

This parameter is crucial and is similar to the hash parameter used in the transaction request. For more information, refer to  Generate Hash.

PG_TYPE

This parameter gives information on the payment gateway used for the transaction.

udf1

This parameter contains the same value of udf1, udf2, udf3, udf4, or udf5, which was sent in the transaction request from the merchant’s end to PayU.

udf2

This parameter contains the same value of udf1, udf2, udf3, udf4, or udf5, which was sent in the transaction request from the merchant’s end to PayU.

udf3

This parameter contains the same value of udf1, udf2, udf3, udf4, or udf5 which was sent in the transaction request from the merchant’s end to PayU.

udf4

This parameter contains the same value of udf1, udf2, udf3, udf4, or udf5, which was sent in the transaction request from the merchant’s end to PayU.

udf5

This parameter contains the same value of udf1, udf2, udf3, udf4, or udf5, which was sent in the transaction request from the merchant’s end to PayU.

Updated 13 days ago