JUSPAY Unified Dashboard

Batch Pause

Overview

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

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

  • Operations Teams: For pausing active mandate operations in bulk and monitoring pause processing performance across different payment methods and gateways with comprehensive operational logs.

  • Finance Teams: For bulk mandate pause processing, payment timing control, and tracking pause operations across multiple active transactions with detailed audit trails.

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

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 Pause from the mandate operations dropdown.

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

Batch Pause
Batch Pause

Step-by-Step Usage Instructions

Creating Batch Pause Operations

Step 1: Access the Batch Pause Interface

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

  2. You will see the main dashboard with a description: "This module helps in pausing active 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 pause uploaded is displayed."

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

Step 2: Initiate New Batch Pause Upload

  1. Click the "Create Batch Pause" 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 pause 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 Pause
Batch Pause

Step 3: Prepare and Upload CSV File

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

  2. Prepare Your Data: Fill in your pause 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 fields are validated (Pause Start Date, Pause End Date)

    • Column types are validated (Mandate ID as String, Dates in YYYY/MM/DD 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 (YYYY/MM/DD format for optional date fields)

    • 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 (must be YYYY/MM/DD)

    • 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 pause processing begins

Step 5: Monitor Processing Status

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

  2. Status Indicators:

    • ACCEPTED: Successfully processed pause operations (Green indicator)

    • FAILED: Failed pause attempts (Red indicator)

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

Monitoring and Managing Batch Pause Operations

Viewing Batch Pause 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 pause requests in the file

    • Tasks Progress: Visual progress bar showing completion status

    • Actions: Sync with Gateway button for manual synchronization

      Batch Pause - Table View
      Batch Pause - 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 pause operations

      • Total Rejected Tasks: Failed pause attempts

      • Total Queued Tasks: Pause operations in processing queue

      Batch Pause - Detailed View
      Batch Pause - 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 pause data with the following headers:

      • Mandate ID

      • Pause Start Date

      • Pause End Date

      • Pause Status

      • Original Mandate Status

      • Task Status

      • Error Message

      • Created At

      • Updated At

  3. File Format:

    • CSV format with comma-separated values

    • Filename format: batch_pause.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 active mandate to pause
"MAN_456789123"
Must be a valid string, cannot be empty
pause_start_date
Optional
String
Start date for the pause period in YYYY/MM/DD format
"2023/12/01"
Must be in YYYY/MM/DD format, can be empty
pause_end_date
Optional
String
End date for the pause period in YYYY/MM/DD format
"2023/12/31"
Must be in YYYY/MM/DD format, can be empty

Pause Validation Rules

Mandate ID Requirements:

  • Format: Must be a valid string identifier from an active mandate

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

  • Existence: Mandate ID must exist in the system and correspond to an active mandate

  • Status: Associated mandate must be in an active state to be eligible for pause

Pause Date Requirements:

  • Format: Optional date fields must follow YYYY/MM/DD format when provided

  • Start Date Logic: If provided, pause will begin on the specified date

  • End Date Logic: If provided, pause will automatically end on the specified date

  • Date Validation: End date must be after start date when both are provided

  • Empty Values: Both date fields are optional and can be left empty for immediate pause

Pause Processing Logic

Eligibility Criteria:

  • Active Status: Only mandates with active status can be paused

  • Pause Conflicts: System checks for existing pause periods to avoid conflicts

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

  • Gateway Availability: Pause operations depend on payment gateway availability

Processing Sequence:

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

  2. Date Processing: Validate and process optional start/end dates

  3. Queue Management: Add pause requests to processing queue

  4. Gateway Communication: Communicate pause instructions to payment gateway

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

  6. Scheduling: Set up automated resume if end date is provided

Pause Behavior:

  • Immediate Pause: If no start date provided, pause begins immediately

  • Scheduled Pause: If start date provided, pause begins on specified date

  • Automatic Resume: If end date provided, mandate automatically resumes on specified date

  • Manual Resume: If no end date provided, pause continues until manually resumed

CSV Format Examples

CSV Format with Different Pause 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, pausestartdate, pauseend_date)

  • Empty Values: Optional date fields can be left empty but commas must be maintained

  • Date Format: All dates must follow YYYY/MM/DD format when provided

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

Use Cases

Temporary Mandate Suspension

  1. Export active mandate data from mandate management reports

  2. Prepare CSV file with mandate IDs for temporary suspension

  3. Upload file through Batch Pause interface with optional pause duration

  4. Monitor pause processing status and download results for confirmation

Scheduled Maintenance Windows

  1. Identify mandates that need to be paused during system maintenance

  2. Compile list of affected mandate IDs with specific start and end dates

  3. Upload pause file with scheduled pause periods

  4. Track individual pause status and automatic resume after maintenance

Customer-Requested Pauses

  1. Prepare CSV with mandate information for customer-requested pause periods

  2. Include mandate IDs and customer-specified pause dates

  3. Process bulk pauses with defined start and end dates

  4. Use downloaded pause data for customer notification and service management

Seasonal Payment Adjustments

  1. Set up seasonal pause operations for mandates during holiday periods

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

  3. Upload pause files for automated processing during specified periods

  4. Monitor pause success rates and manage automatic resume schedules

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 date fields follow YYYY/MM/DD format when provided

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

  • "End date before start date": Verify that end date is after start date when both are provided

Pause-Specific Errors:

  • "Mandate already paused": Mandate is already in a paused state and cannot be paused again

  • "Invalid pause period": Pause dates are invalid or conflict with existing schedules

  • "Pause scheduling conflict": Requested pause period conflicts with existing pause schedules

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

  • "Future date validation failed": Start or end dates are in the past or too far in the future

Permissions and Roles

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

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

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

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

  • Pause Operations Access: Required for performing mandate pause operations (ACL: mandate)

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

Last updated 2 months ago