JUSPAY Unified Dashboard

Batch Resume

Overview

The Batch Resume module provides comprehensive bulk mandate resume capabilities for reactivating multiple paused mandate operations simultaneously through CSV file uploads. It offers real-time progress tracking, status monitoring, and detailed reporting for all mandate resume operations processed through the Juspay payment platform.

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

  • Operations Teams: For resuming paused mandate operations in bulk and monitoring resume processing performance across different payment methods and gateways with comprehensive operational logs.

  • Finance Teams: For bulk mandate resume processing, payment reactivation control, and tracking resume operations across multiple paused transactions with detailed audit trails.

  • Customer Support: To process customer mandate resume requests in bulk, track resume status, and provide accurate updates to customers on mandate resume processing and reactivation.

Accessing the Module

  1. Log in to the Juspay dashboard.

  2. From the main navigation menu on the left, click on Payments.

  3. Select Bulk Operations from the Payments submenu.

  4. Click on the Mandates tab from the bulk operations navigation.

  5. Select Batch Resume from the mandate operations dropdown.

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

Batch Resume
Batch Resume

Step-by-Step Usage Instructions

Creating Batch Resume Operations

Step 1: Access the Batch Resume Interface

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

  2. You will see the main dashboard with a description: "This module helps in resuming paused mandates in bulk using a file upload. It provides a holistic view of the files uploaded. Upon clicking the filename in the table below a detailed view of each mandate resume uploaded is displayed."

  3. The interface displays any previously uploaded batch resume files in a table format.

Step 2: Initiate New Batch Resume Upload

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

  2. If maker-checker workflow is enabled for your account, you will first see a description modal:

    • Enter a description for the batch resume request in the text field.

    • Click "Submit" to proceed to the file upload interface.

  3. If maker-checker is not enabled, you will directly access the file upload interface.

Batch Resume
Batch Resume

Step 3: Prepare and Upload CSV File

  1. Download Sample File: Click on the sample file link to download the CSV template (batch_resume_sample.csv).

  2. Prepare Your Data: Fill in your resume data following the CSV field specifications (see table below).

  3. File Limitations:

    • Maximum 1000 rows per file

    • CSV format only

    • File size limitations apply

  4. Upload Process:

    • Click "Choose File" or drag and drop your CSV file

    • The system validates the file format and structure

    • Mandatory fields are checked (Mandate ID)

    • Optional date field is validated (Resume Date)

    • Column types are validated (Mandate ID as String, Date in proper format)

Step 4: File Processing and Validation

  1. File Validation: The system performs the following checks:

    • CSV format validation

    • Mandatory field presence (mandate_id)

    • Data type validation for each column

    • Mandate ID validation (must be valid string identifier)

    • Date format validation for optional resume date field

    • Row count validation (maximum 1000 rows)

  2. Error Handling: If validation fails, specific error messages are displayed:

    • Missing mandatory fields

    • Invalid data types

    • Invalid mandate ID values

    • Invalid date format for resume date

    • File format errors

    • Row limit exceeded

  3. Successful Upload: Upon successful validation:

    • File is queued for processing

    • Batch ID is generated

    • Initial status is set to processing

    • Mandate resume processing begins

Step 5: Monitor Processing Status

  1. Real-time Updates: The dashboard automatically updates with processing status.

  2. Status Indicators:

    • ACCEPTED: Successfully processed resume operations (Green indicator)

    • FAILED: Failed resume attempts (Red indicator)

    • QUEUED: Resume operations waiting in processing queue (Blue indicator)

Monitoring and Managing Batch Resume Operations

Viewing Batch Resume Details

  1. Table View: The main interface displays all uploaded batch files with:

    • File Name: Name of the uploaded CSV file

    • File Upload Status: Current processing status with color-coded labels

    • Date Created: File upload timestamp

    • Last Modified: Last update timestamp

    • Total Tasks: Number of resume requests in the file

    • Tasks Progress: Visual progress bar showing completion status

    • Actions: Sync with Gateway button for manual synchronization

    Batch Resume - Table View
    Batch Resume - Table View

  2. Detailed View: Click on any filename to access detailed information:

    • Batch Details Card: Expandable/collapsible interface showing:

      • Batch ID: Unique identifier for the uploaded file

      • Date Created and Date Updated timestamps

      • Current status with color-coded indicators

    • Progress Statistics: Individual task counts for:

      • Total Accepted Tasks: Successfully processed resume operations

      • Total Pending Tasks: Resume operations awaiting processing

      • Total Rejected Tasks: Failed resume attempts

      • Total Queued Tasks: Resume operations in processing queue

      Batch Resume - Detailed View
      Batch Resume - Detailed View

Search and Filter Capabilities

  1. File Name Search:

    • Use the search input field with search icon

    • Enter filename to filter results

    • Search is case-sensitive and supports partial matches

    • Clear search using the cross icon

  2. Table Sorting:

    • Click column headers to sort data

    • Available sorting for: File Name, Status, Date Created, Total Tasks

    • Toggle between ascending and descending order

Data Export and Download

Downloading Processed Data

  1. Access Download: Click the "Download Data" button in the batch details view.

  2. CSV Export: Downloads include:

    • Serial numbers (S.No column)

    • All processed resume data with the following headers:

      • Mandate ID

      • Resume Date

      • Resume Status

      • Original Mandate Status

      • Task Status

      • Error Message

      • Created At

      • Updated At

  3. File Format:

    • CSV format with comma-separated values

    • Filename format: batch_resume.csv

    • Includes header row with column names

