EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Beneficiary Apis
  • EnKash APIs
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment APIs
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • Order Overview
      • About Order
      • Create Order
      • Get Order Status
      • Get BNPL Payment Modes
    • Payments
      • Payment Overview
      • About Payment
      • Get Transaction Status
      • Submit Payment Detail
    • Refunds
      • About Refund
      • Refund
    • Payment Links
      • Upi Intent Link Detail
    • Settlements
      • About Settlement
      • Get Settlement Payout By Id
      • Search Settlement Payouts
    • QR Generation API
      • Get Dynamic QR Code
    • Payment Button
    • Qr Code
      • Create QR
      • Create QR Customer
      • Search QR Code
      • Get QR Code
      • Cancel QR Code
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payouts Integration Steps
    • Ecrypting and Decrypting Payload
    • 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 Source Bank Account Details
      • Add Source Bank Account
      • Get Balance
  • Account Payables
    • Accounts Payable Overview
    • Vendor Management
      • Beneficiary Apis
        • Update Beneficiary
          PUT
        • Create Beneficiary
          POST
        • Update Bulk Beneficiary
          PUT
        • Create Bulk Beneficiary
          POST
        • Get Beneficiaries V1
          POST
        • Get Beneficiaries
          POST
        • Change beneficiary status
          PATCH
        • Get Beneficiary
          GET
    • Invoice Management
      • Payout Apis
        • Search Payouts V1
        • initiate
        • validateInvoices
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • createCustomer
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • searchCustomer
        • 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
  • Loyalty
    • Loyalty Overview
    • Sign Up - Loyalty
    • Use Cases
    • Reward APIs
    • Authorization
      • SSO LOGIN
      • Client Authentication
    • Employee R&R
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • Channel Incentives
      • Create And Allocate point
      • Get Transaction details
      • Get User Details
    • brand loyalty
      • Get Coin Event
      • Create Coin Event Configuration
      • Update Coin Event Configuration
      • Allocate Coins to User
    • Voucher Processing
      • Get Cart for User
      • Add to cart
      • Update Cart
      • Order Search
      • Get Order Details
      • Create Order
    • Voucher Catalog
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
  • Corporate Cards
    • Corporate Cards Overview
    • Sign Up - Corporate Cards
    • Corporate Cards Integration Steps
    • Authorization
      • Get Authorization Token
    • Meal Cards
      • Card APIs
        • Create Card
        • View Card
        • Set Pin Card
        • Search Cards
        • Replace Card
        • Physical Card
        • Block Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
    • Fuel Cards
      • Card APIs
        • Create Card
        • Search Cards
        • View Card
        • Block Card
        • Physical Card
        • Set Pin Card
        • Replace Card
        • Update Card balance
      • CardControls
        • Update Card Velocity Rules
        • Get Card Velocity Rules
      • Transactions
        • Get Card Transactions
      • Account
        • Get Card Account
        • Create Card Account
      • Generate Otp Card
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
    • GSTN Verification
    • PAN Verification
    • UPI(VPA) Verification
  • Payout Data Apis
  • Beneficiary Apis
  • tiny-url-controller
  • test-controller
  • company-category-limits-controller
  • bank-holiday-controller
  • Authentication Apis
  • utility-payment-controller-v-1
  • user-controller-v-1
  • Payout Apis
  • gst-payment-controller
  • biller-controller-v-1
  • Virtual Account Apis
  • Vendor Payment Entry Controller
  • Utm Based Config Apis
  • User Apis
  • User Group Apis
  • axis-nodal-controller-v-1
  • icici-nodal-controller
  • axis-nodal-controller
  • subscription-controller
  • Sign Up API's
  • sftp-detail-controller
  • sanction-screening-controller
  • risk-check-controller
  • Reward Page Notification Apis
  • refund-transaction-controller
  • purchase-order-controller
  • Pricing Plan
  • Pre Qualification Apis
  • Pg Balance Apis
  • Payout Transaction Apis
  • payment-request-controller
  • Payment Gateway Apis
  • pay-by-link-controller
  • Partner Integration Apis
  • outstanding-amount-controller
  • otp-controller
  • OnBoarding Config Apis
  • Nudge Apis
  • Multi Factor Auth Apis
  • mail-callback-controller
  • M2P Apis
  • anchor-partner-api-controller
  • amazon-sn-s-notification-controller
  • Karza Controller
  • Instant Payout Apis
  • ICICI Connected Banking Apis
  • gstin-data-controller
  • Generate Pdf APIs
  • fin-bit-controller
  • File Store Apis
  • file-transfer-controller
  • feedback-controller
  • Fd Payment Histories
  • Favorite Api
  • Expense Product Apis
  • equifax-controller
  • Encryption Apis
  • early-payment-offer-controller
  • Document
  • digital-signature-controller
  • digital-locker-controller
  • Credit Provider Risk Check API
  • credit-provider-detail-controller
  • Config Apis
  • company-pg-controller
  • company-branch-code-controller
  • communication-controller
  • Chat Bot Apis
  • card-token-controller
  • Card Product Master Apis
  • card-product-controller
  • Card Application Memo Apis
  • Card Application Apis
  • CardAccountTenant Apis
  • Card Account Addition Mapping Apis
  • Cam Automation Apis
  • bulk-file-detail-controller
  • bulk-file-data-controller
  • Bill Payment Apis
  • Company Biller Apis
  • Beneficiary Detail Apis
  • Bbps Complaint Management Apis
  • Bank IFSC
  • Bank Detail Apis
  • Bank Card Controller
  • AWS Secret Manager Properties Apis
  • Authority Apis
  • Anchor Detail Apis
  • penny-drop-controller
  • Mobile Otp Apis
  • Mobile Authentication Apis
  • oauth-client-detail-controller
  • url-generator-controller
  • Health Check Apis
  • Single Sign On Apis
  • Bulk Upload Sample File Apis
  • credit-policy-controller
  • Payout Logs
  • Help Apis
  • Geo Location Controller
  1. Beneficiary Apis

Create Bulk Beneficiary

POST
/api/v0/beneficiary/bulk
Beneficiary Apis

Request

Query Params
companyOnBoardType
enum<string> 
optional
Allowed values:
CUSTOMERBENEFICIARY
partnerIntegration
enum<string> 
optional
Allowed values:
TALLYENKASHENKASH_INVOICE
Body Params application/json
array of:
emails
array[string]
optional
Email of bene
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
[
    {
        "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 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 '/api/v0/beneficiary/bulk' \
--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
response_code
integer <int32>
optional
response_message
string 
optional
payload
object (BulkResponseCompanyModel) 
optional
success_count
integer <int32>
optional
failure_count
integer <int32>
optional
total_count
integer <int32>
optional
total_amount
number 
optional
success_file_name
string 
optional
failure_file_name
string 
optional
successRequests
array[object (CompanyModel) {103}] 
optional
failureRequests
array[object (CompanyModel) {103}] 
optional
success_file_url
string 
optional
failure_file_url
string 
optional
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
                    },
                    "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
            }
        ],
        "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
                    },
                    "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
            }
        ],
        "success_file_url": "string",
        "failure_file_url": "string"
    }
}
Previous
Update Bulk Beneficiary
Next
Get Beneficiaries V1
Built with