Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Vendor Management
  • Explore Our Product Suite
  • Payment Gateway
    • Payment Gateway Overview
    • Getting Started
    • Payment Methods
    • Integration
    • API Endpoints
    • APIs
      • Authorisation
        • Get Authorization Token
      • Order
        • Create Order
        • Get Order Status
        • Get Order By Merchant Order Id
        • Get BNPL Payment Modes
        • Get Dynamic QR Code
        • UPI Intent Links
      • Payment
        • Submit Payment Detail
        • Get Transaction Status
        • Validate OTP
        • Resend OTP
        • Payment Notify Request
        • Get UPI Transaction Status
        • Verify VPA
      • Refund
        • Refund
      • Settlement
        • Settlement Reporting
        • Get Settlement Payout By ID
        • Search Settlement Payouts
      • Split Settlement
        • Create Split Settlement Account
        • Update Split Settlement Account
        • Get All Split Settlement Account
        • Deactivate Split Settlement Account
        • Activate Split Settlement Account
        • Submit Payment with Split Details
        • Edit/Deferred Split Settlement
      • E-Commerce Plugins
      • Payment Button
      • Qr Code
        • Create Qr Code
        • Get QR Code
        • Search QR Code
        • createCustomer
        • searchCustomer
        • Cancel QR Code
      • UPI Mandate
        • Create UPI Mandate
        • Update UPI Mandate
        • Revoke UPI Mandate
        • Get UPI Mandate
        • UPI mandate create callback
        • Mandate Pre-debit Notification
        • Execute mandate debit
        • Mandate Debit callback
      • Payment Links
        • Payment Links Overview
        • Payment Link APIs
        • Payment Link
          • Create Payment Link
          • Get Payment Link Details
          • Delete Payment Link
        • Payment Link Webhook
          • Payment Link Webhook Request
  • 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
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Balance
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Fetch Bank Statement
    • Webhook Data Apis
      • Get Webhook Data
      • Create Webhook Data
  • Prepaid Cards
    • About Prepaid Card
    • Key Capabilities
    • Getting Started
    • APIs
      • API Access & Authorization
      • Encryption & Decryption Guide
      • Auth Token
      • Create Card Account
      • Create Gift Card
      • Create Prepaid Card
      • Set Card PIN
      • Load Card Balance
      • Get Card Account Details
      • Generate Card OTP
      • View Card Details
      • Card Usage Controls
      • Get Card Usage Limits
      • Request Card Replacement
      • Block Card
      • Order Physical Card
      • Get Card Details
      • Get Transaction Details
      • Get All Transaction details
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • Invoice Payments
      • Invoice
        • Create Invoice
        • Confirm Invoice
        • Status Change Invoice
        • Edit Invoice
      • Payment
        • Pay Invoices
        • Payment Confirmation
      • Financing
        • Request Financing
        • Share Bid
        • Respond Bid
      • Onboarding
        • Register Check Entity
        • Search Entity
        • Register Entity
        • Registration Id
      • cdNote
        • Send CdNote Request
        • Confirm CdNote Request
        • Status Change CdNote Request
      • Purchase Order
        • Send Purchase Order Request
        • Confirm Purchase Order Request
        • Edit Purchase Order Request
        • Status Change Purchase Order Request
      • webhook-invoice
        • Webhook Create Invoice Request
        • Webhook Create Invoice Response
        • Webhook Confirm Invoice Request
        • Webhook Confirm Invoice Response
        • Webhook Status Change Invoice Request
        • Webhook Status Change Invoice Response
        • Webhook Edit Invoice Request
        • Webhook Edit Invoice Response
      • webhook-payments
        • Webhook Payment Request
        • Webhook Payment Confirmation Request
        • Webhook Payment Response
        • Webhook Payment Confirmation Response
      • webhook-business-onboarding
        • Webhook Check Entity Response
        • Webhook Register Entity Response
        • Webhook Search Entity Response
        • Webhook Registration Id Response
      • webhook-financing
        • Webhook Financing Response
        • Webhook Respond Bid Response
        • Webhook Share Bid Request
      • webhook-cdNote
        • Webhook Send CdNote Request
        • Webhook Send CdNote Response
        • Webhook Confirm CdNote Request
        • Webhook Confirm CdNote Response
        • Webhook Status Change CdNote Request
        • Webhook Status Change CdNote Response
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
        • Webhook Send Purchase Order Response
        • Webhook Confirm Purchase Order Request
        • Webhook Confirm Purchase Order Response
        • Webhook Edit Purchase Order Request
        • Webhook Edit Purchase Order Response
        • Webhook Status Change Purchase Order Request
        • Webhook Status Change Purchase Order Response
    • Bill Payments
      • Bill Payments Overview
      • Utility API Response Handling
      • Get Authentication Token
      • Get BillerTypes
      • Get Billers
      • Fetch Bill
      • Create Bill API
      • Create Bill Without Bill Fetch
      • Bill Payment
      • Utility Bill Approval API
      • Get Utility Bill Status
      • Get Utility Bill by Reference Id
      • Get Utility Bills Detail
      • Bill Payment Webhook
  • Accounts Payable
    • 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
        • initiate
        • Search Payouts V1
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
      • Payment Request
    • Update Beneficiary
      PUT
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • 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
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
      • Change Invoice Status Request
      • Bulk Create Invoice
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • About Authorization
    • Expenses
    • Advance
    • Token API
  • Rewards & Incentives
    • About Rewards
    • Getting Started
    • Encryption & Decryption Guide
    • Reward Allocation
    • Incentive Allocation
    • APIs
      • Token APIs
        • Authentication
        • Single Sign On (SSO)
      • Reward Allocation
        • Create And Allocate Points
        • Bulk Create And Allocate Rewards
        • Get Reward Account Details
        • Get Reward Transaction Details
        • Get User Details
        • Get User Card Details
      • Incentive Allocation
        • Incentive Create And Allocation
        • Get Incentive Transaction details
        • Get User Details
      • Redemption
        • User Authentication
        • Get Cart for User
        • Search Catalog
        • Get Product Catalog Details
        • Get Product Configs (Denominations)
        • Add to cart
        • Update Cart
        • Create Order
        • Order Search
        • create order
        • Fetch Order Info by Partner order Reference id
      • Point Management
        • Overview
        • Create Event
        • Get Event
        • Update Event
        • Allocate Coins
        • Get Balance
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
    • GSTN Verification
      • Gstin Verification
    • PAN Verification
      • Pan Verification
    • UPI(VPA) Verification
      • Vpa Verification
  1. Vendor Management

