Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Accounts Payable Management Tool
  2. Vendor Management
  • EnKash Developer Portal Overview
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment Gateway APIs
    • Web Integration
    • Server to Server Integration
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
        POST
    • Orders
      • About Order
      • Create Order
        POST
      • Get Order Status
        GET
      • Get BNPL Payment Modes
        GET
      • Get Dynamic QR Code
        GET
      • UPI Intent Links
        GET
    • Payments
      • About Payment
      • Submit Payment Detail
        POST
      • Get Transaction Status
        GET
      • Validate OTP
        POST
      • Resend OTP
        GET
      • Payment Notify Request
        POST
    • Refunds
      • About Refund
      • Refund
        POST
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
        GET
      • Search Settlement Payouts
        POST
    • Split Settlements
      • About Split Settlements
      • Create Split Settlement Account
        POST
      • Update Split Settlement Account
        POST
      • Get All Split Settlement Account
        GET
      • Deactivate Split Settlement Account
        PATCH
      • Activate Split Settlement Account
        PATCH
      • Submit Payment with Split Details
        POST
      • Edit/Deferred Split Settlement
        POST
    • E-Commerce Plugins
    • Payment Links
    • Payment Button
    • Qr Code
      • Create Qr Code
        POST
      • Get QR Code
        GET
      • Search QR Code
        POST
      • createCustomer
        POST
      • searchCustomer
        POST
      • Cancel QR Code
        PATCH
    • UPI Mandate
      • Create UPI Mandate
        POST
      • Update UPI Mandate
        PATCH
      • Revoke UPI Mandate
        PATCH
      • Get UPI Mandate
        GET
      • UPI mandate create callback
        POST
      • Mandate Pre-debit Notification
        POST
      • Execute mandate debit
        POST
      • Mandate Debit callback
        POST
  • Payment Links
    • Payment Links Overview
    • Payment Link APIs
    • Payment Link
      • Create Payment Link
        POST
      • Get Payment Link Details
        GET
      • Delete Payment Link
        DELETE
    • Payment Link Webhook
      • Payment Link Webhook Request
        POST
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
          POST
        • Confirm Invoice
          POST
        • Status Change Invoice
          POST
        • Edit Invoice
          POST
      • Payment
        • Pay Invoices
          POST
        • Payment Confirmation
          POST
      • Financing
        • Request Financing
          POST
        • Share Bid
          POST
        • Respond Bid
          POST
      • Onboarding
        • Register Check Entity
          POST
        • Search Entity
          POST
        • Register Entity
          POST
        • Registration Id
          POST
      • cdNote
        • Send CdNote Request
          POST
        • Confirm CdNote Request
          POST
        • Status Change CdNote Request
          POST
      • Purchase Order
        • Send Purchase Order Request
          POST
        • Confirm Purchase Order Request
          POST
        • Edit Purchase Order Request
          POST
        • Status Change Purchase Order Request
          POST
      • webhook-invoice
        • Webhook Create Invoice Request
          POST
        • Webhook Create Invoice Response
          POST
        • Webhook Confirm Invoice Request
          POST
        • Webhook Confirm Invoice Response
          POST
        • Webhook Status Change Invoice Request
          POST
        • Webhook Status Change Invoice Response
          POST
        • Webhook Edit Invoice Request
          POST
        • Webhook Edit Invoice Response
          POST
      • webhook-payments
        • Webhook Payment Request
          POST
        • Webhook Payment Confirmation Request
          POST
        • Webhook Payment Response
          POST
        • Webhook Payment Confirmation Response
          POST
      • webhook-business-onboarding
        • Webhook Check Entity Response
          POST
        • Webhook Register Entity Response
          POST
        • Webhook Search Entity Response
          POST
        • Webhook Registration Id Response
          POST
      • webhook-financing
        • Webhook Financing Response
          POST
        • Webhook Respond Bid Response
          POST
        • Webhook Share Bid Request
          POST
      • webhook-cdNote
        • Webhook Send CdNote Request
          POST
        • Webhook Send CdNote Response
          POST
        • Webhook Confirm CdNote Request
          POST
        • Webhook Confirm CdNote Response
          POST
        • Webhook Status Change CdNote Request
          POST
        • Webhook Status Change CdNote Response
          POST
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
          POST
        • Webhook Send Purchase Order Response
          POST
        • Webhook Confirm Purchase Order Request
          POST
        • Webhook Confirm Purchase Order Response
          POST
        • Webhook Edit Purchase Order Request
          POST
        • Webhook Edit Purchase Order Response
          POST
        • Webhook Status Change Purchase Order Request
          POST
        • Webhook Status Change Purchase Order Response
          POST
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
        POST
      • Get BillerTypes
        GET
      • Get Billers
        GET
      • Fetch Bill
        POST
      • Create Bill API
        POST
      • Create Bill Without Bill Fetch
        POST
      • Bill Payment
        POST
      • Utility Bill Approval API
        PUT
      • Get Utility Bill Status
        GET
      • Get Utility Bill by Reference Id
        GET
      • Get Utility Bills Detail
        POST
      • Bill Payment Webhook
        POST
  • Payouts
    • 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
    • Webhook Data Apis
      • Get Webhook Data
        GET
      • Create Webhook Data
        POST
  • Accounts Payable Management Tool
    • About AP Management Tool
    • 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
    • Invoice Management
      • Payout Apis
        • validateInvoices
          POST
        • initiate
          POST
        • Search Payouts V1
          POST
        • bulkCreatePayout
          POST
        • Create Payout
          POST
        • Update Payouts
          PATCH
        • Search Payouts
          POST
        • createBulkPayoutForPartnerIntegration
          POST
        • Update Bulk Payouts
          PATCH
        • Update Approval Status
          PATCH
        • Get Invoice Data
          GET
        • Delete Payout
          DELETE
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
        POST
      • Payment Request
        POST
    • Update Beneficiary
      PUT
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
        POST
    • Customer Management
      • Customer Apis
        • Activate customer
          PUT
        • createBulkCustomer
          POST
        • bulkUpdate
          POST
        • Deactivate customer
          PUT
        • deleteCustomerByCustomerId
          DELETE
        • updateCustomer
          PATCH
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
          GET
    • Invoice Management
      • invoice-controller
        • createInvoice
          POST
        • invoiceBulkUpload
          POST
        • Dispatch Invoice Collection
          POST
        • Delete Invoice Collection
          POST
        • searchCollectionInvoices
          POST
        • getInvoice
          GET
        • updateInvoice
          PATCH
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
          POST
        • getCustomerReminders
          POST
        • getCustomerReminder
          GET
        • deleteReminder
          DELETE
        • updateCustomerReminder
          PATCH
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
        POST
      • Change Invoice Status Request
        POST
      • Bulk Create Invoice
        POST
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
        POST
    • Expenses
      POST
    • Advance
      POST
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
          POST
        • SSO LOGIN (Single Sign On)
          POST
      • Create And Allocate point
        POST
      • Bulk Create And Allocate Points
        POST
      • Get Card Account Details
        POST
      • Get Transaction details
        POST
      • List Users Details
        POST
      • Get User Card Details
        POST
    • Channel Incentives
      • Incentive Create And Allocate point
        POST
      • Reward Get Transaction details
        POST
      • Incentive Get User Details
        POST
    • Points Redemption
      • User Authentication
        POST
      • Get Cart for User
        GET
      • Search Catalog
        POST
      • Get Product Catalog Details
        GET
      • Get Product Configs (Denominations)
        GET
      • Add to cart
        POST
      • Update Cart
        PATCH
      • Create Order
        POST
      • Order Search
        POST
      • create order
        POST
      • Fetch Order Info by Partner order Reference id
        POST
    • Point Management APIs
      • Overview
      • Create Event
        POST
      • Get Event
        GET
      • Update Event
        PATCH
      • Allocate Coins
        POST
      • Get Balance
        GET
  • Card Management
    • EnKash Card Management Systems Overview
    • Cards We Issue
    • API Reference
    • VKYC
    • Developer Guide
    • Cards Integration Steps
    • Encryption / Decryption of API requests / Response
    • Encryption & Decryption Guide
    • Token Api
      • Partner auth Token
        POST
    • Gift Card
      • Create
        POST
      • Request Physical
        POST
      • Block
        POST
      • Replace
        POST
      • Get User Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Meal Cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Request Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Prepaid Cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Request Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Fuel_cards
      • Create
        POST
      • Load Balance
        POST
      • Replace
        POST
      • Block
        POST
      • Physical
        POST
      • Get User Card Details
        POST
      • Get Transaction Details
        POST
      • Get All Transaction details
        POST
    • Advance Card Feature
      • Create Card Account
        POST
      • Set Pin
        POST
      • Get Card Account Details
        POST
      • Generate Otp Card
        POST
      • View Card
        POST
      • Update Card Velocity Rules
        POST
      • Get Card Velocity Rules
        POST
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
        POST
    • GSTN Verification
      • Gstin Verification
        GET
    • PAN Verification
      • Pan Verification
        GET
    • UPI(VPA) Verification
      • Vpa Verification
        POST
  1. Accounts Payable Management Tool
  2. Vendor Management

