EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Beneficiary Apis
  • EnKash APIs
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment APIs
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • Order Overview
      • About Order
      • Create Order
      • Get Order Status
      • Get BNPL Payment Modes
    • Payments
      • Payment Overview
      • About Payment
      • Get Transaction Status
      • Submit Payment Detail
    • Refunds
      • About Refund
      • Refund
    • Payment Links
      • Upi Intent Link Detail
    • Settlements
      • About Settlement
      • Get Settlement Payout By Id
      • Search Settlement Payouts
    • QR Generation API
      • Get Dynamic QR Code
    • Payment Button
    • Qr Code
      • Create QR
      • Create QR Customer
      • Search QR Code
      • Get QR Code
      • Cancel QR Code
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payouts Integration Steps
    • Ecrypting and Decrypting Payload
    • Get Authentication Token
      • Get Authentication Token
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Get Balance
  • Account Payables
    • Accounts Payable Overview
    • Vendor Management
      • Beneficiary Apis
        • Update Beneficiary
          PUT
        • Create Beneficiary
          POST
        • Update Bulk Beneficiary
          PUT
        • Create Bulk Beneficiary
          POST
        • Get Beneficiaries V1
          POST
        • Get Beneficiaries
          POST
        • Change beneficiary status
          PATCH
        • Get Beneficiary
          GET
    • Invoice Management
      • Payout Apis
        • Search Payouts V1
        • initiate
        • validateInvoices
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • createCustomer
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • searchCustomer
        • deleteCustomerByCustomerId
        • updateCustomer
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
    • Invoice Management
      • invoice-controller
        • createInvoice
        • invoiceBulkUpload
        • Dispatch Invoice Collection
        • Delete Invoice Collection
        • searchCollectionInvoices
        • getInvoice
        • updateInvoice
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
        • getCustomerReminders
        • getCustomerReminder
        • deleteReminder
        • updateCustomerReminder
  • Loyalty
    • Loyalty Overview
    • Sign Up - Loyalty
    • Use Cases
    • Reward APIs
    • Authorization
      • SSO LOGIN
      • Client Authentication
    • Employee R&R
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • Channel Incentives
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • brand loyalty
      • Get Coin Event
      • Create Coin Event Configuration
      • Update Coin Event Configuration
      • Allocate Coins to User
    • Voucher Processing
      • Get Cart for User
      • Add to cart
      • Update Cart
      • Order Search
      • Get Order Details
      • Create Order
    • Voucher Catalog
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
  • Corporate Cards
    • Corporate Cards Overview
    • Sign Up - Corporate Cards
    • Corporate Cards Integration Steps
    • Authorization
      • Get Authorization Token
    • Meal Cards
      • Card APIs
        • Create Card
        • View Card
        • Set Pin Card
        • Search Cards
        • Replace Card
        • Physical Card
        • Block Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
    • Fuel Cards
      • Card APIs
        • Create Card
        • Search Cards
        • View Card
        • Block Card
        • Physical Card
        • Set Pin Card
        • Replace Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
    • GSTN Verification
    • PAN Verification
    • UPI(VPA) Verification
  • Payout Data Apis
  • Beneficiary Apis
  • tiny-url-controller
  • test-controller
  • company-category-limits-controller
  • bank-holiday-controller
  • Authentication Apis
  • utility-payment-controller-v-1
  • user-controller-v-1
  • Payout Apis
  • gst-payment-controller
  • biller-controller-v-1
  • Virtual Account Apis
  • Vendor Payment Entry Controller
  • Utm Based Config Apis
  • User Apis
  • User Group Apis
  • axis-nodal-controller-v-1
  • icici-nodal-controller
  • axis-nodal-controller
  • subscription-controller
  • Sign Up API's
  • sftp-detail-controller
  • sanction-screening-controller
  • risk-check-controller
  • Reward Page Notification Apis
  • refund-transaction-controller
  • purchase-order-controller
  • Pricing Plan
  • Pre Qualification Apis
  • Pg Balance Apis
  • Payout Transaction Apis
  • payment-request-controller
  • Payment Gateway Apis
  • pay-by-link-controller
  • Partner Integration Apis
  • outstanding-amount-controller
  • otp-controller
  • OnBoarding Config Apis
  • Nudge Apis
  • Multi Factor Auth Apis
  • mail-callback-controller
  • M2P Apis
  • anchor-partner-api-controller
  • amazon-sn-s-notification-controller
  • Karza Controller
  • Instant Payout Apis
  • ICICI Connected Banking Apis
  • gstin-data-controller
  • Generate Pdf APIs
  • fin-bit-controller
  • File Store Apis
  • file-transfer-controller
  • feedback-controller
  • Fd Payment Histories
  • Favorite Api
  • Expense Product Apis
  • equifax-controller
  • Encryption Apis
  • early-payment-offer-controller
  • Document
  • digital-signature-controller
  • digital-locker-controller
  • Credit Provider Risk Check API
  • credit-provider-detail-controller
  • Config Apis
  • company-pg-controller
  • company-branch-code-controller
  • communication-controller
  • Chat Bot Apis
  • card-token-controller
  • Card Product Master Apis
  • card-product-controller
  • Card Application Memo Apis
  • Card Application Apis
  • CardAccountTenant Apis
  • Card Account Addition Mapping Apis
  • Cam Automation Apis
  • bulk-file-detail-controller
  • bulk-file-data-controller
  • Bill Payment Apis
  • Company Biller Apis
  • Beneficiary Detail Apis
  • Bbps Complaint Management Apis
  • Bank IFSC
  • Bank Detail Apis
  • Bank Card Controller
  • AWS Secret Manager Properties Apis
  • Authority Apis
  • Anchor Detail Apis
  • penny-drop-controller
  • Mobile Otp Apis
  • Mobile Authentication Apis
  • oauth-client-detail-controller
  • url-generator-controller
  • Health Check Apis
  • Single Sign On Apis
  • Bulk Upload Sample File Apis
  • credit-policy-controller
  • Payout Logs
  • Help Apis
  • Geo Location Controller
  1. Beneficiary Apis

