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>'
"{\n    \"status\": \"SUCCESS\",\n    \"subCode\": \"200\",\n    \"message\": \"Data retrieved successfully\",\n    \"data\": {\n        \"transfers\": [\n            {\n                \"transferDate\": \"2020-06-16\",\n                \"amount\": \"1\",\n                \"mode\": \"IMPS\",\n                \"beneId\": \"John Doe\",\n                \"status\": \"SUCCESS\"\n            },\n            {\n                \"transferDate\": \"2020-05-28\",\n                \"amount\": \"1\",\n                \"mode\": \"NEFT\",\n                \"beneId\": \"John Doe\",\n                \"status\": \"SUCCESS\"\n            },\n            {\n                \"transferDate\": \"2020-05-15\",\n                \"amount\": \"1.1\",\n                \"mode\": \"IMPS\",\n                \"beneId\": \"John Doe\",\n                \"status\": \"SUCCESS\"\n            },\n            {\n                \"transferDate\": \"2020-05-15\",\n                \"amount\": \"1.1\",\n                \"mode\": \"IMPS\",\n                \"beneId\": \"John Doe\",\n                \"status\": \"SUCCESS\"\n            },\n            {\n                \"transferDate\": \"2020-05-15\",\n                \"amount\": \"1\",\n                \"mode\": \"IMPS\",\n                \"beneId\": \"John Doe\",\n                \"status\": \"SUCCESS\"\n            }\n        ]\n    }\n}"
This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)

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

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

​
page
number

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

Response

200
application/json

200

The response is of type object.