Batch Merchant

Overview

The Batch Merchant module provides comprehensive bulk merchant creation capabilities for onboarding multiple merchant accounts simultaneously through CSV file uploads and multi-stage configuration workflows. It offers real-time progress tracking, status monitoring, and detailed reporting for all merchant creation operations processed through the Juspay payment platform.

This module is designed for a wide range of users, including:

• Operations Teams: For creating multiple merchant accounts in bulk and monitoring merchant onboarding performance across different reseller types and configurations with comprehensive operational logs and audit trails.

• Reseller Management Teams: For bulk merchant account creation during partner onboarding, merchant provisioning, and tracking merchant creation operations across multiple business segments with detailed status reporting.

• System Administrators: To process bulk merchant creation requests, manage access control configurations, and provide accurate updates on merchant account creation status and system access activation.

Accessing the Module

1. Log in to the Juspay dashboard.

2. From the main navigation menu on the left, navigate to the batch operations section.

3. Select Batch Merchant from the available batch operation tabs.

4. You will see the "Batch Merchant History" interface displaying previously uploaded batch files.

5. Click "Create Batch Merchants" to initiate a new batch merchant creation process.

6. The navigation URL for this module is https://portal.juspay.in/batch/merchant.

Step-by-Step Usage Instructions

Creating Batch Merchant Operations

Step 1: Access the Batch Merchant Interface

1. Navigate to the Batch Merchant module using the steps above.

2. You will see the main "Batch Merchant History" dashboard displaying any previously uploaded batch merchant files in a table format.

3. The interface shows columns for File Name, Status, Queued Task, Failed Task, Success Task, Created At, Check Status, and Error File.

4. Files are displayed with status indicators: ACCEPTED (green) for successful processing.

Step 2: Initiate New Batch Merchant Creation

1. Click the "Create Batch Merchants" button (visible only to users with appropriate permissions).

2. The system will navigate to the "Batch Flow" configuration interface.

3. You will see a breadcrumb navigation: "Batch History → New Configuration".

Step 3: Multi-Stage Configuration Process

Stage Navigation Overview:

The batch merchant creation process involves multiple configuration stages depending on your reseller type:

For Axis Reseller Users:

1. Juspay Details - Basic merchant type configuration

2. Platform Details - Platform type selection

3. Access Control - Role and permission management

4. Client Configuration - SDK and platform-specific settings

For Standard Reseller Users:

1. Access Control - Role and permission management only

Step 4: Configure Access Control Stage

Step 5: Submit Configuration and Upload CSV File

1. Click the "Submit" button to proceed to the CSV upload interface.

2. The system will open the "Upload CSV File" modal with detailed instructions and upload interface.

Step 6: Prepare and Upload CSV File

Step 7: File Processing and Validation

Step 8: Monitor Processing Status

Monitoring and Managing Batch Merchant Operations

Viewing Batch Merchant Details

Individual Merchant Records View

Search and Filter Capabilities

Data Export and Download

Downloading Processed Data

CSV File Upload Specifications

CSV Field Requirements

Merchant Creation Validation Rules

Merchant ID Requirements:

• Format: Must be 4-16 alphanumeric characters only

• Uniqueness: Merchant ID must be unique across the system

• Characters: No special characters allowed

• Length: Minimum 4 characters, maximum 16 characters

• Existence: System checks for existing merchant IDs to prevent duplicates

Email Requirements:

• Format: Must follow valid email format (user@domain.com)

• Uniqueness: Email address must be unique across the system

• Domain Validation: Email domain must be valid and accessible

• Length: Standard email length limitations apply

• Existence: System checks for existing email addresses

Country Requirements:

• Format: Must be a valid country code (e.g., IND, USA, GBR)

• Validation: Country code must exist in the system's country configuration

• Case Sensitivity: Country codes are case-sensitive

• Standard: Follows ISO country code standards

Optional Field Requirements:

• Boolean Fields: enableRefund and mustUseGivenOrderIdForTxn must be "true" or "false" when provided

• Mobile Format: Must include country code and follow international phone number format

• URL Format: returnUrl must be a valid HTTP/HTTPS URL when provided

• Industry: Must match predefined industry classifications (defaults to "Others" if empty)

