POST/v2/beneficiary/list

List Beneficiaries

Returns a paginated list of active beneficiaries on the merchant account.

Headers

Field	Type	Required	Possible values	Description
`Authorization`	string	Required	Bearer {SessionToken}	Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request.

Request body

Field	Type	Required	Possible values	Description
`PageNumber`	integer	Required	1 \| 2 \| 3 \| 4 ... N	Page index for paginated results (1-based).
`PageSize`	integer	Required	10 \| 20 \| 50 \| 100 \| ... N	Number of records to return per page.

Example request

{
  "PageNumber": 1,
  "PageSize": 10
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 301 \| 503 \| 422	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	Paginated list of beneficiaries with status and metadata.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Data": [
      {
        "Id": "4650983997967871956",
        "CreatedBy": "vikasniyamatkalra2 - vikas NIY Kalra",
        "CreatedOn": "2026-04-17T08:52:14.747-04:00",
        "Beneficiary_Name": "Rishav Upadhayay",
        "Beneficiary_Type": "Individual",
        "Beneficiary_Status": "Active"
  …

Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.