UPI S2S Integration API - Partner Integration

Content-Type

application/json

Authorization

Bearer
Where, <token> must be substituted with 039e0d1d70f467f946e2d73bd43868df856cfaa352ea54591a76bfc4a08d3487

merchant_id mandatory

String This parameter is the unique Merchant id provided by PayU for your merchant account. The Merchant id acts as the unique identifier (primary key) to identify a particular Merchant Account in our database.

8488225

txnid
mandatory

varchar This parameter is known as Transaction ID (or OrderID). It is the order reference number generated at your (Merchant’s) end. It is an identifier which you(merchant) would use to track a particular order. If a transaction using a particular transaction ID has already been successful at PayU, the usage of same Transaction ID again would fail. Hence, it is essential that you post us a unique transaction ID for every new transaction (Please make sure that the transaction ID being sent to us hasn’t been successful earlier. In case of this duplication, the customer would get an error of ‘duplicate Order ID’).

fd3e847h2

amount mandatory

float This parameter should contain the payment amount of the particular transaction. Note: Type-cast the amount to float type

10

productinfo mandatory

varchar This parameter should contain a brief product description. It should be a string describing the product (The description type is entirely your choice). 

T-shirt

firstname mandatory

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

Ankit

email
mandatory

varchar This parameter must contain the email of the customer)

[email protected]

phone mandatory

integer Merchant needs to take the customer’s GPay registered phone number and pass in this field. This field will be used for further mapping the customer VPA and initiate a collect request.

txn_s2s_flow mandatory

integer This parameter is to indicate the transaction is S2S flow. Pass this parameter value as 4.

4

hash
mandatory

varchar varchar Hash is a crucial parameter – used specifically to avoid any tampering during the transaction. There are two different methods to calculate hash. Please follow method 1 only. Method 2 is just there for the documentation and is not to be used This is the simplest way of calculating the hash value. Here, please make sure that the api_version parameter is NOT POSTED from your end. For hash calculation, you need to generate a string using certain parameters and apply the sha512 algorithm to this string.
Note: You have to use pipe (|) character in between these parameters as mentioned below. The parameter order is mentioned below: sha512(merchant_id|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3|udf4|u df5||||||CLIENT_SECRET) All these parameters (and their descriptions) have already been mentioned earlier in this table. Here, SALT (to be provided by PayU), key, txnid, amount productinfo, firstname, email are mandatory parameters and hence can’t b empty in hash calculation above. But, udf1-udf5 are optional and hence you nee to calculate the hash based upon the fact that whether you are posting a particular udf or not. For example, if you are NOT posting udf1. Then, in the has calculation, udf1 field will be left empty. The following examples will clarify various scenarios of hash calculation:

• Case 1: If all the udf parameters (udf1-udf5) are posted by the merchant. Then, hash=sha512(merchant_id|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3| udf4|udf5||||||CLIENT_SECRET)
• Case 2: If only some of the udf parameters are posted and others are not. For example, if udf2 and udf4 are posted and udf1, udf3, udf5 are not. Then, hash=sha512(merchant_id|txnid|amount|productinfo|firstname|email||udf2||udf4|||||||CLIENT_SECRET) Case 3: If NONE of the udf parameters (udf1-udf5) are posted. Then, hash=sha512(merchant_id|txnid|amount|productinfo|firstname|email|||||||||||CLIENT_SECRET) Example: If merchant_id=6631711, txnid=12345, amount=10, productinfo=Shopping, firstname=Test, email=[email protected], udf2=abc, udf4=15, CLIENT_SECRET=3sf0jURk91319391949941414195821851313 and udf1, udf3, udf5 are not posted. Then, the hash would be calculated as Case 2 above: sha512(6631711|12345|10|Shopping|Test|[email protected]||abc||15|||||||3sf0jURk91319391949941414195821851313) (This value comes out to be 7a83339ccf2dde9d31569b00eea70a60174b3af3ceaa773d17a84b90c9eedad5f744ba02f95a572d8fe8592346ebb537bede49ad1ec786469b4bd77531d19b87) IMPORTANT: For details related to hash at the time of postback from PayU to the merchant, please refer to the later section. This is also absolutely mandatory to avoid any tampering.

s2s_client_ip mandatory

varchar This parameter must have the source IP of the user

s2s_device_info mandatory

varchar This parameter must have the user agent of the device

reseller_id mandatory

varchar This parameter is the unique Partner Identifier provided by PayU for your partner account. The Partner Identifier acts as the unique identifier to identify a particular Partner Account in our database.

 83fe-eb64-021844d8-9397-26535b1bf0c2

udf5
mandatory

string This parameter has been made for you to keep any information corresponding to the transaction. Pass whatsapp in this field

whatsapp

address1 optional

string The first line of the billing address.

address2 optional

string The second line of the billing address.

city
optional

string The city where your customer resides as part of the billing address.

state
optional

string The state where your customer resides as part of the billing address.

country
optional

string The country where your customer resides.

zipcode
optional

string Billing address zip code is mandatory for the cardless EMI option.

partner_udf_3
optional

This parameter has been made for partner to pass any information corresponding to the transaction.

partner_udf_4
optional

This parameter has been made for partner to pass any information corresponding to the transaction.

shipping_firstname optional

string The first name of shipping person.

shipping_lastname optional

string The last name of shipping person.

shipping_address1 optional

string The first line of the shipping address.

shipping_address2 optional

string The second line of the shipping address.

shipping_city optional

string The city where your customer resides as part of the shipping address.

shipping_state optional

string The state where your customer resides as part of the shipping address.