• MCC: merchantCategoryCode must be a valid merchant category code when provided

Merchant Creation Processing Logic

Eligibility Criteria:

• Unique Identifiers: Merchant ID and email must be unique in the system

• Configuration Validation: Access control configuration must be properly set

• System Capacity: Merchant creation depends on system capacity and limitations

• Permission Validation: User must have appropriate permissions for merchant creation

Processing Sequence:

1. Configuration Validation: Verify access control settings and permissions

2. CSV Validation: Validate all mandatory fields and data format compliance

3. Uniqueness Check: Validate merchant ID and email uniqueness

4. Queue Management: Add merchant creation requests to processing queue

5. Account Creation: Create merchant account with specified details and configuration

6. Permission Assignment: Apply access control settings to the merchant account

7. Status Update: Update merchant creation status based on processing result

8. Activation: Activate merchant account for system access

Merchant Creation Behavior:

• Account Setup: Complete merchant account creation with all specified details

• Access Control: Apply configured permissions for different modules

• Configuration Application: Set up merchant with specified optional parameters

• Notification: System may send account creation notifications to merchants

CSV Format Examples

Complete CSV Format with Sample Data:

CSV Format with Minimal Required Fields:

File Upload Constraints

• Maximum Rows: 1000 entries per CSV file

• File Format: CSV (Comma Separated Values) only with .csv extension

• Encoding: UTF-8 encoding recommended

• File Size: Standard file size limitations apply

• Column Order: Must match the specified header format exactly

• Required Fields: First four fields (merchantId, merchantName, email, country) are mandatory and cannot be empty

• Optional Fields: Optional fields can be left empty but column structure must be maintained

• Data Consistency: All entries must follow the same data format standards

• Duplicate Prevention: Avoid duplicate merchantId or email entries within the same file

Use Cases

New Partner Onboarding

1. Export new partner merchant data from partner management systems with required merchant information

2. Configure access control settings for the partner's merchant accounts

3. Prepare CSV file with merchant IDs, business names, email addresses, and appropriate configurations

4. Upload file through Batch Merchant interface for immediate processing

5. Monitor merchant creation status and download results for partner confirmation and system access setup

Reseller Merchant Provisioning

1. Identify merchants that need system access for new reseller partnerships or business expansion

2. Configure appropriate access control settings for different merchant types and business requirements

3. Compile list of affected merchants with specific permission assignments and access levels

4. Upload merchant creation file with defined access control configurations and business parameters

5. Track individual merchant creation status and automatic account activation

Seasonal Business Expansion

1. Set up seasonal merchant accounts for temporary business partnerships or project-based access requirements

2. Configure appropriate access control settings for temporary merchant accounts

3. Create CSV files with merchant details and appropriate temporary business configurations

4. Upload merchant creation files for automated processing during specified business periods

5. Monitor merchant creation success rates and manage system access provisioning

Troubleshooting

File Upload Validation Errors:

• "Invalid file format": Ensure file is in CSV format with .csv extension and proper comma separation

• "Missing mandatory fields": Verify that merchantId, merchantName, email, and country columns are present and not empty

• "Row limit exceeded": Reduce file size to maximum 1000 entries per upload

• "Invalid data type": Check that all fields contain appropriate string values in correct format

• "Invalid email format": Ensure email field follows valid email format (user@domain.com)

• "Invalid merchant ID format": Verify merchant ID is 4-16 alphanumeric characters with no special characters

• "Merchant ID already exists": Verify that merchant IDs are unique and not already present in the system

• "Email already exists": Ensure email addresses are unique and not already registered in the system

• "Invalid country code": Check that country values match valid country codes (IND, USA, GBR, etc.)

Permissions and Roles

Access to the Batch Merchant module is controlled by the following permissions:

• Merchant Module Access: Required for accessing the batch merchant interface (ACL: merchants)

• Batch Create Merchants Permission: Required for creating and uploading batch merchant files (ACL: batch_create_merchants)

• Merchant Creation Access: Required for performing bulk merchant creation operations (ACL: merchants)

• Access Control Configuration: Required for configuring merchant access permissions and module settings

• Reseller Management Permission: Required for reseller-specific merchant creation and configuration (ACL: reseller)