Use the Payouts API to automate money transfers to any bank a/c, UPI ID, card, or other modes. Generate the keys in test or production modes. You can check the parameters required, success, & error responses.
You can perform the following tasks using the Payouts API:
- Add and manage your beneficiaries efficiently
- Transfer money to your beneficiaries' accounts using different transfer methods
- Track the transfer status
- Check the ledger and available balance instantly
Beneficiary APIs
| API Name | Description |
|---|---|
| Add Beneficiary | Add a beneficiary to your Payouts account. |
| Retrieve Beneficiary Details | Retrieve a beneficiary's details. |
| Find Beneficiary ID | Find the ID of a specific beneficiary. |
| Remove Beneficiary | Remove a beneficiary from your Payouts account. |
| Retrieve Beneficiary Transfers | Retrieve transfer data of a specific beneficiary. |
Account APIs
| API Name | Description |
|---|---|
| View Balance | View the ledger and available balance of your account. |
| View Balance V1.2 | Version 1.2 allows you to specify the payment instrument Id. |
| Self Withdrawal | Request a self-withdrawal from your Payouts account. |
| Internal Transfer | Request an internal transfer between your Payouts accounts. |
Transfers APIs
| API Version 1.2 | API Version 1 | Description | Transactions Per Minute (TPM) | Response Time |
|---|---|---|---|---|
| Standard Transfer Sync V1.2 | Standard Transfer Sync | Initiate a sync transfer request | N/A | 9.77 s |
| Standard Transfer Async V1.2 | Standard Transfer Async | Initiate an async transfer request | 1000 | 25.0 ms |
| Direct Transfer V1.2 | Direct Transfer | Initiate an amount transfer request directly to the beneficiary not in the database. | 1000 | 9.04 s |
| Get Transfer Status V1.2 | Get Transfer Status | Get the status of the transfer request. | - | 244 ms |
| Batch Transfer V1.2 | Batch Transfer | Initiate a transfer request to multiple beneficiaries. | 1000 | 182 ms |
| Get Batch Transfer Status V1.2 | Get Batch Transfer Status | Get the status of the batch transfer request. | - | 6.19 ms |
Version 2 APIs
Beneficiary V2
| 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 get 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 V2
| API | Description |
|---|---|
| Standard Transfer V2 | Use this API to initiate an amount transfer at Cashfree Payments. It is an async request by default. |
| Get Transfer Status V2 | Use this API to get the status of the initiated transfer. |
| Batch Transfer V2 | Use this API to initiate a batch transfer request at Cashfree Payments. You can transfer money to multiple beneficiaries. |
| Get Batch Transfer Status V2 | Use this API to get the status of the initiated batch transfer. |
Payouts - Postman Collection
This collection can save you time because of easy access to different requests.