Get Batch Transfer Status

Use this API to get the status of the Batch Transfer.

GET /payout/v1/getBatchTransferStatus

Get Batch Transfer Status

cURL

curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1/getBatchTransferStatus \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'

import requests

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

headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};

fetch('https://payout-api.cashfree.com/payout/v1/getBatchTransferStatus', 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/getBatchTransferStatus",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	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.get("https://payout-api.cashfree.com/payout/v1/getBatchTransferStatus")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'

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

200

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Data retrieved successfully",
  "data": {
    "rowCount": 2,
    "referenceId": 1582,
    "transfers": [
      {
        "beneId": "999999999918875",
        "transferId": "PTM_00121241112",
        "referenceId": 1523969542,
        "bankAccount": "9999999999",
        "ifsc": "PYTM0000001",
        "amount": "12.00",
        "remarks": "",
        "status": "SUCCESS",
        "utr": "W1532082925",
        "addedOn": "2018-07-20T00:00:00.000Z",
        "processedOn": "2018-07-20T00:00:00.000Z"
      }
    ]
  }
}

{
  "status": "ERROR",
  "subCode": "404",
  "message": "Batch Transfer Id does not exist"
}

{
  "status": "ERROR",
  "subCode": "403",
  "message": "Token is not valid"
}

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

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

Click to view the batch format.

Sub code	Status	Message
200	SUCCESS	Data retrieved successfully
201	PENDING	Entries are not processed yet
403	ERROR	Token is not valid
403	ERROR	IP not whitelisted
404	ERROR	Bulk Transfer Id does not exist
412	ERROR	Token missing in the request
520	ERROR	Error while fetching data
520	ERROR	Unknown error occurred at batchTransfer

Headers

Authorization · string · required

Bearer auth token

Content-Type · string · required

application/json

Query Parameters

batchTransferId · string · required

It is the unique ID created for the batch transfer.

Response

200

application/json

200

status · string

Example:

"SUCCESS"

subCode · string

Example:

"200"

message · string

Example:

"Data retrieved successfully"

data · object

Show child attributes