shipping_country optional

string The country where your customer resides as part of the shipping address.

shipping_zipcode optional

string Shipping address zip code.

shipping_phone optional

string The phone no your customer resides as part of the shipping address.

drop_category optional

string This parameter can be used if you want to hide one or multiple payment options. For example, if you want to collect the payment using debit card and Net Banking, you can hide the credit card mode of payment.

enforce_paymethod optional

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

user_token optional

stringThis parameter is used to uniquely identify a user for a merchant.

offer_key optional

string List of keys to filter the offer.

offer_auto_apply

stringThis parameter contains a flag to specify whether the offer can be automatically applied.

additional_charges optional

stringThe additional amount that needs to be charged. The additional amount will be added to the amount of the product by PayU

401

with invalid token

 {
“message”: “Invalid Auth token”
}

403

with invalid hash

 {
“message”: “Invalid Hash”
}

400

without reseller_id

 {
“errors”: [
“reseller_id is mandatory.”
]
}

400

without amount

 {
“errors”: [

“amount is mandatory param”
]
}

400

without merchant_id

 {
“errors”: [
“merchant_id is mandatory param”
]
}

400

without hash

 {
“errors”: [
“hash is mandatory param”
]
}

400

without product_info

 {
“errors”: [
“product_info is mandatory param”
]
}

txnid

In this parameter, you can include the txnid (Your transaction ID/order ID).

100123

merchant_id

It is the merchant id that PayU provided you.

8238480

hash

This parameter must contain the hash value to be calculated at your end. The string used for calculating the hash is mentioned below:
sha512(merchant_id|command|txnid|client_secret) sha512 is the encryption method used here.

• client_secret– These credentials are only accessible to a partner(WhatsApp).
• command has constant value as verify_payment.

resseler_id

varchar This parameter is the unique Partner Identifier provided by PayU for your partner account. The Partner Identifier acts as the unique identifier to identify a particular Partner Account in our database.

83fe-eb64-021844d8-9397-26535b1bf0c3

mihpayid

This field contains a unique reference number created for each transaction at PayU’s end. You must note this transaction ID as this will be used as a reference for all the future actions on this transaction like Inquiry or Refund.

request_id

This field would contain the request ID value posted by the merchant during the transaction request.

bankrefnum

For each successful transaction – this field would contain the bank reference number generated by the bank.

amt

This field contains the net amount debited from the customer’s account for this transaction.

transaction_amount

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

productinfo

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

firstname

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

bankcode

This field contains the code indicating the payment option used for the transaction. For example, in the Debit Card mode, there are different options like Visa Debit Card, Mastercard, Maestro etc. For each option, a unique bank code exists. It would be returned in this bank code parameter. For example, Visa Debit Card – VISA, Master Debit Card – MAST.

udf1

This field contains the same value of udf values that were sent in the transaction request from the merchant’s end to PayU. It ranges from udf1 to udf5.

udf3

This field contains the same value of udf values that were sent in the transaction request from the merchant’s end to PayU. It ranges from udf1 to udf5.

udf4

This field contains the same value of udf values that were sent in the transaction request from the merchant’s end to PayU. It ranges from udf1 to udf5.

udf5

This field contains the same value of udf values that were sent in the transaction request from the merchant’s end to PayU. It ranges from udf1 to udf5.

field2, field3

The auth code from the bank is displayed in this field.

field9

This field contains the failure reason if the transaction has failed.

error_code

This field contains the error code for the transaction.

net_amount_debit

This field contains the net amount debited from the customer’s account for this transaction. It is calculated as:
transaction_fee= actual_discount + additional_charges

added_on

This field contains the transaction timestamp returned in this parameter.

payment_source

This field contains the payment source. PayU is returned for the transactions made with PayU.

card_type

This field contains the card type used for the transaction if the cards are used.

error_Message

This field contains the error message for the transaction (if any).

net_amount_debit

This field contains the net amount debited from the customer’s account for this transaction.

disc

This field contains the discount amount for the customer.
Note: For Cashback type offers, the discount amount will always be sent as zero(**0**) by PayU.

Mode

This field contains the mode of payment.

PG_TYPE

This field contains the information on the payment gateway used for the transaction. For example, if CC PG was used, it would contain the value CC-PG. Similarly, it would have a unique value for all different types of payment gateways.

card_no

This field contains the card number for card transactions.

name_on_card

This field contains the name on card for card transactions.

udf2

This field contains the same value of udf values that were sent in the transaction request from the merchant’s end to PayU. It ranges from udf1 to udf5.

field5

This field contains the UPI VPA ID for UPI transactions.

status

This field contains the status of the transaction. For detailed information on the statuses, refer to Payment State Explanations

unmappedstatus

This field contains the status of a transaction as per the internal database of PayU. PayU’s system has several intermediate statuses which are used for tracking various activities internal to the system. Hence, this status contains intermediate statuses of a transaction also – and hence is known as unmappedstatus. For detailed information on the statuses, refer to Payment State Explanations.

Merchant_UTR

This field contains the merchant Unique Transaction Reference (UTR) number.

Settled_at

This field contains the time stamp of card settlement if the transaction is using credit cards.

401

with invalid token

 {

“message”: “Invalid Auth token”

}

403

with invalid hash

 {

“message”: “Invalid Hash”

}

400

without reseller_id

 {

“errors”: [

“reseller_id is mandatory.”

]

}

400

without merchant_id

 {

“errors”: [

“merchant_id is mandatory param”

]

}

400

without hash

 {

“errors”: [

“hash is mandatory param”

]

}