Get Beneficiary History

Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.

πŸ“˜

Note:

  1. This API is rate-limited, it supports 100 requests per minute.
  2. 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 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.
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!