Create Vendor

POST
/api/v0/beneficiary
Beneficiary Apis

Request

Body Params application/json
emails
array[string]
optional
email
string 
optional
phone
string 
optional
beneficiaryFailureReason
string 
optional
userGroupIds
array[string]
optional
recurringInvoiceDate
integer <int32>
optional
>= 1<= 31
recurringInvoice
boolean 
optional
recurringInvoiceAmount
number 
optional
>= 0.01<= 450000000
skipVendorPanVerification
boolean 
optional
skipVendorGstinVerification
boolean 
optional
skipVendorPennyDropVerification
boolean 
optional
panId
integer <int64>
optional
pennyDropId
integer <int64>
optional
gstinId
integer <int64>
optional
cinId
integer <int64>
optional
pricingPlanId
string 
optional
externalUniqueId
string 
optional
>= 0 characters<= 255 characters
msmeRegistrationDate
string <date>
optional
utmSource
string 
optional
acquiringBank
enum<string> 
optional
Allowed values:
AXIS_BANKCITI_BANKHSBC_BANKHDFC_BANKSBIINDUSIND_BANKKOTAK_MAHINDRA_BANKRBL_BANKRAZORPAYICICI_BANKYES_BANKENKASHSBM_BANKPOS_MACHINE
acquiredBy
string 
optional
typeOfCustomer
enum<string> 
optional
Allowed values:
ON_USOFF_USCAPOS_MACHINE
onlineVendorApproval
boolean 
optional
utilityReferenceId
string 
optional
sendPaymentAdvice
boolean 
optional
dealId
string 
optional
accountId
string 
optional
leadOwner
string 
optional
features
object 
optional
Additional properties
string 
optional
primaryChannel
string 
optional
primaryProductCategory
string 
optional
primaryProduct
string 
optional
additionalData
object 
optional
Additional properties
string 
optional
extRefCompanyId
string 
optional
msme
boolean 
optional
company_id
string 
optional
legal_name
string 
required
business_type
enum<string> 
optional
Allowed values:
ENTERPRISECREDIT_PROVIDERVENDORSOCIETYAGENCY
category
enum<string> 
optional
Allowed values:
ABCDTAUTILITYFUELIATAOTHERSRENTALKASHFLOQUICK_RENT_PAY
tax_id_one
string 
optional
tax_id_two
string 
optional
website
string 
optional
cin
string 
optional
din
string 
optional
external_ref_no
string 
optional
>= 0 characters<= 255 characters
bank_account_number
string 
optional
bank_name
string 
optional
ifsc
string 
optional
logo
string 
optional
account_type
enum<string> 
optional
Allowed values:
CURRENTSAVINGSNONE
communication_switch
boolean 
optional
checksum
string 
optional
pg
array[object (PgModel) {10}] 
optional
pg_name
string 
optional
pg_code
string 
optional
pg_display_name
string 
optional
pg_priority
integer <int32>
optional
surcharge
number 
optional
surcharge_gst
number 
optional
mdr
number 
optional
mdr_gst
number 
optional
category
string 
optional
payout_cycle
enum<string> 
optional
Allowed values:
T0T1T2T3
source_region
string 
optional
source_person
string 
optional
source_city
string 
optional
override_rate
boolean 
optional
program_admin_name
string 
optional
bankrate
number 
optional
cc_limit
number 
optional
billing_cycle
integer <int32>
optional
company_on_board_type
enum<string> 
optional
Allowed values:
CUSTOMERBENEFICIARY
branch_codes
array[string]
optional
Example

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' \
--header 'Content-Type: application/json' \
--data-raw ''

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-03-05 05:38:16
Previous
About AP Management Tool
Next
Create Bulk Vendors
Built with