Get Beneficiaries V1

POST
/api/v1/beneficiary/search
Beneficiary Apis

Request

Body Params application/json
companyIds
array[string]
optional
parentIds
array[integer <int64>]
optional
offset
integer <int32>
optional
limit
integer <int32>
optional
<= 5000
panOrGstin
string 
optional
companyBranchCodeIds
array[integer <int64>]
optional
panStatus
enum<string> 
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
gstinStatus
enum<string> 
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
cinStatus
enum<string> 
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
businessTypes
array[string]
optional
Allowed values:
ENTERPRISECREDIT_PROVIDERVENDORSOCIETYAGENCY
bankVerifiedStatus
enum<string> 
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
companyOnBoardType
enum<string> 
optional
Allowed values:
CUSTOMERBENEFICIARY
branchCodes
array[string]
optional
branchNames
array[string]
optional
costCentres
array[string]
optional
branchCities
array[string]
optional
branchStates
array[string]
optional
utmSource
string 
optional
userGroupIds
array[string]
optional
isMsme
boolean 
optional
direction
enum<string> 
optional
Allowed values:
ASCDESC
bankApproval
enum<string> 
optional
Allowed values:
KOTAK_APPROVEDICICI_BANK_APPROVEDENKASH_D2I_APPROVEDAMEX_D2I_APPROVEDKOTAK_REJECTEDICICI_BANK_REJECTEDENKASH_D2I_REJECTEDAMEX_D2I_REJECTED
bankApprovalStatus
enum<string> 
optional
Allowed values:
APPROVEDPENDINGREJECTED
kycFailureReason
enum<string> 
optional
Allowed values:
PAN_GSTIN_BANK_MISSINGPAN_GSTIN_MISSINGBANK_MISSINGPAN_GSTIN_BANK_NOT_VERIFIEDPAN_GSTIN_NOT_VERIFIEDBANK_NOT_VERIFIEDPAN_GSTIN_BANK_NOT_MATCHKYC_NOT_APPROVEDNAME_MATCHING_FAILEDAPPROVED
companyParentChildRelationIds
array[string]
optional
company_id
string 
optional
parent_id
string 
optional
child_id
string 
optional
business_type
enum<string> 
optional
Allowed values:
ENTERPRISECREDIT_PROVIDERVENDORSOCIETYAGENCY
company_type
string 
optional
tax_id_1
string 
optional
tax_id_2
string 
optional
cin
string 
optional
din
string 
optional
external_ref_no
string 
optional
risk_approval_status
enum<string> 
optional
Allowed values:
APPROVEDPENDINGIN_PROGRESSBULK_UPLOADNEW
status
enum<string> 
optional
Allowed values:
ACTIVEINACTIVEBLOCKEDLOCKED
created_date_from
string <date-time>
optional
created_date_to
string <date-time>
optional
date_approved
string <date-time>
optional
email
string 
optional
legal_name
string 
optional
branch_code
string 
optional
order_by
string 
optional
Example
{
    "companyIds": [
        "string"
    ],
    "parentIds": [
        0
    ],
    "offset": 0,
    "limit": 5000,
    "panOrGstin": "string",
    "companyBranchCodeIds": [
        0
    ],
    "panStatus": "UNVERIFIED",
    "gstinStatus": "UNVERIFIED",
    "cinStatus": "UNVERIFIED",
    "businessTypes": [
        "ENTERPRISE"
    ],
    "bankVerifiedStatus": "UNVERIFIED",
    "companyOnBoardType": "CUSTOMER",
    "branchCodes": [
        "string"
    ],
    "branchNames": [
        "string"
    ],
    "costCentres": [
        "string"
    ],
    "branchCities": [
        "string"
    ],
    "branchStates": [
        "string"
    ],
    "utmSource": "string",
    "userGroupIds": [
        "string"
    ],
    "isMsme": true,
    "direction": "ASC",
    "bankApproval": "KOTAK_APPROVED",
    "bankApprovalStatus": "APPROVED",
    "kycFailureReason": "PAN_GSTIN_BANK_MISSING",
    "companyParentChildRelationIds": [
        "string"
    ],
    "company_id": "string",
    "parent_id": "string",
    "child_id": "string",
    "business_type": "ENTERPRISE",
    "company_type": "string",
    "tax_id_1": "string",
    "tax_id_2": "string",
    "cin": "string",
    "din": "string",
    "external_ref_no": "string",
    "risk_approval_status": "APPROVED",
    "status": "ACTIVE",
    "created_date_from": "2019-08-24T14:15:22Z",
    "created_date_to": "2019-08-24T14:15:22Z",
    "date_approved": "2019-08-24T14:15:22Z",
    "email": "string",
    "legal_name": "string",
    "branch_code": "string",
    "order_by": "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 '/api/v1/beneficiary/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "companyIds": [
        "string"
    ],
    "parentIds": [
        0
    ],
    "offset": 0,
    "limit": 5000,
    "panOrGstin": "string",
    "companyBranchCodeIds": [
        0
    ],
    "panStatus": "UNVERIFIED",
    "gstinStatus": "UNVERIFIED",
    "cinStatus": "UNVERIFIED",
    "businessTypes": [
        "ENTERPRISE"
    ],
    "bankVerifiedStatus": "UNVERIFIED",
    "companyOnBoardType": "CUSTOMER",
    "branchCodes": [
        "string"
    ],
    "branchNames": [
        "string"
    ],
    "costCentres": [
        "string"
    ],
    "branchCities": [
        "string"
    ],
    "branchStates": [
        "string"
    ],
    "utmSource": "string",
    "userGroupIds": [
        "string"
    ],
    "isMsme": true,
    "direction": "ASC",
    "bankApproval": "KOTAK_APPROVED",
    "bankApprovalStatus": "APPROVED",
    "kycFailureReason": "PAN_GSTIN_BANK_MISSING",
    "companyParentChildRelationIds": [
        "string"
    ],
    "company_id": "string",
    "parent_id": "string",
    "child_id": "string",
    "business_type": "ENTERPRISE",
    "company_type": "string",
    "tax_id_1": "string",
    "tax_id_2": "string",
    "cin": "string",
    "din": "string",
    "external_ref_no": "string",
    "risk_approval_status": "APPROVED",
    "status": "ACTIVE",
    "created_date_from": "2019-08-24T14:15:22Z",
    "created_date_to": "2019-08-24T14:15:22Z",
    "date_approved": "2019-08-24T14:15:22Z",
    "email": "string",
    "legal_name": "string",
    "branch_code": "string",
    "order_by": "string"
}'

