Enkash Developer Portal
Home
Home
Login
  1. Vendor Management
  • Back to home
  • Accounts Payable APIs
  • Invoice Management
    • validateInvoices
    • initiate
    • Search Payouts V1
    • bulkCreatePayout
    • Create Payout
    • Update Payouts
    • Search Payouts
    • createBulkPayoutForPartnerIntegration
    • Update Approval Status
    • Update Bulk Payouts
    • Get Invoice Data
    • Delete Payout
    • Confirm Invoice Request
  • Vendor Management
    • Create Vendor
      POST
    • Create Bulk Vendors
      POST
    • Update Bulk Vendors
      PUT
    • Get Beneficiaries (V1)
      POST
    • Get Beneficiaries
      POST
    • Change Vendor Status
      PATCH
    • Get Beneficiary
      GET
  • Payment
    • Payment Request
    • Update Beneficiary
  1. Vendor Management

Get Beneficiary

GET
/api/v0/beneficiary/{companyId}

Request

Path Params
companyId
string 
required
Query Params
companyOnBoardType
enum<string> 
optional
Allowed values:
CUSTOMERBENEFICIARY
Default:
BENEFICIARY
userGroupReqd
boolean 
optional
Default:
false

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 GET 'https://test.your-api-server.com/api/v0/beneficiary/'

Responses

🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object (CompanyModel) 
optional
kycDetailsSubmitted
boolean 
optional
bankDetailVerified
boolean 
optional
city
string 
optional
state
string 
optional
country
string 
optional
pin
string 
optional
emails
array[string]
optional
phone
string 
optional
status
enum<string> 
optional
Allowed values:
ACTIVEINACTIVEBLOCKEDLOCKED
ifsc
string 
optional
logo
string 
optional
parentPhone
string 
optional
parentCompanyId
string 
optional
category
enum<string> 
optional
Allowed values:
ABCDTAUTILITYFUELIATAOTHERSRENTALKASHFLOQUICK_RENT_PAY
bankRate
number 
optional
kycDocumentData
object (KycVerificationModel) 
optional
documents
array[string]
optional
Allowed values:
INVOICEGST_CHALLANGSTINPANAADHARPASSPORTBANK_ACCOUNTUTILITY_BILLBILLER_DOCCOMPANY_LOGOCINADDRESS_PROOFACCOUNT_AGGREGATION_BANK_STATEMENT_REPORTENKASH_REVIEWED_DIGITAL_CONTRACT_FINAL_SIGNEDENKASH_REVIEWED_DIGITAL_CONTRACT_FINAL_DSC_SIGNEDENKASH_REVIEWED_DIGITAL_CONTRACT_AUDIT_CERTIFICATECREDIT_GUARANTOR_PROOFID_PROOFSELFIE_PROOFSIGNATURE_PROOFBOARD_RESOLUTION_PROOFBANK_STATEMENT_PROOFINCOME_TAX_RETURN_PROOFINCOME_TAX_ADDITIONAL_FILESCOMPANY_PAS_FORMPERSONAL_VERIFICATION_VIDEOCOMPANY_ID_PROOFCOMPANY_ADDRESS_PROOFCOMPANY_ADDRESS_PROOF_2SECURITY_DEPOSITAADHAAR_XMLAADHAAR_IMAGEPASSPORT_FRONTPASSPORT_BACKLETTERSCOMMENCEMENT_OF_BUSINESSCONSTITUTIONAL_AGREEMENTKYC_POIKYC_POACERTIFIED_COPY_OF_MEMORANDUMARTICLES_OF_ASSOCIATION_OF_THE_COMPANYPOWER_OF_ATTORNEYSHAREHOLDING_STRUCTURE_OF_COMPANYAADHAAR_IMAGE_FRONTAADHAAR_IMAGE_BACKMEMO_ATTACHMENTGSTIN_DATA_REPORT_EXCELGSTIN_DATA_REPORT_PDFGSTIN_WITH_OTPCOMPANY_PANPARTNER_PANDIRECTOR_PANLAST_TWO_YEARS_AUDITED_FINANCIALSDEBT_LOAN_PROFILEPROVISIONAL_FINANCIALS_OF_LAST_YEARCOMPANY_PROFILE_AND_BUSINESS_MODELWHOLE_TIME_DIRECTORS_PARTNERS_PROFILEECLGS_LOAN_ACCOUNT_STATEMENTMORATORIUM_PAYMENT_CONFIRMATIONPARTNERSHIP_DEEDTRUST_DEEDLLP_CERTIFICATELLP_CONSTITUTIONAL_AGREEMENTBOARD_RESOLUTION_PARTNERS_SHAREHOLDINGDIRECTORS_SHAREHOLDINGPROPRIETOR_PANANCHOR_DATAPARTNERSHIP_PANUDYAM_CERTIFICATEMCA_DOCSFUNDING_BALANCES_STATEMENT_AS_ON_LAST_MONTHLAST_SIX_MONTHS_OPERATING_BANK_STATEMENTSPAN_POIBANK_DETAILSCERTIFICATE_OF_INCORPORATIONCERTIFIED_COPY_OF_MEMORANDUM_OF_ASSOCIATIONCERTIFIED_COPY_ARTICLES_OF_ASSOCIATION_OF_THE_COMPANYCREDIT_CARD_APPLICATION_FORMSYSTEM_GENERATED_DIGITAL_CONTRACTENKASH_REVIEWED_DIGITAL_CONTRACTCARD_APPLICATION_FORMCOMPANY_PROOFPOA_SELF_ATTESTEDLIST_OF_PARTNERS_WITH_PAN_NUMBERSPOWER_OF_BY_GRANTED_TO_ITS_MANAGERSREGISTRATION_CERTIFICATERESOLUTION_FROM_THE_BOARD_OF_DIRECTORS_OF_COMPANYDIRECTORS_WITH_THEIR_RESIDENTIAL_ADDRESSESBOARD_RESOLUTION_DIRECTORS_SHAREHOLDINGPARTNERSHIP_DECLARATION_LETTERSANCTION_APPROVALAPPLICATION_LIMIT_APPROVALOWNERSHIP_PROOFCPV_REPORTPROBE_42_REPORTENACH_PHYSICAL_NACH_PDCAGREEMENT_OF_ANCHOR_PARTNER_DSACONSENT_TO_SHARE_DATA_DOCS_OF_CLIENTSMAX_FUNDING_CAPVIDEO_PDOTHERSLIMIT_REQUEST_LETTERFIXED_DEPOSIT_RECEIPTCARD_AGREEMENTCORPORATE_APPLICATION_FORMVERIFICATION_FORM_OF_AUTHORIZED_SIGNATORIESMASTER_SERVICE_AGREEMENTAUTHORIZED_SIGNATORY_PANLIST_OF_DIRECTORSSANCTION_LETTERAUTHORIZATION_LETTER_DIRECTORSBOARD_RESOLUTIONGST_CERTIFICATELIST_OF_PARTNERSAU_CARD_APPLICATIONBUSINESS_CATEGORY_DOCUMENTCAMSYSTEM_GENERATED_CAMBUREAU_REPORTREFUND_TRANSACTIONPROPOSAL_LETTERDIRECTOR_SANCTION_SCREENING_REPORTCOMPANY_SANCTION_SCREENING_REPORT
branchCodes
string 
optional
approvals
string 
optional
payableVirtualAccount
string 
optional
payableVirtualIfsc
string 
optional
bankDetails
array[object (BankDetailModel) {14}] 
optional
beneficiaryCode
string 
optional
pgNameOfCP
string 
optional
address
string 
optional
bankDetailId
string 
optional
userGroups
array[object (UserGroupResponse) {6}] 
optional
billPayAgency
enum<string> 
optional
Allowed values:
MKBASSBEWHMETWFPCSAXT1T2T3IN
recurringInvoiceDate
integer <int32>
optional
recurringInvoiceNextDate
string <date>
optional
recurringInvoice
boolean 
optional
recurringInvoiceAmount
number 
optional
utmSource
string 
optional
enterpriseType
string 
optional
enterpriseSubType
string 
optional
pricingPlan
object (PricingPlanDTO) 
optional
warnings
array[string]
optional
externalUniqueId
string 
optional
msmeRegistrationDate
string <date>
optional
failureReason
string 
optional
partnerId
string 
optional
acquiringBank
object (EnumModel) 
optional
acquiredBy
string 
optional
typeOfCustomer
object (EnumModel) 
optional
utilityReferenceId
string 
optional
sendPaymentAdvice
boolean 
optional
dealId
string 
optional
primaryChannel
string 
optional
primaryProductCategory
string 
optional
primaryProduct
string 
optional
companySize
object (EnumModel) 
optional
bankApprovalStatus
enum<string> 
optional
Allowed values:
APPROVEDPENDINGREJECTED
kycFailureReason
array[string]
optional
additionalData
object 
optional
extRefCompanyId
string 
optional
outstandingAmount
number 
optional
msme
boolean 
optional
parent_id
string 
optional
company_id
string 
optional
legal_name
string 
optional
business_type
enum<string> 
optional
Allowed values:
ENTERPRISECREDIT_PROVIDERVENDORSOCIETYAGENCY
company_type
string 
optional
tax_id_one
string 
optional
tax_id_two
string 
optional
website
string 
optional
cin
string 
optional
din
string 
optional
external_ref_no
string 
optional
source_region
string 
optional
source_person
string 
optional
source_city
string 
optional
risk_approval_status
enum<string> 
optional
Allowed values:
APPROVEDPENDINGIN_PROGRESSBULK_UPLOADNEW
created_date
string 
optional
approved_date
string 
optional
approved_by
string 
optional
modified_by
string 
read-onlyoptional
modified_date
string 
optional
address_line_one
string 
optional
address_line_two
string 
optional
bank_account_number
string 
optional
bank_name
string 
optional
branch_name
string 
optional
account_type
enum<string> 
optional
Allowed values:
CURRENTSAVINGSNONE
payout_cycle
enum<string> 
optional
Allowed values:
T0T1T2T3
pg
array[object (PgModel) {10}] 
optional
prepaid_balance
number 
optional
company_logo
string 
optional
parent_email
string 
optional
parent_legal_name
string 
optional
bt_surcharge
number 
optional
override_rate
boolean 
optional
program_admin_name
string 
optional
cc_limit
number 
optional
billing_cycle
integer <int32>
optional
communication_switch
boolean 
optional
penny_drop_data
object (PennyDropModel) 
optional
penny_flag
boolean 
optional
state_code
string 
optional
name_matching_score
number 
optional
proprietor_name_matching_type
enum<string> 
optional
Allowed values:
NONESURNAMEEXACT
proprietor_name_match_count
integer <int32>
optional
auto_approved
boolean 
optional
available_category_limit
number 
optional
nbbl_b2b_id
string 
optional
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "kycDetailsSubmitted": true,
        "bankDetailVerified": true,
        "city": "string",
        "state": "string",
        "country": "string",
        "pin": "string",
        "emails": [
            "string"
        ],
        "phone": "string",
        "status": "ACTIVE",
        "ifsc": "string",
        "logo": "string",
        "parentPhone": "string",
        "parentCompanyId": "string",
        "category": "A",
        "bankRate": 0,
        "kycDocumentData": {
            "panModel": {
                "pan": "string",
                "status": "UNVERIFIED",
                "name": "string",
                "firstName": "string",
                "middleName": "string",
                "lastName": "string",
                "failureReason": "string",
                "id": 0,
                "dob": "string"
            },
            "gstinModel": {
                "gstin": "string",
                "status": "UNVERIFIED",
                "legalNameOfBusiness": "string",
                "tradeName": "string",
                "companyName": "string",
                "centreJurisdiction": "string",
                "stateJurisdiction": "string",
                "dateOfRegistration": "2019-08-24",
                "constitutionOfBusiness": "string",
                "taxPayerType": "string",
                "gstinStatus": "string",
                "dateOfCancellation": "2019-08-24",
                "dateOfLastUpdated": "2019-08-24",
                "natureOfBusinessActivities": [
                    "string"
                ],
                "natureOfBusinessActivitiesString": "string",
                "proprietors": [
                    "string"
                ],
                "division": "string",
                "segment": "string",
                "subSegment": "string",
                "fieldVisitConducted": "string",
                "address": "string",
                "email": "string",
                "mobile": "string",
                "id": 0,
                "aggregateTurnovers": [
                    {
                        "turnover": "string",
                        "financialYear": "string"
                    }
                ],
                "aggregateTurnover": "string",
                "aggregateTurnoverFinancialYear": "string",
                "aadhaarAuthenticated": true,
                "transactionDelays": [
                    {
                        "returnYearMonth": "string",
                        "revisedDueDateOfFiling": "string",
                        "dateOfFiling": "string",
                        "noOfDaysOfDelay": 0,
                        "returnType": "string",
                        "arn": "string"
                    }
                ],
                "parsedName": "string",
                "pinCode": "string",
                "pan": "string",
                "vintageInYears": 0,
                "vintageInMonths": 0
            },
            "cinModel": {
                "cin": "string",
                "status": "UNVERIFIED",
                "companyName": "string",
                "listed": "string",
                "companyStatus": "string",
                "rocId": "string",
                "rocCode": "string",
                "registrationNumber": "string",
                "companyCategory": "string",
                "companySubCategory": "string",
                "classOfCompany": "string",
                "authorisedCapital": 0,
                "paidUpCapital": 0,
                "numberOfMembers": "string",
                "dateOfIncorporation": "2019-08-24",
                "registeredAddress": "string",
                "email": "string",
                "suspendedAtStockExchange": "string",
                "dateOfBalanceSheet": "2019-08-24",
                "dateOfLastAgm": "2019-08-24",
                "directors": [
                    {
                        "din": "string",
                        "name": "string",
                        "designation": "string",
                        "dateOfAppointment": "2019-08-24T14:15:22Z",
                        "dscRegistered": "string",
                        "dscExpiryDate": "string",
                        "address": "string",
                        "dateOfBirth": "2019-08-24T14:15:22Z",
                        "fatherName": "string"
                    }
                ]
            }
        },
        "documents": [
            "INVOICE"
        ],
        "branchCodes": "string",
        "approvals": "string",
        "payableVirtualAccount": "string",
        "payableVirtualIfsc": "string",
        "bankDetails": [
            {
                "id": 0,
                "bankDetailId": "string",
                "beneficiaryCode": "string",
                "accountNumber": "string",
                "ifsc": "string",
                "bankName": "string",
                "beneficiaryName": "string",
                "nodalAddition": true,
                "primaryBankDetail": true,
                "approved": true,
                "whitelisted": true,
                "whitelistDeleted": true,
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z"
            }
        ],
        "beneficiaryCode": "string",
        "pgNameOfCP": "string",
        "address": "string",
        "bankDetailId": "string",
        "userGroups": [
            {
                "userGroupId": "string",
                "company": {},
                "userGroupName": "string",
                "users": [
                    "string"
                ],
                "createdBy": "string",
                "modifiedBy": "string"
            }
        ],
        "billPayAgency": "MK",
        "recurringInvoiceDate": 0,
        "recurringInvoiceNextDate": "2019-08-24",
        "recurringInvoice": true,
        "recurringInvoiceAmount": 0,
        "utmSource": "string",
        "enterpriseType": "string",
        "enterpriseSubType": "string",
        "pricingPlan": {
            "pricingPlanId": "string",
            "planName": "string"
        },
        "warnings": [
            "string"
        ],
        "externalUniqueId": "string",
        "msmeRegistrationDate": "2019-08-24",
        "failureReason": "string",
        "partnerId": "string",
        "acquiringBank": {
            "name": {},
            "label": "string",
            "description": "string",
            "subModels": [
                {}
            ],
            "minValue": 0,
            "maxValue": 0
        },
        "acquiredBy": "string",
        "typeOfCustomer": {
            "name": {},
            "label": "string",
            "description": "string",
            "subModels": [
                {}
            ],
            "minValue": 0,
            "maxValue": 0
        },
        "utilityReferenceId": "string",
        "sendPaymentAdvice": true,
        "dealId": "string",
        "primaryChannel": "string",
        "primaryProductCategory": "string",
        "primaryProduct": "string",
        "companySize": {
            "name": {},
            "label": "string",
            "description": "string",
            "subModels": [
                {}
            ],
            "minValue": 0,
            "maxValue": 0
        },
        "bankApprovalStatus": "APPROVED",
        "kycFailureReason": [
            "string"
        ],
        "additionalData": {
            "property1": "string",
            "property2": "string"
        },
        "extRefCompanyId": "string",
        "outstandingAmount": 0,
        "msme": true,
        "parent_id": "string",
        "company_id": "string",
        "legal_name": "string",
        "business_type": "ENTERPRISE",
        "company_type": "string",
        "tax_id_one": "string",
        "tax_id_two": "string",
        "website": "string",
        "cin": "string",
        "din": "string",
        "external_ref_no": "string",
        "source_region": "string",
        "source_person": "string",
        "source_city": "string",
        "risk_approval_status": "APPROVED",
        "created_date": "string",
        "approved_date": "string",
        "approved_by": "string",
        "modified_by": "string",
        "modified_date": "string",
        "address_line_one": "string",
        "address_line_two": "string",
        "bank_account_number": "string",
        "bank_name": "string",
        "branch_name": "string",
        "account_type": "CURRENT",
        "payout_cycle": "T0",
        "pg": [
            {
                "pg_name": "string",
                "pg_code": "string",
                "pg_display_name": "string",
                "pg_priority": 0,
                "surcharge": 0,
                "surcharge_gst": 0,
                "mdr": 0,
                "mdr_gst": 0,
                "category": "string",
                "payout_cycle": "T0"
            }
        ],
        "prepaid_balance": 0,
        "company_logo": "string",
        "parent_email": "string",
        "parent_legal_name": "string",
        "bt_surcharge": 0,
        "override_rate": true,
        "program_admin_name": "string",
        "cc_limit": 0,
        "billing_cycle": 0,
        "communication_switch": true,
        "penny_drop_data": {
            "amount": 0,
            "remarks": "string",
            "rrn": "string",
            "status": "string",
            "bankName": "string",
            "id": 0,
            "transaction_id": "string",
            "request_type": "string",
            "beneficiary_account_number": "string",
            "beneficiary_ifsc": "string",
            "beneficiary_name": "string",
            "response_code": "string",
            "response_reason": "string"
        },
        "penny_flag": true,
        "state_code": "string",
        "name_matching_score": 0,
        "proprietor_name_matching_type": "NONE",
        "proprietor_name_match_count": 0,
        "auto_approved": true,
        "available_category_limit": 0,
        "nbbl_b2b_id": "string"
    }
}
Modified at 2025-07-07 18:41:31
Previous
Change Vendor Status
Next
Payment Request
Built with