Create Bulk Vendors

POST

/api/v0/beneficiary/bulk

Request

Query Params

Body Params application/json

Example

[
    {
        "emails": [
            "string"
        ],
        "email": "string",
        "phone": "string",
        "beneficiaryFailureReason": "string",
        "userGroupIds": [
            "string"
        ],
        "recurringInvoiceDate": 1,
        "recurringInvoice": true,
        "recurringInvoiceAmount": 0.01,
        "skipVendorPanVerification": true,
        "skipVendorGstinVerification": true,
        "skipVendorPennyDropVerification": true,
        "panId": 0,
        "pennyDropId": 0,
        "gstinId": 0,
        "cinId": 0,
        "pricingPlanId": "string",
        "externalUniqueId": "string",
        "msmeRegistrationDate": "2019-08-24",
        "utmSource": "string",
        "acquiringBank": "AXIS_BANK",
        "acquiredBy": "string",
        "typeOfCustomer": "ON_US",
        "onlineVendorApproval": true,
        "utilityReferenceId": "string",
        "sendPaymentAdvice": true,
        "dealId": "string",
        "accountId": "string",
        "leadOwner": "string",
        "features": {
            "property1": "string",
            "property2": "string"
        },
        "primaryChannel": "string",
        "primaryProductCategory": "string",
        "primaryProduct": "string",
        "additionalData": {
            "property1": "string",
            "property2": "string"
        },
        "extRefCompanyId": "string",
        "msme": true,
        "company_id": "string",
        "legal_name": "string",
        "business_type": "ENTERPRISE",
        "category": "A",
        "tax_id_one": "string",
        "tax_id_two": "string",
        "website": "string",
        "cin": "string",
        "din": "string",
        "external_ref_no": "string",
        "bank_account_number": "string",
        "bank_name": "string",
        "ifsc": "string",
        "logo": "string",
        "account_type": "CURRENT",
        "communication_switch": true,
        "checksum": "string",
        "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"
            }
        ],
        "source_region": "string",
        "source_person": "string",
        "source_city": "string",
        "override_rate": true,
        "program_admin_name": "string",
        "bankrate": 0,
        "cc_limit": 0,
        "billing_cycle": 0,
        "company_on_board_type": "CUSTOMER",
        "branch_codes": [
            "string"
        ]
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test.your-api-server.com/api/v0/beneficiary/bulk?companyOnBoardType&partnerIntegration' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "emails": [
            "string"
        ],
        "email": "string",
        "phone": "string",
        "beneficiaryFailureReason": "string",
        "userGroupIds": [
            "string"
        ],
        "recurringInvoiceDate": 1,
        "recurringInvoice": true,
        "recurringInvoiceAmount": 0.01,
        "skipVendorPanVerification": true,
        "skipVendorGstinVerification": true,
        "skipVendorPennyDropVerification": true,
        "panId": 0,
        "pennyDropId": 0,
        "gstinId": 0,
        "cinId": 0,
        "pricingPlanId": "string",
        "externalUniqueId": "string",
        "msmeRegistrationDate": "2019-08-24",
        "utmSource": "string",
        "acquiringBank": "AXIS_BANK",
        "acquiredBy": "string",
        "typeOfCustomer": "ON_US",
        "onlineVendorApproval": true,
        "utilityReferenceId": "string",
        "sendPaymentAdvice": true,
        "dealId": "string",
        "accountId": "string",
        "leadOwner": "string",
        "features": {
            "property1": "string",
            "property2": "string"
        },
        "primaryChannel": "string",
        "primaryProductCategory": "string",
        "primaryProduct": "string",
        "additionalData": {
            "property1": "string",
            "property2": "string"
        },
        "extRefCompanyId": "string",
        "msme": true,
        "company_id": "string",
        "legal_name": "string",
        "business_type": "ENTERPRISE",
        "category": "A",
        "tax_id_one": "string",
        "tax_id_two": "string",
        "website": "string",
        "cin": "string",
        "din": "string",
        "external_ref_no": "string",
        "bank_account_number": "string",
        "bank_name": "string",
        "ifsc": "string",
        "logo": "string",
        "account_type": "CURRENT",
        "communication_switch": true,
        "checksum": "string",
        "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"
            }
        ],
        "source_region": "string",
        "source_person": "string",
        "source_city": "string",
        "override_rate": true,
        "program_admin_name": "string",
        "bankrate": 0,
        "cc_limit": 0,
        "billing_cycle": 0,
        "company_on_board_type": "CUSTOMER",
        "branch_codes": [
            "string"
        ]
    }
]'

Responses

🟢200OK

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "success_count": 0,
        "failure_count": 0,
        "total_count": 0,
        "total_amount": 0,
        "success_file_name": "string",
        "failure_file_name": "string",
        "successRequests": [
            {
                "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"
            }
        ],
        "failureRequests": [
            {
                "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"
            }
        ],
        "success_file_url": "string",
        "failure_file_url": "string"
    }
}

Modified at 2025-07-07 18:41:31

Create Vendor

Update Bulk Vendors