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>'
"{\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)
Sub CodeStatusMessageSolution
200SUCCESSData retrieved successfully.-
403ERRORToken is invalid.Validate the generated token.
405ERRORInvalid request URL or HTTP method.
422ERRORRequested date range is invalid.Enter a valid date rage.
422ERRORPage value should be minimum 1.Enter the page value as 1.
422ERRORPlease provide a valid Beneficiary Id.Enter a valid beneficiary ID.
422ERRORstartDate should be of format yyyy-mm-ddEnter the date range in the format: yyyy-mm-dd.
422ERRORendDate should be of format yyyy-mm-ddEnter the date range in the format: yyyy-mm-dd.
422ERRORstartDate should be less than or equal to EndDateEnter a startDate value lesser than or equal to endDate.
422ERRORperPage should be at max 25Enter the perPage value lesser than or equal to 25.
429ERRORToo many requests.
520ERRORUnknown error occurred.Try again after some time.

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

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"Data retrieved successfully"

ā€‹
data
object