CSV File Upload Specifications

CSV Field Requirements

Scroll inside to view more
Field Name
Mandatory/Optional
Data Type
Description
Sample Value
Validation Rules
mandate_id
Mandatory
String
Mandate identifier for the paused mandate to resume
"MAN_456789123"
Must be a valid string, cannot be empty
resume_date
Optional
String
Date when the mandate should be resumed
"2023-12-01"
Must be in valid date format, can be empty

Resume Validation Rules

Mandate ID Requirements:

  • Format: Must be a valid string identifier from a paused mandate

  • Length: No specific length restrictions, but should be reasonable

  • Existence: Mandate ID must exist in the system and correspond to a paused mandate

  • Status: Associated mandate must be in a paused state to be eligible for resume

Resume Date Requirements:

  • Format: Optional date field must follow valid date format when provided

  • Resume Logic: If provided, resume will begin on the specified date

  • Date Validation: Resume date must be a valid future date when provided

  • Empty Values: Date field is optional and can be left empty for immediate resume

Resume Processing Logic

Eligibility Criteria:

  • Paused Status: Only mandates with paused status can be resumed

  • Resume Conflicts: System checks for existing resume schedules to avoid conflicts

  • Date Constraints: Resume dates must be valid and logically consistent

  • Gateway Availability: Resume operations depend on payment gateway availability

Processing Sequence:

  1. Validation: Verify mandate_id exists and is eligible for resume

  2. Date Processing: Validate and process optional resume date

  3. Queue Management: Add resume requests to processing queue

  4. Gateway Communication: Communicate resume instructions to payment gateway

  5. Status Update: Update mandate status based on resume result

  6. Activation: Reactivate mandate for normal processing

Resume Behavior:

  • Immediate Resume: If no resume date provided, resume begins immediately

  • Scheduled Resume: If resume date provided, resume begins on specified date

  • Status Restoration: Mandate returns to active status after successful resume

  • Payment Continuation: Normal payment processing resumes after reactivation

CSV Format Examples

CSV Format with Different Resume Scenarios:

File Upload Constraints

  • Maximum Rows: 1000 rows per CSV file

  • File Format: CSV (Comma Separated Values) only

  • Encoding: UTF-8 encoding recommended

  • File Size: Standard file size limitations apply

  • Column Order: Must match the specified header format (mandateid, resumedate)

  • Empty Values: Optional resume date field can be left empty but comma must be maintained

  • Date Format: All dates must follow valid date format when provided

  • Duplicate Prevention: Avoid duplicate mandate_id entries within the same file

Use Cases

Post-Maintenance Resumption

  1. Export paused mandate data from mandate management reports after system maintenance

  2. Prepare CSV file with mandate IDs for post-maintenance reactivation

  3. Upload file through Batch Resume interface for immediate or scheduled resume

  4. Monitor resume processing status and download results for confirmation

Scheduled Mandate Reactivation

  1. Identify mandates that need to be resumed after planned pause periods

  2. Compile list of affected mandate IDs with specific resume dates

  3. Upload resume file with scheduled reactivation dates

  4. Track individual resume status and automatic reactivation

Customer-Requested Resume

  1. Prepare CSV with mandate information for customer-requested reactivation

  2. Include mandate IDs and customer-specified resume dates

  3. Process bulk resumes with defined activation dates

  4. Use downloaded resume data for customer notification and service restoration

Seasonal Payment Reactivation

  1. Set up seasonal resume operations for mandates after holiday pause periods

  2. Create CSV files with mandate details and seasonal resume schedules

  3. Upload resume files for automated processing during specified periods

  4. Monitor resume success rates and manage payment reactivation

Troubleshooting

File Upload Validation Errors:

  • "Invalid file format": Ensure file is in CSV format with proper comma separation

  • "Missing mandatory fields": Verify that mandate_id column is present and not empty

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

  • "Invalid data type": Check that mandate_id field contains only string values

  • "Invalid date format": Ensure resume date field follows valid date format when provided

  • "Mandate ID not found": Ensure mandate IDs exist in the system and correspond to actual mandates

  • "Invalid resume date": Verify that resume date is a valid future date when provided

Resume-Specific Errors:

  • "Mandate already active": Mandate is already in an active state and cannot be resumed

  • "Invalid resume schedule": Resume date conflicts with existing schedules or business rules

  • "Resume scheduling conflict": Requested resume date conflicts with existing resume schedules

  • "Gateway rejection": Payment gateway rejected the resume request due to business rules

  • "Past date validation failed": Resume date is in the past and cannot be processed

Permissions and Roles

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

  • Mandates Module Access: Required for accessing the batch resume interface (ACL: mandate)

  • Mandates Write Permission: Required for creating and uploading batch resume files (ACL: mandate with ReadWrite access)

  • Mandates Read Permission: Needed to view batch resume status and download processed data (ACL: mandate)

  • Resume Operations Access: Required for performing mandate resume operations (ACL: mandate)

  • Gateway Sync Permission: Required for manual gateway synchronization operations (ACL: mandate)

Last updated 2 months ago