Overview

Learn the benefits of upgrading to Cashfree Payouts v2 APIs, including the unified transfers endpoint, richer beneficiary management, and v1 to v2 migration.

Payouts version 2 (v2) represents the next generation of our payout integration capabilities. These APIs are designed to provide a more streamlined, standardised, and developer-friendly experience for businesses looking to automate their payout processes.

Benefits

This update delivers several key improvements over the previous version to enhance your integration experience.

• Enhanced versioning:

  Experience seamless incorporation of future breaking and non-breaking changes on existing endpoints. This strategy provides a better balance between innovation and stability.

• Standardised API request and response:

  Parameters follow a consistent standard for clarity, simplifying the integration process and making it easier to manage your workflows.

• Standardised error codes:

  Uniform error codes provide quick diagnosis of issues and clear resolution steps, reducing the need for support tickets.

• Platform-wide standardisation:

  Consistent standards across all Cashfree Payments services facilitate easier onboarding and familiarity with our various products.

• Consolidated transfer APIs:

  Streamlined operations simplify selecting the correct API for your use case, reducing integration complexity and potential issues.

End points

Use the following base URLs to access the Payouts version 2 APIs in different environments.

Environment	Base URL
Production	https://api.cashfree.com/payout
Test	https://sandbox.cashfree.com/payout

Available APIs

The following tables list the available API endpoints for beneficiary management and transfers.

Beneficiary management

Use these APIs to manage beneficiaries in your Cashfree Payments account.

API	Description
Create Beneficiary	Use this API to add a beneficiary to your Cashfree Payments account by providing the bank account number, IFSC, and other required details.
Get Beneficiary	Use this API to retrieve the details of a particular beneficiary from your account.
Remove Beneficiary	Use this API to remove an existing beneficiary from the list of added beneficiaries.

Transfers

Use these APIs to initiate and track money transfers to your beneficiaries.

API	Description
Standard Transfer	Use this API to initiate an amount transfer at Cashfree Payments. This is an asynchronous request by default.
Get Transfer Status	Use this API to retrieve the status of an initiated transfer.
Batch Transfer	Use this API to initiate a batch transfer request at Cashfree Payments. You can transfer money to multiple beneficiaries.
Get Batch Transfer Status	Use this API to retrieve the status of an initiated batch transfer.

Verify and pay

Use these APIs for the Verify and Pay UPI flow: validate the beneficiary, then initiate the payout with the returned transfer token.

API	Description
Validate Payout	Validates a UPI VPA or phone number and returns a single-use transfer token for the Process Validated Payout call.
Process Validated Payout	Initiates a UPI payout using the transfer token from Validate Payout.

When you receive a 5XX response, do not initiate another transaction. Check the status of the standard transfer using Get Transfer Status, or check the status of the batch transfer using Get Batch Transfer Status before proceeding.