Search Beneficiary

📌

Use this API to fetch the details of a specific beneficiary from your EnKash payout account.
You can search by providing any one of the supported parameters in the request. This allows you to quickly verify beneficiary information before initiating payouts or managing beneficiary records.

BeneficiarySearchRequest

beneficiaryIds

array[string]

optional

beneficiaryName

string

optional

beneficiaryAccountNumber

string

optional

vpaHandle

string

optional

beneficiaryIfsc

string

optional

beneficiaryEmail

string

optional

beneficiaryPhone

string

optional

companyId

string

optional

createdOnFrom

string <date-time>

optional

createdOnTo

string <date-time>

optional

modifiedOnFrom

string <date-time>

optional

modifiedOnTo

string <date-time>

optional

direction

enum<string>

optional

Allowed values:

ASCDESC

orderBy

string

required

offset

integer

optional

>= 0

limit

integer

optional

>= 0<= 100

deleted

boolean

optional

Response will be array ofBeneficiary Response object

Beneficiary Response

enkashBeneCode

string

optional

beneficiaryId

string

optional

beneficiaryAccountNumber

string

optional

beneficiaryIfsc

string

optional

vpaHandle

string

optional

beneficiaryName

string

optional

beneficiaryCity

string

optional

beneficiaryState

string

optional

beneficiaryEmail

string

optional

beneficiaryPhone

string

optional

beneficiaryAddress

string

optional

beneficiaryPincode

string

optional

createdOn

string <date-time>

optional

modifiedOn

string <date-time>

optional

failureReason

string

optional

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

clientId

string

required

Example:

CEKxxxxxxx

User-Agent

string

required

Body Params application/json

request

string

required

Encrypted request payload string

Example

{
    "request": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

string

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": "string"
}

Request

Request samples

Responses