- EnKash APIs
- Payment Gateway
- Payment Gateway Overview
- Payment Gateway Sign Up
- Payment Methods
- Supported Integrations
- Payment APIs
- Test Card Details
- Authorization
- Orders
- Payments
- Refunds
- Payment Links
- Settlements
- QR Generation API
- Payment Button
- Qr Code
- Payouts
- Account Payables
- Accounts Payable Overview
- Vendor Management
- Invoice Management
- Account Receivable
- Loyalty
- Expense Management
- Corporate Cards
- Verification Suite
- 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
Get Beneficiary
GET
/api/v0/beneficiary/{companyId}
Beneficiary Apis
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 '/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_LETTER
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
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
},
"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
}
}