--- updatedAt: 2026-06-28T08:56:46.000Z agentTools: projectIndex: https://docs.payu.in/llms.txt --- # Collect Payment API - PayU Hosted Checkout The Collect Payment API (**\_payment** API) is used to collect payments for all the Web Checkout integration. This section provides the API Reference for PayU Hosted Checkout or Pre-Built Checkout. {` `} Experience the end-to-end PayU Hosted Checkout flow and instantly generate the complete code for seamless, zero-coding integration into your website.
{` `}
## Postman Collection Accelerate your integration workflow with our Postman collection for PayU Hosted Checkout. Click the Download Postman Collection button below to download and get started.
{` `}
## Environment | | | | :------------------------- | :--------------------------------------------------------------------- | | **Test Environment** | <[https://test.payu.in/\_payment>](https://test.payu.in/_payment>) | | **Production Environment** | <[https://secure.payu.in/\_payment>](https://secure.payu.in/_payment>) | ```curl curl -X POST "https://test.payu.in/_payment" \ -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d \ "key=JP***g&txnid=PQI6MqpYrjEefU&amount=10.00 \ &firstname=PayU User&email=test@gmail.com&phone=9876543210 \ &productinfo=iPhone&surl= \ https://apiplayground-response.herokuapp.com/ \ &furl=https://apiplayground-response.herokuapp.com/ \ &hash=05a397501918ec5c36ae52daa3b3e49b43e986b86940e109d060076e467c3ea7536617df7420e0e6863dced8c5b45f9fff15c13bdf0335512c05f0210b31b072" ``` ```python import requests url = "https://test.payu.in/_payment" payload = "key=JP***g&txnid=Dnh8wYimuCRIdv&amount=10.00&firstname=PayU User&email=test@gmail.com&phone=9876543210&productinfo=iPhone&pg=&bankcode=&surl=https://apiplayground-response.herokuapp.com/&furl=https://apiplayground-response.herokuapp.com/&hash=cb4b8bda5677dbe80f53735b1d0ec5d48164c3654627369268cf6bf266db994db39108ce2e0868c953e66c172f6b2d78836b253d3463d0cc40d9b6a93118ed56" headers = { "Accept": "application/json", "Content-Type": "application/x-www-form-urlencoded" } response = requests.request("POST", url, data=payload, headers=headers) print(response.text) ``` ```php $url = "https://test.payu.in/_payment"; $req = curl_init($url); curl_setopt($req, CURLOPT_URL, $url); curl_setopt($req, CURLOPT_POST, true); curl_setopt($req, CURLOPT_RETURNTRANSFER, true); $headers = array( "Content-Type: application/x-www-form-urlencoded" ); curl_setopt($req, CURLOPT_HTTPHEADER, $headers); $data = "key=JP***g&txnid=Dnh8wYimuCRIdv&amount=10.00&firstname=PayU User&email=test@gmail.com&phone=9876543210&productinfo=iPhone&pg=&bankcode=&surl=https://apiplayground-response.herokuapp.com/&furl=https://apiplayground-response.herokuapp.com/&ccnum=&ccexpmon=&ccexpyr=&ccvv=&ccname=&txn_s2s_flow=&hash=cb4b8bda5677dbe80f53735b1d0ec5d48164c3654627369268cf6bf266db994db39108ce2e0868c953e66c172f6b2d78836b253d3463d0cc40d9b6a93118ed56"; curl_setopt($req, CURLOPT_POSTFIELDS, $data); $resp = curl_exec($req); curl_close($req); var_dump($resp); ``` ```java Request request = Request.Post("https://test.payu.in/_payment"); String body = "key=JP***g&txnid=Dnh8wYimuCRIdv&amount=10.00&firstname=PayU User&email=test@gmail.com&phone=9876543210&productinfo=iPhone&pg=&bankcode=&surl=https://apiplayground-response.herokuapp.com/&furl=https://apiplayground-response.herokuapp.com/&ccnum=&ccexpmon=&ccexpyr=&ccvv=&ccname=&txn_s2s_flow=&hash=cb4b8bda5677dbe80f53735b1d0ec5d48164c3654627369268cf6bf266db994db39108ce2e0868c953e66c172f6b2d78836b253d3463d0cc40d9b6a93118ed56"; request.bodyString(body, ContentType.APPLICATION_FORM_URLENCODED); request.setHeader("Content-Type", "application/x-www-form-urlencoded"); HttpResponse httpResponse = request.execute().returnResponse(); System.out.println(httpResponse.getStatusLine()); if (httpResponse.getEntity() != null) { String html = EntityUtils.toString(httpResponse.getEntity()); System.out.println(html); } ``` #### Response ```text mihpayid=403993715531077182&mode=CC&status=success&unmappedstatus=captured&key=JPM7Fg&txnid=ypl938459435dfdfdf&amount=1000.00&cardCategory=domestic&discount=0.00&net_amount_debit=1000&addedon=2024-02-27+15%3A11%3A37&productinfo=iPhone&firstname=Ashish+User&lastname=&address1=&address2=&city=&state=&country=&zipcode=&email=ashish%40gmail.com&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. ``` #### Parsed response ```json { "mihpayid": "403993715531077182", "mode": "CC", "status": "success", "unmappedstatus": "captured", "key": "JPM7Fg", "txnid": "ypl938459435dfdfdf", "amount": "1000.00", "cardCategory": "domestic", "discount": "0.00", "net_amount_debit": "1000", "addedon": "2024-02-27 15:00:42", "productinfo": "iPhone", "firstname": "Ashish", "lastname": "", "address1": "", "address2": "", "city": "", "state": "", "country": "", "zipcode": "", "email": "ashish@gmail.com", "phone": "9876543210", "udf1": "", "udf2": "", "udf3": "", "udf4": "", "udf5": "", "udf6": "", "udf7": "", "udf8": "", "udf9": "", "udf10": "", "hash": "84bbbf0fa3ba2a39942f6c3deab234c4d00bc5b6aceee5cda3c8200d6e1714e19c224d47e24d0c4a9a0cce40eddbae1dc46455c69e5e7d5dd62f6636bfab337c", "field1": "896193988312194700", "field2": "857712", "field3": "1000.00", "field4": "", "field5": "00", "field6": "02", "field7": "AUTHPOSITIVE", "field8": "AUTHORIZED", "field9": "Transaction is Successful", "payment_source": "payu", "PG_TYPE": "CC-PG", "bank_ref_num": "896193988312194700", "bankcode": "CC", "error": "E000", "error_Message": "No Error", "cardnum": "XXXXXXXXXXXX2346", "cardhash": "This field is no longer supported in postback params.", "splitInfo": "{\"splitStatus\":\"splitNotReceived\",\"splitSegments\":[]}" } ``` | **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](https://docs.payu.in/reference/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](https://docs.payu.in/reference/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. | | cardCategory | This parameter contains the card category to indicate whether it is domestic or international. | | discount | This parameter contains the discount amount by the merchant. | | net\_amount\_debit | This parameter contains the net amount debited. | | addedon | The transaction date and time of the transaction. | | 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](https://docs.payu.in/docs/generate-hash-merchant-hosted). | | 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. | | udf6 | 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. | | udf7 | 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. | | udf8 | 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. | | udf9 | 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. | | field1 | | | field2 | | | field3 | | | field4 | | | field5 | | | field6 | | | field7 | | | field8 | | | field9 | | | success\_at | This parameter contains the date and timestamp when the transaction was successful. | | cardnum | The parameter contains the card number masked and only last 4 digits are returned. | | issuing\_bank | The parameters contains the card issuing bank. | ## Request parameters
Parameter Reference
key For more information on how to generate the Key and Salt, refer to any of the following: * **Production**: [Access Production Key and Salt](https://docs.payu.in/docs/generate-merchant-key-and-salt-on-payu-dashboard) * **Test**: [Access Test Merchant Key and Salt](https://docs.payu.in/docs/generate-test-merchant-key-and-salt)
hash Hash logic for **\_payment** API is:\ sha512(key|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3|udf4|udf5||||||SALT) For more information about the hash generation process, refer to [Generate Hash](https://docs.payu.in/docs/generate-hash-merchant-hosted). * *Note*\*: Hash logic for \_payment API version 19: The following hash logic must be used for \_payment API with**api\_version=19**:\ `key\|txnid\|amount\|productinfo\|firstname\|email\|udf1\|udf2\|udf3\|udf4\|udf5\|udf6\|udf7\|udf8\|udf9\|udf10\|user_token\|offer_key\|offer_auto_apply\|cart_details\|extra_charges\|phone`
**Note**: The following request parameters are mandatory for Cross-Border Payments in addition to user-defined parameters specified above: firstname, lastname, address1, city, state, country and zipcode. ### **Note**: Collecting the information for the following parameters from customers is helpful when it comes to issues related to fraud detection and chargebacks. Hence, it is must to provide the correct information: - email - phone - address1 ### **Reference**: For the character limit of each parameter and detailed description, refer to [Additional Info for Payment APIs](https://docs.payu.in/reference/addl_info-payment-apis). > ❗️ 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. Also, for error codes during various transaction stages in Net Banking, Cards and Wallets, refer to [Transaction Stages - Transaction Stages - Error References on Field7 & Field8](https://docs.payu.in/reference/transaction-stages-error-references-field7-field8).
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Merchant Hosted", "contact": {}, "version": "1.0" }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { "url": "https://test.payu.in", "variables": {} } ], "paths": { "/_payment": { "post": { "tags": [ "Test", "TPV" ], "summary": "Collect Payment API - PayU Hosted Checkout", "description": "", "operationId": "MerchantHostedCheckout-Wallets", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "const": "application/x-www-form-urlencoded", "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": {}, "schema": { "required": [ "key", "txnid", "amount", "productinfo", "firstname", "surl", "furl", "email", "pg", "bankcode", "hash" ], "type": "object", "properties": { "key": { "type": "string", "description": "Merchant key provided by PayU during onboarding.", "default": "JPM7Fg" }, "txnid": { "type": "string", "description": "The transaction ID is a reference number for a specific order that is generated by the merchant." }, "amount": { "type": "integer", "description": "The payment amount for the transaction.", "contentEncoding": "int32" }, "productinfo": { "type": "string", "description": "A brief description of the product.", "examples": [ "iPhone" ] }, "firstname": { "type": "string", "description": "The first name of the customer." }, "surl": { "type": "string", "description": "The success URL, which is the page PayU will redirect to if the transaction is successful." }, "furl": { "type": "string", "description": "The Failure URL, which is the page PayU will redirect to if the transaction is failed." }, "email": { "type": "string", "description": "The email address of the customer." }, "hash": { "type": "string", "description": "It is used to avoid the possibility of transaction tampering. Hash formula: sha512(key|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3|udf4|udf5||||||" }, "phone": { "type": "number", "description": "The phone number of the customer.", "contentEncoding": "double" }, "lastname": { "type": "string", "description": "The last name of the customer." }, "buyer_type_business": { "type": "string", "description": "This parameter is used to identify whether it is a B2B transaction. If 1 is posted, it is a B2B transaction.", "examples": [ "https://apiplayground-response.herokuapp.com/" ] }, "curl": { "type": "string", "description": "The Cancel URL, which is the page PayU will redirect to if the transaction is cancelled by customer.", "examples": [ "https://apiplayground-response.herokuapp.com/" ] }, "udf1": { "type": "string", "description": "User-defined fields (udf) are used to store any information corresponding to a particular transaction. You can use up to five udfs in the post designated as udf1, udf2, udf3, udf4, udf5." }, "udf2": { "type": "string", "description": "User-defined fields (udf) are used to store any information corresponding to a particular transaction. You can use up to five udfs in the post designated as udf1, udf2, udf3, udf4, udf5." }, "udf3": { "type": "string", "description": "User-defined fields (udf) are used to store any information corresponding to a particular transaction. You can use up to five udfs in the post designated as udf1, udf2, udf3, udf4, udf5." }, "udf4": { "type": "string", "description": "User-defined fields (udf) are used to store any information corresponding to a particular transaction. You can use up to five udfs in the post designated as udf1, udf2, udf3, udf4, udf5." }, "udf5": { "type": "string", "description": "User-defined fields (udf) are used to store any information corresponding to a particular transaction. You can use up to five udfs in the post designated as udf1, udf2, udf3, udf4, udf5." } }, "contentMediaType": "application/x-www-form-urlencoded" } } }, "required": false }, "responses": { "200": { "description": "", "headers": {}, "content": { "text/plain": { "schema": { "type": "object", "contentMediaType": "text/plain" } } } } }, "deprecated": false }, "parameters": [] } }, "tags": [ { "name": "TPV", "description": "" }, { "name": "Test", "description": "" } ] } ```