The Collect Payment API (v2 Payment API) is used along with beneficiaryDetails object included in additionalInfo JSON 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
Parameter | Description |
---|---|
date | The current date and time. For example, format of the date is Wed, 28 Jun 2023 11:25:19 GMT. |
authorization | The 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
Field | Description |
---|---|
username | Represents the username or identifier for the client or merchant, for example smsplus. |
algorithm | Use SHA512 algorithm for hashing and send this as header value. |
headers | Specifies which headers have been used in generating the hash, for example date. |
signature | The 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}"`;
}
Request body
Parameter | Description | Example |
---|---|---|
accountIdmandatory |
Merchant key provided by PayU. Character limit: 50 | "smsplus" |
txnIdmandatory |
Unique transaction ID for the transaction. Character limit: 50 | "REF_123456789" |
paymentMethodmandatory |
Net Banking payment method details. See paymentMethod object | {"name": "UPI", "bankCode": "UPI"} |
ordermandatory |
Order details containing product information and pricing. See order object | {"productInfo": "Net Banking Payment", "paymentChargeSpecification": {"price": 10000.00}} |
billingDetailsmandatory |
Customer billing information. See billingDetails object | {"firstName": "John", "email": "[email protected]", "phone": "9876543210"} |
callBackActionsoptional |
Callback URLs for different payment outcomes. See callBackActions object | {"successAction": "https://merchant.com/success", "failureAction": "https://merchant.com/failure"} |
additionalInfomandatory |
Additional transaction parameters including flow type. Refer to additionalInfo object | {"txnFlow": "seamless", "enforcePaymethod": "NB"} |
beneficiaryDetailmandatory |
Beneficiary account details for Net Banking transfer. See beneficiaryDetail object | {"beneficiaryName": "Merchant Account", "beneficiaryAccountNumber": "1234567890", "beneficiaryAccountType": "SAVINGS"} |
paymentMethod Object
Parameter | Data Type | Required | Description |
---|---|---|---|
name | String | Yes | Payment method type. Must be set to "UPI" . Character limit: 10 |
bankCode | String | Yes | Bank code for the selected bank. Character limit: 10. Refer to Bank codes for TPV |
order Object
Parameter | Description | Example |
---|---|---|
productInfomandatory |
Product details. | Product details |
orderedItemoptional |
Details about the items ordered. | Array of Objects |
userDefinedFieldsoptional |
Custom fields for additional information. Fields: udf1, udf2, udf3, udf4, udf5, udf6, udf7, udf8, udf9, udf10. For more information, refer to | Object |
paymentChargeSpecificationmandatory |
Includes amount and charges. For more information, refer to paymentChargeSpecification object fields description | Object |
paymentChargeSpecification object fields description
Parameter | Description | Example |
---|---|---|
pricemandatory |
The transaction amount. | 1000 |
netAmountDebitoptional |
Net amount to be debited. | 1000 |
taxSpecificationoptional |
Tax details of the product/order. | Object |
convenienceFeeoptional |
Fees format (e.g., CC:12). | CC:12 |
offersoptional |
Offers applied or available for the payment. | Object |
userDefinedFields object fields description
Field | Description |
---|---|
udf1 | User defined field. |
udf2 | User defined field. |
udf3 | User defined field. |
udf4 | User defined field. |
udf5 | User defined field. |
udf6 | User defined field. |
udf7 | User defined field. |
udf8 | User defined field. |
udf9 | User defined field. |
udf10 | User defined field. |
billingDetails Object
Parameter | Description | Example |
---|---|---|
firstNamemandatory |
First name of the billing contact. | Ashish |
lastNameoptional |
Last name of the billing contact. | Kumar |
address1mandatory |
Primary billing address. | 123 Main Street |
address2optional |
Secondary billing address. | Apt 4B |
phoneoptional |
Phone number of the billing contact. | 9123456789 |
emailmandatory |
Email address of the billing contact. | [email protected] |
cityoptional |
City of the billing address. | Bharatpur |
stateoptional |
State of the billing address. | Rajasthan |
countryoptional |
Country of the billing address. | India |
zipCodeoptional |
Postal/Zip code of the billing address. | 321028 |
callBackActions Object
Parameter | Description | Example |
---|---|---|
successActionmandatory |
URL to be called on payment success. | https://example.com/success |
failureActionmandatory |
URL to be called on payment failure. | https://example.com/failure |
cancelActionmandatory |
URL to be called if user cancels the payment. | https://example.com/cancel |
codActionoptional |
URL for Cash on Delivery (COD) action. | https://example.com/cod |
additionalInfo Object
Parameter | Description | Example |
---|---|---|
enforcePaymethod optional |
Force a transaction with a specified method. For TPV, it is NetBanking. | 60 |
createOrderoptional |
A flag to store the order details (true/false). | true |
txnS2sFlowoptional |
For defining seamless/non-seamless flows in handling payments. | nonseamless |
vpa |
|
test@payu |
beneficiaryDetail object
Parameter | Description | Example |
---|---|---|
beneficiaryNamemandatory |
String Name of the beneficiary account holder. Character limit: 100 |
"Merchant Account" |
beneficiaryAccountNumbermandatory |
String Bank account number of the beneficiary. Character limit: 50 |
"1234567890" |
beneficiaryAccountTypemandatory |
String Type of beneficiary account (e.g., "SAVINGS" , "CURRENT" ). Character limit: 20 |
"SAVINGS" |
Sample request
curl --location 'https://apitest.payu.in/v2/payments' \
--header 'date: Thu, 27 Mar 2025 10:12:27 GMT' \
--header 'authorization: hmac username="smsplus", algorithm="sha512", headers="date", signature="ec84843a663143bb89391f6fa2d4b9404bab1543a3eee81263b4a507ebf5d289d8fad1fbcdd59da820951e3e0f9b0b0b3d1bad9b41338804e7c42a8a6197c6e9"' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": "smsplus",
"referenceId": "b5f2d8785768087678fn4",
"amount": 10,
"currency": "INR",
"paymentSource": "WEB",
"paymentMethod": {
"name": "UPI",
"bankCode": "UPI"
},
"order": {
"productInfo": "UPI Payment for Order",
"userDefinedFields": {
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": ""
},
"paymentChargeSpecification": {
"price": "10.00"
}
},
"additionalInfo": {
"txnFlow": "seamless",
"createOrder": true,
"txnS2sFlow": "2",
"vpa": "test@payu"
},
"callBackActions": {
"successAction": "https://yoursite.com/success",
"failureAction": "https://yoursite.com/failure",
"cancelAction": "https://yoursite.com/cancel"
},
"billingDetails": {
"firstName": "John",
"lastName": "Doe",
"phone": "9876543210",
"email": "[email protected]",
"city": "Mumbai",
"state": "Maharashtra",
"country": "India",
"zipCode": "400001"
}
}'
Response parameters
Parameter | Description |
---|---|
referenceId |
This parameter contains the reference 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": {
"checkoutUrl": "https://pp78secure.payu.in/_payment_options?mihpayid=<mihpayuid>&userToken="
},
"status": "PENDING"
}
Reference:To check the transaction status, refer to Verify Payment API.
Reference:To check the transaction status, refer to Verify Payment API.