Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Beneficiary Apis
  • Payouts Overview
  • Payouts Sign Up
  • Payout Methods
  • Payout API Response Codes
  • Payouts Integration Steps
  • Encrypting and Decrypting Payload
  • Payouts Status Codes
  • Get Authentication Token
    • Get Authentication Token
      POST
  • Beneficiary Apis
    • Create Beneficiary
      POST
    • Search Beneficiary
      POST
    • Delete Beneficiary
      DELETE
  • Transfer Apis
    • Create Payout
      POST
    • Search Payouts
      POST
    • Create Batch Payout
      POST
  • Payout Account Apis
    • Get Balance
      GET
    • Get Source Bank Account Details
      GET
    • Add Source Bank Account
      POST
    • Fetch Bank Statement
      POST
  • Webhook Data Apis
    • Get Webhook Data
      GET
    • Create Webhook Data
      POST
  1. Beneficiary Apis

Search Beneficiary

POST
/api/v0/beneficiary-detail/search
Beneficiary Detail Apis
Utilize this API to retrieve the details of a specific beneficiary from your EnKash payout account. You can provide either of the paramenters provided in request to search.
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/api/v0/beneficiary-detail/search' \
--header 'clientId: CEKxxxxxxx' \
--header 'User-Agent;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request": "string"
}'

Responses

🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
string 
optional
Example
{
  "response_code": 0,
  "response_message": "string",
  "payload": "string"
}
Modified at 2024-10-14 09:13:32
Previous
Create Beneficiary
Next
Delete Beneficiary
Built with