get https://payout-gamma.cashfree.com/payout/v1/beneHistory
Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.
Note:
- This API is rate-limited, it supports 100 requests per minute.
- It supports pagination. Use page parameters to display the next pages.
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.
Response Codes
| Sub Code | Status | Message | Solution |
|---|---|---|---|
| 200 | SUCCESS | Data retrieved successfully. | - |
| 403 | ERROR | Token is invalid. | Validate the generated token. |
| 405 | ERROR | Invalid request URL or HTTP method. | |
| 422 | ERROR | Requested date range is invalid. | Enter a valid date rage. |
| 422 | ERROR | Page value should be minimum 1. | Enter the page value as 1. |
| 422 | ERROR | Please provide a valid Beneficiary Id. | Enter a valid beneficiary ID. |
| 422 | ERROR | startDate should be of format yyyy-mm-dd | Enter the date range in the format: yyyy-mm-dd. |
| 422 | ERROR | endDate should be of format yyyy-mm-dd | Enter the date range in the format: yyyy-mm-dd. |
| 422 | ERROR | startDate should be less than or equal to EndDate | Enter a startDate value lesser than or equal to endDate. |
| 422 | ERROR | perPage should be at max 25 | Enter the perPage value lesser than or equal to 25. |
| 429 | ERROR | Too many requests. | |
| 520 | ERROR | Unknown error occurred. | Try again after some time. |