Search Beneficiary

POST

/api/v0/beneficiary-detail/search

📌

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

Response will be array ofBeneficiary Response object

Beneficiary Response

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Example

{
    "request": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test.your-api-server.com/api/v0/beneficiary-detail/search' \
--header 'clientId: CEKxxxxxxx' \
--header 'User-Agent;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request": "string"
}'

Responses

🟢200OK

application/json

Body

Example

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

Modified at 2025-07-08 18:45:39

Add Beneficiary

Delete Beneficiary