PayU India API Reference

Welcome to the PayU India API Reference documentation. This comprehensive guide provides developers with the information they need to seamlessly integrate PayU's payment processing capabilities into their applications and websites. Whether you're building an e-commerce platform, a mobile app, or any online service that requires secure and reliable payment processing, our APIs have you covered.

🚧

Limitations with API Reference

You cannot do test or mock API calls for certain APIs on this API Reference. PayU currently does not support the following APIs related to certain products or features with Test environment:

  • General APIs
    • Certain Refund flows
  • UPI flows with Server-to-Server
  • Refund Transaction
  • Recurring Payments or Subscriptions
    • Flows involving UPI payment mode
  • Save Cards
    • Model 2 - Zero Code Change flows
    • Collect Payments
  • Split Settlements (only a few APIs supported)
  • TPV
  • Pre-authorize payment (with PayU Hosted Checkout integration)
  • Omnichannel

For the test card numbers, test UPI handle, test wallet, etc. to be used in API Reference, refer to Test Cards, UPI ID and Wallets.

How to use API Reference

You can try using the Test Environment or Sandbox with most of the PayU India APIs in API Reference. Enter the values for the parameters/field in the form data and then click Try It. The response is displayed based on the values entered in the form data.

PayU recommends you to follow these so that you will integrate easily:

  • Understand the product integration steps on the Integration Guide and later refer to API Reference.
  • The API Reference pages for various APIs allows you to make mock API calls with most of the PayU APIs (using a static test key for General or Integration APIs). Also, it provides support in 16 language bindings, so you can get the source code in apart from cURL.
  • It is recommended to follow the Integration Checklist for checkout or SDK integrations to ensure that your integration is complete before making your integration live.

📘

Notes:

  • A static Test key is used with Test environment across the Collect Payment, General, Split Settlements and Pre-authorize APIs under API Reference. Hence, when you peruse the code on the API Reference, you need to replace the Test key with your Production key and Product environment URL.
  • All the parameters marked required must be filled to enable the Generate Hash button.
  • The example listed (like a cookie) in each parameter field is for reference purposed only, so it is suggested to type the values similar to the listed example.
  • Use only the the test card numbers, test UPI handle, test wallet, etc. in API Reference, refer to Test Cards, UPI ID and Wallets.

List of PayU India APIs

The API Reference is categorized into following:

CollectionLinks
Collect Payment APIs- Collect Payment API - PayU Hosted Checkout
- Collect Payment API - Merchant Hosted Checkout
- Collect Payment API - Server-to-Server
General APIs- Check Transaction APIs
- Transaction Detail APIs
- Refund APIs
- Settlement Details
- BIN APIs
- EMI APIs
- Health Check APIs
Payment Link APIs- Create Payment Link API
- Share Payment Link API
- Get Single Payment Link API
- Get All Payment Links API
- Create Invoice API
- Expire Invoice API
Recurring Payment APIs- Payment Consent Transaction using PayU Hosted Checkout
- Payment Consent Transaction with Merchant Hosted Checkout
- Pre-Debit Notification API
- Recurring Payment API
- Manage Recurring Payment for Cards
Zion Subscription API- Associating Plan in Defined Subscription API
- Define Subscription API
- Update Subscription API
- Get List of Subscriptions API
- Cancel Subscription API
- Get Subscription Details API
- Get Invoice API
- Create Invoice API
Offers APIs- Fetch Offers API
- Validate Offer API
Save Cards APIs- Model 2-Zero Code Change
  * Get User Cards API
  * Process Transaction with a Saved Card
- Model 3 – Simple REST APIs
  * Save a Card API
  * Edit a Saved Card API
  * Get User Cards API
  * Delete a Saved Card API
  * Get Payment Details (Cryptogram)
- Collect Payments - Save Card
Partner Integration APIs- Get Token API
- Refresh Token API
- User Token APIs
- Onboarding APIs
- Bank Details API
- Manage KYC Documents
Split Settlements APIs- Split During Transaction using _payment
- Split After Transaction API
- Settlement APIs
- Refund APIs
Hexa Wallet APIs- Fetch Balance API
- Create Wallet/Card API
- Retrieve Customer Record API
- Update Profile API
- Block Card API
- Unblock Card API
- Check Status API
- Statement Inquiry API
- Unload API
- Load API
- Fund Transfer API
- Create Beneficiary API
- Fetch Beneficiary API
- Update Beneficiary API
- Delete Beneficiary API
- Change Card Status API
- Link Card API
- Verify Cardholder API
- Card Inquiry API
- Reset PIN API
Cross-Border Payments APIs- Invoice Upload API
- UDF Update API
Pre-Authorize Payment APIs- Pre-Authorize Payment
- Capture a Pre-Authorized Payment
Payouts APIS- Generate Token using Merchant's Credentials API
- Generate Token using Private Client ID
- Get Account Details API
- Initiate Transfer API
- Check Transfer Status API
- Cancel Transfer API
- Disable Queued Payouts API
- Penny Verify API
- Get IFSC Details API
- Validate VPA Handle API
- Fetch Masked VPAs API
- Create Smart Send Link API
- Smart Send Status API
- Extend Expiry Date API
- Cancel Smartsend API
- Bulk File Upload API
- Bulk Process File API
- View Beneficiary Details API
- Create or Register Beneficiary API
- Set Name Match Score Threshold API
- Get Name Match Score Threshold API
- Activate Payout Partner Merchant API
- Update Payouts Partner Merchant API
- Update Active Merchant Status API
- Whitelist Partner Merchant IP API
- Get Whitelisted Partner Merchant IPs

Get support

Should you encounter any issues or have questions during your integration process, our dedicated support team is here to assist you. Visit https://help.payu.in and raise a ticket.