Responses

🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object (GenericPaginationResponseCompanySearchResponse) 
optional
recordsCount
integer <int64>
optional
data
array[object (CompanySearchResponse) {26}] 
optional
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "recordsCount": 0,
        "data": [
            {
                "parentCompanyId": "string",
                "category": "A",
                "status": "ACTIVE",
                "emails": [
                    "string"
                ],
                "phone": "string",
                "kycDetailsSubmitted": true,
                "beneficiaryPan": "string",
                "beneficiaryGst": "string",
                "bankDetailApproved": true,
                "panStatus": "UNVERIFIED",
                "gstinStatus": "UNVERIFIED",
                "selfApproved": true,
                "companyParentChildRelationId": "string",
                "bankApprovalDetails": [
                    {
                        "bankApproval": "KOTAK_APPROVED",
                        "approvedOn": "2019-08-24T14:15:22Z",
                        "approvedBy": "string"
                    }
                ],
                "bankApprovalStatus": "APPROVED",
                "parent_legal_name": "string",
                "company_id": "string",
                "legal_name": "string",
                "business_type": "ENTERPRISE",
                "risk_approval_status": "APPROVED",
                "created_date": "2019-08-24T14:15:22Z",
                "tax_id_one": "string",
                "tax_id_two": "string",
                "bank_account_number": "string",
                "ifsc": "string",
                "date_modified": "2019-08-24T14:15:22Z"
            }
        ]
    }
}
Previous
Create Bulk Beneficiary
Next
Get Beneficiaries
Built with