Skip to main content
GET
/
payout
/
v1
/
beneHistory
Get Beneficiary History
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1/beneHistory \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Data retrieved successfully",
  "data": {
    "transfers": [
      {
        "transferDate": "2020-06-16T00:00:00.000Z",
        "amount": "1",
        "mode": "IMPS",
        "beneId": "John Doe",
        "status": "SUCCESS"
      },
      {
        "transferDate": "2020-05-28T00:00:00.000Z",
        "amount": "1",
        "mode": "NEFT",
        "beneId": "John Doe",
        "status": "SUCCESS"
      },
      {
        "transferDate": "2020-05-15T00:00:00.000Z",
        "amount": "1.1",
        "mode": "IMPS",
        "beneId": "John Doe",
        "status": "SUCCESS"
      },
      {
        "transferDate": "2020-05-15T00:00:00.000Z",
        "amount": "1.1",
        "mode": "IMPS",
        "beneId": "John Doe",
        "status": "SUCCESS"
      },
      {
        "transferDate": "2020-05-15T00:00:00.000Z",
        "amount": "1",
        "mode": "IMPS",
        "beneId": "John Doe",
        "status": "SUCCESS"
      }
    ]
  }
}

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.

Headers

​
Authorization
string
required

Bearer auth token

​
Content-Type
string
required

application/json

Query Parameters

​
beneId
string
required

The beneficiary id that you have created. Alphanumeric characters accepted.

​
startDate
string

Start date for the desired period. Format - yyyy-mm-dd

​
endDate
string

End date for the desired period. Format - yyyy-mm-dd. If start date is provided, end date is a mandatory. End date has to be a day less than current date.

​
perPage
number<float>

Number of transactions to be displayed on the page. Maximum = 25. Default value set is 25.

​
page
number<float>

Will show the latest transfers on the first page. Minimum = 1. Default value set is 1.

Response

200

​
status
string
Example:

"SUCCESS"

​
subCode
string
Example:

"200"

​
message
string
Example:

"Data retrieved successfully"

​
data
object