Update Bulk Vendors

PUT
/api/v0/beneficiary/bulk
Beneficiary Apis

Request

Query Params
companyOnBoardType
enum<string> 
optional
Allowed values:
CUSTOMERBENEFICIARY
Body Params application/json
array of:
emails
array[string]
optional
beneficiaryFailureReason
string 
optional
remarks
string 
optional
userGroupIds
array[string]
optional
recurringInvoiceDate
integer <int32>
optional
>= 1<= 31
recurringInvoice
boolean 
optional
recurringInvoiceAmount
number 
optional
>= 0.01<= 450000000
panId
integer <int64>
optional
gstinId
integer <int64>
optional
cinId
integer <int64>
optional
enterpriseType
string 
optional
enterpriseSubType
string 
optional
externalUniqueId
string 
optional
>= 0 characters<= 255 characters
pricingPlanId
string 
optional
msmeRegistrationDate
string <date>
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
utilityReferenceId
string 
optional
companySize
enum<string> 
optional
Allowed values:
TEN_PLUSTWENTY_FIVE_PLUSFIFTY_PLUSHUNDRED_PLUSTWO_HUNDRED_PLUSFIVE_HUNDRED_PLUSONE_THOUSAND_PLUS
additionalData
object 
optional
Additional properties
string 
optional
extRefCompanyId
string 
optional
whatsappOtp
boolean 
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
address_line_one
string 
optional
address_line_two
string 
optional
city
string 
optional
state
string 
optional
country
string 
optional
pin
string 
optional
phone
string 
optional
bank_account_number
string 
optional
ifsc
string 
optional
bank_name
string 
optional
branch_name
string 
optional
account_type
enum<string> 
optional
Allowed values:
CURRENTSAVINGSNONE
logo
string 
optional
category
enum<string> 
optional
Allowed values:
ABCDTAUTILITYFUELIATAOTHERSRENTALKASHFLOQUICK_RENT_PAY
din2
string 
optional
checksum
string 
optional
communication_switch
boolean 
optional
risk_approval_status
enum<string> 
optional
Allowed values:
APPROVEDPENDINGIN_PROGRESSBULK_UPLOADNEW
penny_verification_amount
number 
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
bt_surcharge
number 
optional
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
payout_cycle
enum<string> 
optional
Allowed values:
T0T1T2T3
status
enum<string> 
optional
Allowed values:
ACTIVEINACTIVEBLOCKEDLOCKED
branch_codes
array[string]
optional
Example
[
    {
        "emails": [
            "string"
        ],
        "beneficiaryFailureReason": "string",
        "remarks": "string",
        "userGroupIds": [
            "string"
        ],
        "recurringInvoiceDate": 1,
        "recurringInvoice": true,
        "recurringInvoiceAmount": 0.01,
        "panId": 0,
        "gstinId": 0,
        "cinId": 0,
        "enterpriseType": "string",
        "enterpriseSubType": "string",
        "externalUniqueId": "string",
        "pricingPlanId": "string",
        "msmeRegistrationDate": "2019-08-24",
        "acquiringBank": "AXIS_BANK",
        "acquiredBy": "string",
        "typeOfCustomer": "ON_US",
        "utilityReferenceId": "string",
        "companySize": "TEN_PLUS",
        "additionalData": {
            "property1": "string",
            "property2": "string"
        },
        "extRefCompanyId": "string",
        "whatsappOtp": true,
        "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",
        "address_line_one": "string",
        "address_line_two": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "pin": "string",
        "phone": "string",
        "bank_account_number": "string",
        "ifsc": "string",
        "bank_name": "string",
        "branch_name": "string",
        "account_type": "CURRENT",
        "logo": "string",
        "category": "A",
        "din2": "string",
        "checksum": "string",
        "communication_switch": true,
        "risk_approval_status": "APPROVED",
        "penny_verification_amount": 0,
        "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"
            }
        ],
        "bt_surcharge": 0,
        "source_region": "string",
        "source_person": "string",
        "source_city": "string",
        "override_rate": true,
        "program_admin_name": "string",
        "bankrate": 0,
        "cc_limit": 0,
        "billing_cycle": 0,
        "payout_cycle": "T0",
        "status": "ACTIVE",
        "branch_codes": [
            "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 PUT 'https://test.your-api-server.com/api/v0/beneficiary/bulk?companyOnBoardType' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "emails": [
            "string"
        ],
        "beneficiaryFailureReason": "string",
        "remarks": "string",
        "userGroupIds": [
            "string"
        ],
        "recurringInvoiceDate": 1,
        "recurringInvoice": true,
        "recurringInvoiceAmount": 0.01,
        "panId": 0,
        "gstinId": 0,
        "cinId": 0,
        "enterpriseType": "string",
        "enterpriseSubType": "string",
        "externalUniqueId": "string",
        "pricingPlanId": "string",
        "msmeRegistrationDate": "2019-08-24",
        "acquiringBank": "AXIS_BANK",
        "acquiredBy": "string",
        "typeOfCustomer": "ON_US",
        "utilityReferenceId": "string",
        "companySize": "TEN_PLUS",
        "additionalData": {
            "property1": "string",
            "property2": "string"
        },
        "extRefCompanyId": "string",
        "whatsappOtp": true,
        "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",
        "address_line_one": "string",
        "address_line_two": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "pin": "string",
        "phone": "string",
        "bank_account_number": "string",
        "ifsc": "string",
        "bank_name": "string",
        "branch_name": "string",
        "account_type": "CURRENT",
        "logo": "string",
        "category": "A",
        "din2": "string",
        "checksum": "string",
        "communication_switch": true,
        "risk_approval_status": "APPROVED",
        "penny_verification_amount": 0,
        "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"
            }
        ],
        "bt_surcharge": 0,
        "source_region": "string",
        "source_person": "string",
        "source_city": "string",
        "override_rate": true,
        "program_admin_name": "string",
        "bankrate": 0,
        "cc_limit": 0,
        "billing_cycle": 0,
        "payout_cycle": "T0",
        "status": "ACTIVE",
        "branch_codes": [
            "string"
        ]
    }
]'

Responses

🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object 
optional
Additional properties
object (CompanyModel) 
optional
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "property1": {
            "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"
        },
        "property2": {
            "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"
        }
    }
}
Previous
Create Bulk Vendors
Next
Get Beneficiaries (V1)
Built with