> ## Documentation Index
> Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Batch Transfer V2
> Use this API to initiate a batch transfer request at Cashfree Payments. You can transfer money to multiple beneficiaries. The batch transfer limit is 5,000 in the production environment and 1,000 by default in the test environment.
**5XX error**
When you get a 5XX response, don't initiate another transaction.
Check the status of the batch transfer using Get Batch Transfer Status V2 and then proceed further.
**Get Transfer Status**
Use the [Get Batch Transfer Status V2](/api-reference/payouts/v2/transfers-v2/get-batch-transfer-status-v2) API to get the status of the batch transfer request. The Get Transfer Status V2 API does not give you the status of the batch transfer requests.
| HTTP status code | Status | Status code | Status description | Next action | Try again via Cashfree - Yes or no |
| :--------------- | :----------------- | :----------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- |
| 200 | APPROVAL\_PENDING | VELOCITY\_CHECK\_FAILED | The transfer requires an approval as the count of transfers to a particular beneficiary etc, have breached the limit. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - |
| 200 | APPROVAL\_PENDING | TRANSFER\_LIMIT\_BREACH | The transfer requires approval as the transfer amount etc, has breached the limit. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - |
| 200 | APPROVAL\_PENDING | APPROVAL\_PENDING | The transfer requires approval. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - |
| 200 | APPROVAL\_PENDING | ANOMALY\_DETECTION | The transfer requires approval as it is a high risk transaction detected by the Payout Protect model. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** | You can approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. Post the transfer is approved, the request is sent to the partner bank for further processing. | - |
| 200 | APPROVAL\_PENDING | RISK\_CHECK\_MANUAL\_REVIEW\_REQ | The transfer requires approval as it has been flagged by the Payout Protect risk model for manual review. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | RISK\_CHECK\_ANOMALY\_DETECTED | The transfer requires approval as it has been flagged by the Payout Protect risk model for manual review due to anomaly detection. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | RISK\_CHECK\_BENEFICIARY\_HIGH\_RISK | The transfer requires approval as the beneficiary has been identified as high risk by the Payout Protect model. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | RISK\_CHECK\_VELOCITY\_THRESHOLD | The transfer requires approval as it breaches the velocity threshold set in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | RISK\_CHECK\_TIME\_WINDOW\_BREACH | The transfer requires approval as it falls outside the allowed time window defined in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | RISK\_CHECK\_AMOUNT\_THRESHOLD | The transfer requires approval as it exceeds the amount threshold set in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | HIGH\_RISK\_BENEFICIARY | The transfer requires approval as the beneficiary is identified as high risk. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | UNUSUAL\_ACTIVITY\_DETECTED | The transfer requires approval as unusual activity has been detected in the transfer pattern. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | BLACKOUT\_WINDOW\_RULE | The transfer requires approval as it falls within the blackout window defined in the Payout Protect rules. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | CUSTOM\_RULE\_TRIGGERED | The transfer requires approval as it has triggered a custom rule defined in the Payout Protect settings. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payout Protect > Risky Transfers > Flagged Transfers** tab. | - |
| 200 | APPROVAL\_PENDING | MANUAL\_APPROVAL\_REQUIRED | The transfer requires manual approval as per the configured workflow. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. | - |
| 200 | APPROVAL\_PENDING | COMPLIANCE\_REVIEW\_PENDING | The transfer requires approval as it is pending compliance review. You can approve or reject the transfer request from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login). | Approve/reject the transfer on the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Transfers > Approve** tab. | - |
| 200 | FAILED | WAIT\_TIME\_EXCEEDED | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | BENE\_BANK\_DECLINED | The transfer has failed because the beneficiary bank has declined the transfer. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | - | Yes |
| 200 | FAILED | IMPS\_MODE\_FAIL | The transfer has failed because the beneficiary account does not support IMPS transfers. This rejection is done by the partner bank for the specific beneficiary account. You can try NEFT or other channels to do the disbursals | You can try NEFT or other channels to do the disbursals. | Yes, via a different mode |
| 200 | FAILED | SOURCE\_BANK\_DECLINED | The transfer has failed because our partner bank has declined the transfer because of their internal checks, technical declines etc. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with other partner bank(s). | Yes |
| 200 | FAILED | CONNECTION\_TIMEOUT | The transfer has failed because there was a connection timeout between the bank and Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | Yes |
| 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | Yes |
| 200 | FAILED | NPCI\_UNAVAILABLE | The transfer has failed because NPCI was unavailable to complete the transfer request. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree. The success of the request is contingent on NPCI services being up. | - | Yes, after some time |
| 200 | FAILED | DEST\_LIMIT\_REACHED | The transfer has failed because the beneficiary account has breached the limit of receiving funds. This rejection is done by the beneficiary bank for the specific beneficiary account. You can reinitiate the transfer after a while via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). The success of the request is contingent on beneficiary's limit being available to receive incoming funds. | - | Yes, after some time |
| 200 | FAILED | RETURNED\_FROM\_BENEFICIARY | The transfer has failed because the beneficiary bank has returned the transfer and has not need able to credit funds to the end beneficiary. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | - | - |
| 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - |
| 200 | FAILED | INVALID\_BENE\_ACCOUNT\_OR\_IFSC | The transfer has failed because the beneficiary account or IFSC is invalid. After correcting the beneficiary account or IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - |
| 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - |
| 200 | FAILED | FAILED | The transfer has failed because there was an intermittent issue at the partner bank's end. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time |
| 200 | FAILED | PAYOUT\_INTERNAL\_ERROR | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - |
| 200 | FAILED | INSUFFICIENT\_BALANCE | The transfer has failed because of low balance in your Cashfree Wallet/ Bank Account. After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after recharging |
| 200 | FAILED | INVALID\_BENE\_VPA | The transfer has failed because the beneficiary VPA is invalid. After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the VPA handle |
| 200 | FAILED | INVALID\_IFSC\_FAIL | The transfer has failed because the IFSC is invalid. After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the IFSC |
| 200 | FAILED | BAD\_GATEWAY | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | INVALID\_AMOUNT\_FAIL | The transfer has failed because the amount entered is invalid. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the amount |
| 200 | FAILED | INVALID\_ACCOUNT\_FAIL | The transfer has failed because the Account Number of the beneficiary is invalid, as per our partner bank. After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account number |
| 200 | FAILED | INVALID\_REQUEST | The transfer has failed because the transfer request is invalid, as per our partner bank, because of exceeding the character limit of certain parameter, wrong input etc. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | - |
| 200 | FAILED | ACCOUNT\_BLOCKED | The transfer has failed because the account is blocked, as per our partner bank. After getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after unblocking the account number |
| 200 | FAILED | DEBIT\_FAILURE | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | BENEFICIARY\_BANK\_OFFLINE | The transfer has failed because the respective beneficiary bank is offline. After some time, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After some time, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | AUTHENTICATION\_FAILURE | The transfer has failed because there was an authentication failure at the partner bank's end. After checking with the partner bank, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | This is a scenario when the API access is not working at the partner bank's end. After checking with the partner bank, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | NRE\_ACCOUNT\_FAIL | The transfer has failed because the beneficiary account is an NRE Account and transfers to NRE Accounts are not supported, as per our partner bank. | Get a new account(non-NRE account) from the beneficiary; you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | No |
| 200 | FAILED | SOURCE\_LIMIT\_REACHED | The transfer has been failed by the partner bank as the source bank account has reached a limit of transferring funds. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | If you are on Cashfree Wallet, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). If you are on Connected Bank, you need to recharge your bank account and then reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time |
| 200 | FAILED | BANK\_GATEWAY\_ERROR | The transfer has failed because there was an intermittent issue at the partner bank's end. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | BAD\_REQUEST | The transfer has failed because the details of the transfer request is invalid, as per our partner bank. After correcting the details in the transfer request, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the details in the transfer request, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | FAILED | REINITIALIZE\_TRANSFER\_LATER | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | MANUALLY\_REJECTED | MANUALLY\_REJECTED | The transfer has failed because it has been manually rejected by the merchant or any team member user who has the permissions to do the same on [Merchant Dashboard](https://merchant.cashfree.com/auth/login). You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | If the merchant wants to reinitiate the transfer, they can reinitiate the transfer via Cashfree so that the transfer can be reattempted again with the partner bank(s). | Yes, if you want to reinitiate the transfer |
| 200 | PENDING | SENT\_TO\_BANK | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. This has been sent to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | BANK\_GATEWAY\_ERROR | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | NO\_SUCH\_REQUEST | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank is not able to find the request at their end as of now, and it has been sent to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | IN\_PROCESS | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | ERROR\_FETCHING\_STATUS | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The response received from the partner bank has a new code. This has been raised with the bank to understand the new code. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | TRANSACTION\_PROCESSED | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | REQUEST\_TIMEDOUT | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank is not able to find the request at their end as of now as the request between the partner bank has probably timed out, and it has been highlighted to the bank by our banking operations team. Please do check statuses or await webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | DUPLICATE | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The bank claims of receiving a duplicate request at their end as of now. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | PENDING | PENDING | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | | |
| 200 | PENDING | SCHEDULED\_FOR\_NEXT\_WORKINGDAY | The transfer is currently in a Pending state, as the bank has scheduled the transfer for the next working day. This typically happens for NEFT/RTGS transfers if they are initiated beyond the cut-off hours or during bank holidays. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - |
| 200 | PENDING | SUSPECT | The transfer is currently in a Pending state, as the bank has scheduled the transfer for the next working day. This typically happens for NEFT/RTGS transfers if they are initiated beyond the cut-off hours or during bank holidays. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - |
| 200 | PENDING | IMPLEMENTATION\_ERROR | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | - | - |
| 200 | PENDING | UNKNOWN\_ERROR\_CODE | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. The response received from the partner bank has a new code. This has been raised with the bank to understand the new code. Please do check statuses or await webhooks to know the terminal state of the transfer request. | - | - |
| 200 | QUEUED | QUEUED | The transfer is currently in a Pending state, as Cashfree is awaiting a final confirmation from the partner bank for a terminal status. You should rely only on Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | RECEIVED | RECEIVED | The transfer has been received by Cashfree successfully for further processing. You should use Check Status API response or Webhooks to know the terminal state of the transfer request. | Rely on Check Status API or webhooks | - |
| 200 | REJECTED | BENE\_NOT\_EXIST | The transfer has been rejected because the beneficiary, added in the transfer request, does not exist. After adding the right beneficiary, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After adding the right beneficiary, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after adding the right beneficiary |
| 200 | REJECTED | INSUFFICIENT\_BALANCE | The transfer has been rejected because of low balance in your Cashfree Wallet. After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After recharging the account, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after recharging |
| 200 | REJECTED | INSIDE\_BLACKOUT\_WINDOW | The transfer has been rejected because the transfer falls under the blackout window defined by you in Payout Protect. You can reinitiate the transfer via Cashfree, after the blackout window or after modifying the blackout window from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login), so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree, after the blackout window or after modifying the blackout window from the [Merchant Dashboard](https://merchant.cashfree.com/auth/login), so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REJECTED | INVALID\_MODE\_FOR\_PYID | The transfer has been rejected because the payment instrument does not support this mode of transfer. You should get this mode activated on the payment instrument ID by contacting Cashfree, and then initiate a new transfer request. | You should get this mode activated on the payment instrument ID by contacting Cashfree, and then initiate a new transfer request. | Yes, after activating the mode. |
| 200 | REJECTED | BENE\_BLACKLISTED | The transfer has been rejected because the beneficiary's bank account and/or VPA handles have been blacklisted by Risk team. You should get a different bank account and/or VPA to send the transfer, or you can connect with Cashfree Team to understand more about this. | You should get a different bank account and/or VPA to send the transfer, or you can connect with Cashfree Team to understand more about this. | Yes, after correcting the beneficiary details |
| 200 | REJECTED | TRANSFER\_NOT\_ATTEMPTED | The transfer has failed because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REJECTED | INVALID\_TRANSFER\_AMOUNT | The transfer has been rejected because the amount entered is invalid. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s) | Yes, after correcting the amount |
| 200 | REJECTED | TRANSFER\_LIMIT\_BREACH | The transfer has been rejected because the amount entered breaches the limits set for your payout account. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | Yes, after adhering to the transfer limits |
| 200 | REJECTED | INVALID\_PAYMENT\_INSTRUMENT | The transfer has been rejected because the payment instrument (fundsource\_id parameter in the API request) used for attempting the transfer is invalid. After correcting the payment instrument, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the payment instrument, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the payment instrument |
| 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REJECTED | VELOCITY\_CHECK\_FAILED | The transfer has been rejected because the amount entered breaches the limits set for your payout account. After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | After correcting the amount, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). You can connect with Cashfree if you are not sure about the transfer limits set for your payout account. | Yes, after adhering to the transfer limit |
| 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REJECTED | PAYOUT\_INTERNAL\_ERROR | The transfer has been rejected because there was an intermittent internal error at Cashfree. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REJECTED | DISABLED\_MODE | The transfer has been rejected because your payout account does not support this mode of transfer. You should get this mode activated on your payout account by contacting Cashfree, and then initiate a new transfer request. | You should get this mode activated on your payout account by contacting Cashfree, and then initiate a new transfer request. | Yes, after activating the mode |
| 200 | REJECTED | BANK\_ACCOUNT\_INVALID | The transfer has been rejected because there is a mismatch in the Bank Account Number of the beneficiary ID and the Bank Account Number in the transfer request. After correcting the Bank Account Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the Bank Account Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the bank account number |
| 200 | REJECTED | BANK\_IFSC\_INVALID | The transfer has been rejected because there is a mismatch in the IFSC of the beneficiary ID and the IFSC in the transfer request. After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the IFSC, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the IFSC |
| 200 | REJECTED | VPA\_INVALID | The transfer has been rejected because there is a mismatch in the VPA handle of the beneficiary ID and the VPA handle in the transfer request. After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the VPA handle, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the VPA handle |
| 200 | REJECTED | PHONE\_INVALID | The transfer has been rejected because there is a mismatch in the Phone Number of the beneficiary ID and the Phone Number in the transfer request. After correcting the Phone Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After correcting the Phone Number, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after correcting the phone number. |
| 200 | REJECTED | BANK\_ACCOUNT\_DETAILS\_MISSING | The transfer has been rejected because the Bank Account Details are missing in the transfer request. After adding the Bank Account Details, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | After adding the Bank Account Details, you can reinitiate the transfer via Cashfree so that the transfer can be attempted by Cashfree with the partner bank(s). | Yes, after adding the bank account details. |
| 200 | REVERSED | ACCOUNT\_BLOCKED | The transfer has been reversed by the beneficiary bank as the end-beneficiary's account is blocked for receiving incoming funds. After correcting the account number or getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number or getting the account unblocked, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after adding the new details or getting the account unblocked |
| 200 | REVERSED | FAILED | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | - | Yes |
| 200 | REVERSED | NRE\_ACCOUNT\_FAIL | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account as it is an NRE Account and transfers to NRE Accounts are not supported. | Get a new account(non-NRE account) from the beneficiary; you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | No |
| 200 | REVERSED | RETURNED\_FROM\_BENEFICIARY | The transfer has been reversed by the beneficiary bank as they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REVERSED | BENE\_BANK\_DECLINED | The transfer has been declined by the beneficiary bank and they were unable to credit the end beneficiary's bank account. You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | You can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes |
| 200 | REVERSED | IMPS\_MODE\_FAIL | The transfer has been reversed by the beneficiary bank because the beneficiary bank account does not support IMPS transfers. This rejection is done by the beneficiary bank for the specific beneficiary account. You can try NEFT or other channels to do the disbursals. | You can reinitiate the transfer via Cashfree by changing the mode so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after changing the mode |
| 200 | REVERSED | DEST\_LIMIT\_REACHED | The transfer has been reversed by the beneficiary bank as the end-beneficiary's account has reached a limit of receiving incoming funds. This rejection is done by the beneficiary bank for the specific beneficiary account. You can reinitiate the transfer after a while via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). The success of the request is contingent on beneficiary's limit being available to receive incoming funds. | The limits on the beneficiary account are typically refreshed every 24 hours. Its not clear when the 24 hour window shall elpase so you can then reinitiate the transfer via Cashfree after some time so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after some time. |
| 200 | REVERSED | INVALID\_ACCOUNT\_FAIL | The transfer has been reversed by the beneficiary bank because the Account Number of the beneficiary is invalid. After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the account number, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account number |
| 200 | REVERSED | BENE\_NAME\_DIFFERS | The transfer has been reversed by the beneficiary bank because the Account Name of the beneficiary is different. After correcting the beneficiary name, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | After correcting the beneficiary name, you can reinitiate the transfer via Cashfree so that the transfer can be reattempted again by Cashfree with the partner bank(s). | Yes, after correcting the account name |
| 200 | SUCCESS | SENT\_TO\_BENEFICIARY | The transfer has been initiated via the partner bank successfully. The request is waiting to be processed at the beneficiary bank to do the credit to the end beneficiary. | - | - |
| 200 | SUCCESS | COMPLETED | The transfer has been initiated via the partner bank successfully, hence your account is debited and the request is successfully processed by the beneficiary bank and has been credited to the end beneficiary. | - | - |
#### 4XX errors
| HTTP status code | Error code | Message | Next action |
| :--------------- | :------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :---------------------------------------- |
| 400 | batch\_transfer\_id\_missing | batch\_transfer\_id\_missing is missing in the request | Enter a batch transfer ID in the request. |
| 400 | batch\_transfer\_id\_invalid | batch\_transfer\_id\_invalid should be alphanumeric | Enter a valid batch transfer ID. |
| 400 | transfers\[0].transfer\_id\_invalid | transfer\_id should be alphanumeric | Enter a valid transfer ID. |
| 400 | transfers\[0].transfer\_id\_missing | transfer\_id is missing in the request | Enter a transfer ID in the request. |
| 400 | transfers\[0].transfer\_amount\_invalid | transfer\_amount should be greater then 1.00 | Enter an amount greater than 1.00. |
| 400 | transfers\[0].transfer\_amount\_missing | transfer\_amount is missing in the request | Enter a transfer amount in the request. |
| 400 | transfers\[0].transfer\_mode\_invalid | transfer\_mode is invalid allowed values are : bank, imps, neft, rtgs, upi, paytm, amazonpay, card and cardupi | Enter a valid transfer mode. |
| 400 | transfers\[0].beneficiary\_details.beneficiary\_id\_invalid | beneficiary\_id should be alphanumeric | Enter a valid beneficiary ID. |
| 400 | transfers\[0].beneficiary\_details.beneficiary\_name\_invalid | beneficiary\_name is invalid. only alphabets and whitespaces are allowed | Enter a valid beneficiary name. |
| 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.bank\_account\_number\_invalid | bank\_account\_number should be alphanumeric | Enter a valid bank account number. |
| 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.bank\_ifsc\_invalid | bank\_ifsc should be in standard ifsc format | Enter a valid IFSC. |
| 400 | transfers\[0].beneficiary\_details.beneficiary\_instrument\_details.vpa\_invalid | vpa is in invalid format | Enter a valid VPA. |
## OpenAPI
````yaml post /transfers/batch
openapi: 3.0.0
info:
version: '2024-01-01'
title: Cashfree Payout APIs
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
contact:
email: developers@cashfree.com
name: API Support
url: https://discord.com/invite/QdZkNSxXsB
description: >-
Cashfree's Payout APIs provide developers with a streamlined pathway to
integrate advanced payout capabilities into their applications, platforms
and websites.
servers:
- url: https://sandbox.cashfree.com/payout
description: Sandbox server
- url: https://api.cashfree.com/payout
description: Production server
security: []
tags:
- name: V2 Apis
description: >-
Collection of APIs to transfer funds to beneficiaries and manage
beneficiaries.
externalDocs:
url: https://api.cashfree.com/payout
description: This url will have the information of all the APIs.
paths:
/transfers/batch:
post:
tags:
- Transfers v2
summary: Batch Transfer V2
description: >-
Use this API to initiate a batch transfer request at Cashfree Payments.
You can transfer money to multiple beneficiaries. The batch transfer
limit is 5,000 in the production environment and 1,000 by default in the
test environment.
operationId: PayoutInitiateBatchTransfer
parameters:
- $ref: '#/components/parameters/apiVersionHeader'
- $ref: '#/components/parameters/xRequestIDHeader'
- $ref: '#/components/parameters/xCfSignature'
requestBody:
description: >-
Find the request parameters of the API request to transfer money to
multiple beneficiaries.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBatchTransferRequest'
examples:
transfer_request:
$ref: '#/components/examples/batch_transfer_request_v2'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBatchTransferResponse'
examples:
batch_transfer_received_response_v2:
$ref: '#/components/examples/batch_transfer_received_response_v2'
headers:
x-api-version:
$ref: '#/components/headers/x-api-version'
x-ratelimit-limit:
$ref: '#/components/headers/x-ratelimit-limit'
x-ratelimit-remaining:
$ref: '#/components/headers/x-ratelimit-remaining'
x-ratelimit-retry:
$ref: '#/components/headers/x-ratelimit-retry'
x-request-id:
$ref: '#/components/headers/x-request-id'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorV2'
examples:
batch_transfer_id_missing:
$ref: '#/components/examples/batch_transfer_id_missing'
batch_transfer_id_invalid:
$ref: '#/components/examples/batch_transfer_id_invalid'
transfer_id_invalid:
$ref: '#/components/examples/batchTransfer_transfer_id_invalid'
transfer_id_missing:
$ref: '#/components/examples/batchTransfer_transfer_id_missing'
transfer_amount_invalid:
$ref: '#/components/examples/batchTransfer_transfer_amount_invalid'
transfer_amount_missing:
$ref: '#/components/examples/batchTransfer_transfer_amount_missing'
transfer_mode_invalid:
$ref: '#/components/examples/batchTransfer_transfer_mode_invalid'
beneficiary_id_invalid:
$ref: '#/components/examples/batchTransfer_beneficiary_id_invalid'
beneficiary_name_invalid:
$ref: '#/components/examples/batchTransfer_beneficiary_name_invalid'
beneficiary_bank_account_invalid:
$ref: >-
#/components/examples/batchTransfer_beneficiary_bank_account_invalid
beneficiary_bank_ifsc_invalid:
$ref: >-
#/components/examples/batchTransfer_beneficiary_bank_ifsc_invalid
beneficiary_vpa_invalid:
$ref: '#/components/examples/batchTransfer_beneficiary_vpa_invalid'
'409':
description: Batch transfer_id already exists
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorV2'
examples:
APIDisabled:
$ref: '#/components/examples/batch_transfer_id_already_exists'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorV2'
examples:
APIDisabled:
$ref: '#/components/examples/internal_server_error_v2'
AuthenticationError:
$ref: '#/components/examples/authentication_internal_server_error'
deprecated: false
security:
- XClientID: []
XClientSecret: []
components:
parameters:
apiVersionHeader:
in: header
name: x-api-version
required: true
description: It is the API version to be used. The accepted format is YYYY-MM-DD.
schema:
type: string
description: It is the API version to be used.
default: '2024-01-01'
example: '2024-01-01'
xRequestIDHeader:
in: header
name: x-request-id
description: >-
Request ID for the API call. Can be used to resolve tech issues.
Communicate this in your tech related queries to Cashfree.
required: false
schema:
type: string
example: 4dfb9780-46fe-11ee-be56-0242ac120002
xCfSignature:
in: header
name: x-cf-signature
description: Signature to be sent if IP is not whitelisted.
required: false
schema:
type: string
schemas:
CreateBatchTransferRequest:
title: Batch Transfer V2
description: Batch Transfer V2
type: object
properties:
batch_transfer_id:
type: string
description: >-
It is the unique ID you create to identify the batch transfer
request. The maximum character limit is 60. Alphanumeric and
underscore ( _ ) characters are allowed.
maxLength: 60
transfers:
type: array
items:
type: object
properties:
transfer_id:
type: string
description: >-
It is the unique ID you create to identify the transfer. You
can use a maximum of 40 characters to create a transfer_id.
Alphanumeric and underscore ( _ ) are allowed.
maxLength: 40
transfer_amount:
type: number
format: double
description: >-
It is the transfer amount. Decimal values are allowed. The
minimum value should be equal to or greater than 1.00. (>=
1.00)
transfer_currency:
type: string
description: >-
It is the currency of the transfer amount. The default value
is INR.
transfer_mode:
type: string
description: >-
It is the mode of transfer. Allowed values are banktransfer,
imps, neft, rtgs, upi, paytm, amazonpay, card. The default
transfer_mode is banktransfer.
enum:
- banktransfer
- imps
- neft
- rtgs
- upi
- paytm
- amazonpay
- card
- cardupi
maxLength: 20
beneficiary_details:
type: object
description: >-
It should contain the details of the beneficiary who receives
the transfer amount.
properties:
beneficiary_id:
type: string
description: >-
It is the unique ID you created to identify the
beneficiary. Alphanumeric characters are allowed.
beneficiary_name:
type: string
description: >-
It is the name of the beneficiary. The maximum character
limit is 100.
beneficiary_instrument_details:
type: object
description: >-
It should contain the details of where the beneficiary
will receive the money. You input these details if you
haven't added the beneficiary in the Payouts dashboard.
properties:
bank_account_number:
type: string
description: >-
It is the beneficiary bank account number. The value
should be between 9 and 18 characters. Alphanumeric
characters are allowed. This value is required if
beneficiary_id is not present and if the transfer_mode
is banktransfer, imps, neft, rtgs mode.
bank_ifsc:
type: string
description: >-
It is the IFSC information of the beneficiary's bank
account in the standard IFSC format. The value should
be 11 characters. (The first 4 characters should be
alphabets, the 5th character should be a 0, and the
remaining 6 characters should be numerals.)
vpa:
type: string
description: >-
It is the UPI VPA information of the beneficiary. Only
valid UPI VPA information is accepted. It can be an
Alphanumeric value with only period (.), hyphen (-),
underscore ( _ ), and at the rate of (@). Hyphen (-)
is accepted only before at the rate of (@). This value
is required if the transfer_mode is upi.
beneficiary_contact_details:
type: object
description: It should contain the contact details of the beneficiary.
properties:
beneficiary_email:
type: string
description: >-
It is the email address of the beneficiary. The
maximum character limit is 200. It should contain dot
(.) and at the rate of (@).
beneficiary_phone:
type: string
description: >-
It is the phone number of the beneficiary. Only
registered Indian phone numbers are allowed. The value
should be between 8 and 12 characters after stripping
+91.
beneficiary_country_code:
type: string
description: >-
It is the country code (+91) of the beneficiary's
phone number.
beneficiary_address:
type: string
description: >-
It should contain the address of the beneficiary. The
maximum character limit is 150. Alphanumeric
characters and whitespaces are allowed.
beneficiary_city:
type: string
description: >-
It is the name of the city as present in the
beneficiary address. The maximum character limit is
50. Alphanumeric characters and whitespaces are
allowed.
beneficiary_state:
type: string
description: >-
It is the name of the state as present in the
beneficiary address. The maximum character limit is
50. Alphanumeric characters and whitespaces are
allowed.
beneficiary_postal_code:
type: string
description: >-
It is the PIN code as present in the address. It
should be a 6 character numeric value.
transfer_remarks:
type: string
description: >-
It can contain any additional remarks for the transfer.
Alphanumeric and whitespaces are allowed. The maximum
character limit is 70.
maxLength: 70
fundsource_id:
type: string
description: >-
It is the ID of the fund source from where you want to debit
the transfer amount.
required:
- transfer_amount
- transfer_id
required:
- batch_transfer_id
CreateBatchTransferResponse:
title: Batch Transfer V2 Response
description: Batch Transfer V2 Response
type: object
properties:
batch_transfer_id:
type: string
description: >-
It displays the unique ID you created to identify the batch transfer
request.
cf_batch_transfer_id:
type: string
description: >-
It displays the unique ID created by Cashfree Payments. You receive
this ID in the response after initiating the batch transfer request.
status:
type: string
description: It displays the status of the API request.
ErrorV2:
title: Error
description: Error Response for non-2XX cases
type: object
properties:
type:
type: string
description: Type of the error received
code:
type: string
description: Code of the error received
message:
type: string
description: Detailed message explaining the response
examples:
batch_transfer_request_v2:
summary: Batch transfer request
description: The API request to initiate a batch transfer
value:
batch_transfer_id: test_batch_transfer_id
transfers:
- transfer_id: JUNOB2018
transfer_amount: 1
beneficiary_details:
beneficiary_id: JOHN18011
- transfer_id: JUNOB2018
transfer_amount: 1
transfer_mode: imps
beneficiary_details:
beneficiary_details:
beneficiary_instrument_details:
bank_account_number: '1234554321'
bank_ifsc: SBIN0001161
- transfer_id: JUNOB2018
transfer_amount: 1
transfer_mode: imps
beneficiary_details:
beneficiary_details:
beneficiary_id: JOHN18011
fundsource_id: CASHFREE_1
batch_transfer_received_response_v2:
summary: Batch transfer received successfully
description: >-
Batch transfer received successfully by Cashfree Payments. Please check
the status of the batch transfer after some time.
value:
batch_transfer_id: test_batch_transfer_id
cf_batch_transfer_id: '123456'
status: RECEIVED
batch_transfer_id_missing:
description: Missing batch_transfer_id
value:
type: invalid_request_error
code: batch_transfer_id_missing
message: batch_transfer_id is missing in the request
batch_transfer_id_invalid:
description: Invalid batch_transfer_id
value:
type: invalid_request_error
code: batch_transfer_id_invalid
message: batch_transfer_id should be alphanumeric
batchTransfer_transfer_id_invalid:
description: Invalid transfer_id
value:
type: invalid_request_error
code: transfers[0].transfer_id_invalid
message: transfer_id should be alphanumeric
batchTransfer_transfer_id_missing:
description: Missing transfer_id
value:
type: invalid_request_error
code: transfers[0].transfer_id_missing
message: transfer_id is missing in the request
batchTransfer_transfer_amount_invalid:
description: Invalid transfer_amount
value:
type: invalid_request_error
code: transfers[0].transfer_amount_invalid
message: transfer_amount should be greater then 1.00
batchTransfer_transfer_amount_missing:
description: Missing transfer_amount
value:
type: invalid_request_error
code: transfers[0].transfer_amount_missing
message: transfer_amount is missing in the request
batchTransfer_transfer_mode_invalid:
description: Invalid transfer_mode
value:
type: invalid_request_error
code: transfers[0].transfer_mode_invalid
message: >-
transfer_mode is invalid allowed values are : bank, imps, neft, rtgs,
upi, paytm, amazonpay, card and cardupi
batchTransfer_beneficiary_id_invalid:
description: Invalid beneficiary_id
value:
type: invalid_request_error
code: transfers[0].beneficiary_details.beneficiary_id_invalid
message: beneficiary_id should be alphanumeric
batchTransfer_beneficiary_name_invalid:
description: Invalid transfer_id
value:
type: invalid_request_error
code: transfers[0].beneficiary_details.beneficiary_name_invalid
message: >-
beneficiary_name is invalid. only alphabets and whitespaces are
allowed
batchTransfer_beneficiary_bank_account_invalid:
description: beneficiary bank account is invalid
value:
type: invalid_request_error
code: >-
transfers[0].beneficiary_details.beneficiary_instrument_details.bank_account_number_invalid
message: bank_account_number should be alphanumeric
batchTransfer_beneficiary_bank_ifsc_invalid:
description: Invalid bank account details
value:
type: invalid_request_error
code: >-
transfers[0].beneficiary_details.beneficiary_instrument_details.bank_ifsc_invalid
message: bank_ifsc should be in standard ifsc format
batchTransfer_beneficiary_vpa_invalid:
description: Invalid beneficiary VPA
value:
type: invalid_request_error
code: >-
transfers[0].beneficiary_details.beneficiary_instrument_details.vpa_invalid
message: vpa is in invalid format
batch_transfer_id_already_exists:
summary: batch_transfer_id not found
description: batch_transfer_id not found
value:
type: invalid_request_error
code: batch_transfer_id_already_exists
message: >-
batch_transfer_id already exists. please pass unique id in each
request
internal_server_error_v2:
summary: Internal server error
description: Error at Cashfree Payments' server
value:
type: api_error
code: internal_server_error
message: Error at cashfree's server
authentication_internal_server_error:
summary: Internal server error while authenticating request
description: Internal server error while authenticating request
value:
type: authentication_error
code: internal_server_error
message: >-
Unable to authenticate the request. Please fill out the [Support
Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)
headers:
x-api-version:
schema:
type: string
format: YYYY-MM-DD
enum:
- '2022-09-01'
description: It displays the API version. The current version is `2022-09-01`.
x-ratelimit-limit:
schema:
type: integer
example: 200
description: >-
It displays the rate limit per minute set for your account for this API
request.
x-ratelimit-remaining:
schema:
type: integer
example: 2
description: >-
It displays the remaining rate limit in the next minute for your account
for this API requeste. Uses sliding window.
x-ratelimit-retry:
schema:
type: integer
example: 4
description: |
It displays the number of seconds to wait if the rate limit is breached
- Is 0 if withing the limit
- Is between 1 and 59 if breached
x-request-id:
schema:
type: string
example: some-req-id
description: >-
It displays the request ID for the API request. Is blank or null if no
`x-request-id` is sent during the request
securitySchemes:
XClientID:
type: apiKey
in: header
name: x-client-id
description: >-
Client app ID. You can find your app ID in the [Merchant
Dashboard](https://merchant.cashfree.com/payouts/developers/api-keys).
XClientSecret:
type: apiKey
in: header
name: x-client-secret
description: >-
Client secret key. You can find your secret key in the [Merchant
Dashboard]((https://merchant.cashfree.com/payouts/developers/api-keys).
````