APIs used for Integration
PayU offers Payouts as a product for businesses to make instant payments to their customers. The Payouts APIs are categorized based on the following capabilities:
Authentication for Payouts
| API name | Description |
|---|---|
| Generate Token using Merchant's Credentials API | Generates an authentication token using the merchant's username and password. |
| Generate Token using Private Client ID | Generates an authentication token using the merchant's private client ID and client secret. |
| Refresh Token API - Payouts | Refreshes the validity of an existing authentication token. |
| IP Check for Payouts | Adds an IP allowlist check as an additional security measure for Payouts requests. |
Initiation and Tracking
| API name | Description |
|---|---|
| Get Account Details API - Payouts | Retrieves complete details of the merchant's Payouts account. |
| Initiate Transfer API | Initiates or schedules a transfer to a beneficiary's bank account, VPA, or credit card. |
| Check Transfer Status API | Retrieves the status of transfers initiated by the merchant. |
| Cancel Transfer API | Cancels a transfer that is in the queued or scheduled state. |
| Disable Queued Payouts API | Marks queued transactions as failed when the merchant account has insufficient balance. |
Verification and Validation
| API name | Description |
|---|---|
| Get IFSC Details API | Retrieves bank details for a specified IFSC code. |
| Verify Account or Penny Test API | Verifies a beneficiary bank account through a penny test and returns the account holder's name. |
| Validate VPA - Payouts | Checks whether a customer's VPA exists before a UPI transfer is initiated. |
Smart Send APIs
| API name | Description |
|---|---|
| Create Smart Send Link API | Creates and sends a Smart Send link when the beneficiary's bank account details or VPA are unavailable. |
| Smart Send Details API | Retrieves the details of a Smart Send transaction using the payout merchant ID and merchant reference ID. |
| Extend Expiry Date API | Extends the expiry date of an unexpired Smart Send link with a pending transaction. |
| Cancel Smart Send API | Cancels a Smart Send payment link. |
| Smart Send Error Codes | Lists the error codes and descriptions returned by the Smart Send APIs. |
Bulk Smart Send
| API name | Description |
|---|---|
| Bulk File Upload API | Uploads a CSV, XLSX, or XLS file containing Smart Send transfer details. |
| Bulk Process File API | Processes an uploaded file containing Smart Send transfer details. |
| Bulk Upload Status API | Retrieves the processing status of an uploaded bulk transfer file. |
Beneficiary Management
| API name | Description |
|---|---|
| View Beneficiary Details API | Retrieves beneficiaries registered under the merchant account. |
| Create or Register Beneficiary API | Registers a beneficiary under the merchant account for use in payouts. |
You can also configure Payout Webhooks to receive notification on various events such as Transfer Success Webhook, Transfer Failed Webhook, Scheduled Downtime Webhook, etc. Refer to Payouts Webhooks to learn more about Payout Webhooks.
Before you Begin
- PayU strongly recommends you test your integration using the test credentials. For more information refer to Test Credentials.
- Before you use the above-listed APIs, you need to understand the Payouts integration and configure the PayU Dashboard. For more information, refer to the following documentation:
Updated about 1 hour ago
Did this page help you?