Standard Transfer Async

Use this API to initiate an amount transfer request at Cashfree by providing beneficiary id, amount, and transfer id. This is an async transfer request.

POST /payout/v1/requestAsyncTransfer

Standard Transfer Async

cURL

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "beneId": "<string>",
  "amount": 123,
  "transferId": "<string>",
  "transferMode": "<string>",
  "remarks": "<string>"
}
'

import requests

url = "https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer"

payload = {
    "beneId": "<string>",
    "amount": 123,
    "transferId": "<string>",
    "transferMode": "<string>",
    "remarks": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    beneId: '<string>',
    amount: 123,
    transferId: '<string>',
    transferMode: '<string>',
    remarks: '<string>'
  })
};

fetch('https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'beneId' => '<string>',
    'amount' => 123,
    'transferId' => '<string>',
    'transferMode' => '<string>',
    'remarks' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer"

	payload := strings.NewReader("{\n  \"beneId\": \"<string>\",\n  \"amount\": 123,\n  \"transferId\": \"<string>\",\n  \"transferMode\": \"<string>\",\n  \"remarks\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"beneId\": \"<string>\",\n  \"amount\": 123,\n  \"transferId\": \"<string>\",\n  \"transferMode\": \"<string>\",\n  \"remarks\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://payout-api.cashfree.com/payout/v1/requestAsyncTransfer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"beneId\": \"<string>\",\n  \"amount\": 123,\n  \"transferId\": \"<string>\",\n  \"transferMode\": \"<string>\",\n  \"remarks\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "ACCEPTED",
  "subCode": "201",
  "message": "Transfer Initiated",
  "data": {
    "referenceId": "107260"
  }
}

{
  "status": "ERROR",
  "subCode": "403",
  "message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}

{
  "status": "ERROR",
  "subCode": "422",
  "message": "Remarks is invalid"
}

This API will be retired soon. Please plan to migrate to the latest version, Transfers V2.

Once you trigger the requestAsyncTransfer API, Cashfree Payments verifies your request and returns the Cashfree referenceId. The transfer to beneficiary account will be attempted within the next 60 seconds and you may query the transfer status after 60 seconds.

Use this API to process very high volumes.

Benefits:

1. The API response is much faster for the async transfer endpoint. The async transfer response takes <100 ms as compared to a median value of 2-5 sec for the sync payout transfer API.
2. The asynchronous API can handle a higher TPM (transactions per minute) as compared to the synchronous API. The async API allows us to handle up to 1000 transactions per minute.

Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)

Click to view the response codes.

Sub code	Status	Message
200	SUCCESS	Transfer completed successfully.
201	SUCCESS	Transfer Scheduled for next working day.
201	PENDING	Awaiting confirmation from beneficiary bank.
201	PENDING	Transfer request pending at the bank.
202	PENDING	Request received. Please check status after some time.
403	ERROR	Token is not valid
403	ERROR	IP not whitelisted
403	ERROR	This feature is not available for your account.
403	ERROR	Transfer mode is not available for your account.
412	ERROR	Token missing in the request.
412	ERROR	BeneId missing in the request.
412	ERROR	Amount missing in the request.
412	ERROR	TransferId missing in the request.
422	ERROR	Invalid amount passed.
422	ERROR	Invalid transferId passed.
422	ERROR	No Payee Virtual Address associated with the beneficiary.
422	ERROR	Remarks can have only numbers, alphabets and whitespaces.
409	ERROR	Transfer Id already exists.
404	ERROR	Beneficiary does not exist.
422	ERROR	Beneficiary details not valid.
422	ERROR	No Bank account or IFSC associated with the beneficiary.
412	ERROR	Not enough available balance in the account.
412	ERROR	Please wait 30 minutes after adding the beneficiary.
412	ERROR	Transfer amount is less than minimum amount of Rs. 100.
412	ERROR	Transfer amount is greater than the maximum amount of Rs.100000.
422	ERROR	Invalid IFSC code provided for bank account.
422	ERROR	Invalid bank account number or IFSC provided.
422	ERROR	Transfer request to paytm wallet failed.
400/520	ERROR	Transfer attempt failed at the bank.
520	ERROR	Transfer request triggered. No response from bank.
403	ERROR	Transfer to this beneficiary not allowed.
412	ERROR	Transfer limit for beneficiary exceeded.
412	ERROR	Transfer limit for your account exceeded.
412	ERROR	Invalid transfer mode passed in the request.
412	ERROR	Transfer mode not enabled for the account.
412	ERROR	Invalid Tag passed in the request.

Headers

Authorization · string · required

Bearer auth token

Content-Type · string · required

application/json

Body

application/json

beneId · string · required

Beneficiary ID. Alphanumeric characters allowed.

amount · number<float> · required

Amount to be transferred. Decimal allowed (>= 1.00)

transferId · string · required

A unique id to identify this transfer. Alphanumeric and underscore (_) allowed (40 character limit).

transferMode · string

It is the mode of transfer. Allowed values are: banktransfer, neft, imps, rtgs, upi, paytm, and amazonpay. The default transferMode is banktransfer.

remarks · string

Additional remarks, if any. alphanumeric and white spaces allowed (70 characters limit)

Response

200

application/json

200

status · string

Example:

"ACCEPTED"

subCode · string

Example:

"201"

message · string

Example:

"Transfer Initiated"

data · object

Show child attributes