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

Create Beneficiary

POST
/api/v0/beneficiary-detail
Beneficiary Detail Apis
To initiate payouts to your customers, add them as beneficiaries to your EnKash Payments account, including their bank account or UPI details for instant transfers.
Beneficiary Create Request
beneficiaryId
string 
required
It is the unique ID you create to identify the beneficiary. Alphanumeric
beneficiaryName
string 
required
It is the name of the beneficiary. The maximum character limit is 100. Only alphabets and whitespaces are allowed.
beneficiaryAccountNumber
string 
optional
It is the beneficiary bank account number.
beneficiaryIfsc
string 
optional
It's the IFSC information of the beneficiary's bank account, formatted according to the standard IFSC format.
Match pattern:
^[A-Za-z]{4}0[A-Z0-9a-z]{6}$
vpaHandle
string 
optional
t is the UPI VPA information of the beneficiary. Only valid UPI VPA information is accepted. It can be an Alphanumeric value with only period (.), hyphen (-), underscore ( _ ), and at the rate of (@). Hyphen (-) is accepted only before at the rate of (@).
beneficiaryEmail
string 
optional
It's the beneficiary's email address, with a maximum character limit of 200. It should include a dot (.) and an at symbol (@).
beneficiaryPhone
string 
optional
It's the beneficiary's phone number, restricted to registered Indian numbers. The value should range between 8 and 12 characters after removing the +91 prefix.
Match pattern:
^((\+|00)(\d{1,3})[\s-]?)?(\d{10})$
beneficiaryAddress
string 
optional
It's the address information of the beneficiary.
beneficiaryCity
string 
optional
It is the name of the city as present in the beneficiary's address.
beneficiaryState
string 
optional
It is the name of the state as present in the beneficiary's address.
checksum
string 
optional
It is checksum value derived from a dataset to verify data integrity during transmission
beneficiaryPincode
string 
optional
It's the PIN code information from the beneficiary's address, with a maximum character limit of 6. Only numerical characters are permitted.
Match pattern:
\b\d{6}\b
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' \
--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
Excrytped response payload
Example
{
  "response_code": 0,
  "response_message": "string",
  "payload": "string"
}
Modified at 2024-10-14 09:10:03
Previous
Beneficiary Apis
Next
Search Beneficiary
Built with