Batch Retry

Overview

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

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

  • Operations Teams: For retrying failed mandate operations in bulk and monitoring retry processing performance across different payment methods and gateways with comprehensive operational logs.

  • Finance Teams: For bulk mandate retry processing, financial reconciliation, and tracking retry operations across multiple failed transactions with detailed audit trails.

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

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

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

    Batch Retry
    Batch Retry

Step-by-Step Usage Instructions

Creating Batch Retry Operations

Step 1: Access the Batch Retry Interface

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

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

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

Step 2: Initiate New Batch Retry Upload

  1. Click the "Create Batch Retry" 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 retry 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 Retry
    Batch Retry

Step 3: Prepare and Upload CSV File

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

  2. Prepare Your Data: Fill in your retry 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 (Order ID, Mandate ID)

    • Column types are validated (Order ID as String, Mandate ID as String)

Step 4: File Processing and Validation

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

    • CSV format validation

    • Mandatory field presence (orderid, mandateid)

    • Data type validation for each column

    • Order ID and Mandate ID validation (must be valid string identifiers)

    • Row count validation (maximum 1000 rows)

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

    • Missing mandatory fields

    • Invalid data types

    • Invalid order ID or mandate ID values

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

Step 5: Monitor Processing Status

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

  2. Status Indicators:

    • ACCEPTED: Successfully processed retry operations (Green indicator)

    • FAILED: Failed retry attempts (Red indicator)

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

Monitoring and Managing Batch Retry Operations

Viewing Batch Retry 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 retry requests in the file

    • Tasks Progress: Visual progress bar showing completion status

    • Actions: Sync with Gateway button for manual synchronization

    Batch Retry - Table View
    Batch Retry - 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 retry operations

      • Total Rejected Tasks: Failed retry attempts

      • Total Queued Tasks: Retry operations in processing queue

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

      • Order ID

      • Mandate ID

      • Retry Status

      • Original Error Message

      • Retry Attempt Count

      • Task Status

      • Error Message

      • Created At

      • Updated At

  3. File Format:

    • CSV format with comma-separated values

    • Filename format: batch_retry.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
order_id
Mandatory
String
Unique order identifier for the failed mandate to retry
"ORD_123456789"
Must be a valid string, cannot be empty
mandate_id
Mandatory
String
Mandate identifier for the failed mandate to retry
"MAN_456789123"
Must be a valid string, cannot be empty

Retry Validation Rules

Order ID Requirements:

  • Format: Must be a valid string identifier from a previously failed mandate

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

  • Existence: Order ID must exist in the system and correspond to a failed mandate

  • Status: Associated mandate must be in a failed state to be eligible for retry

Mandate ID Requirements:

  • Format: Must be a valid string identifier matching the failed mandate

  • Validation: Must be non-empty string and correspond to existing mandate

  • Consistency: Must match with the provided order_id for the same transaction

  • Retry Eligibility: Mandate must be in a retryable failed state

Retry Processing Logic

Eligibility Criteria:

  • Failed Status: Only mandates with failed status can be retried

  • Retry Limits: System may enforce maximum retry attempt limits

  • Time Constraints: Some mandates may have time-based retry restrictions

  • Gateway Availability: Retry operations depend on payment gateway availability

Processing Sequence:

  1. Validation: Verify orderid and mandateid exist and are eligible for retry

  2. Queue Management: Add retry requests to processing queue

  3. Gateway Communication: Attempt to reprocess the mandate through payment gateway

  4. Status Update: Update mandate status based on retry result

  5. Notification: Send status updates for successful or failed retry attempts

CSV Format Examples

CSV Format with Failed Mandate Examples:

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 (orderid, mandateid)

  • Empty Values: Mandatory fields cannot be left empty

  • Duplicate Prevention: Avoid duplicate orderid and mandateid combinations within the same file

Use Cases

Failed Mandate Recovery

  1. Export failed mandate data from mandate processing reports

  2. Prepare CSV file with order IDs and mandate IDs of failed transactions

  3. Upload file through Batch Retry interface

  4. Monitor retry processing status and download results for successful recoveries

System Error Resolution

  1. Identify mandates that failed due to temporary system issues or gateway timeouts

  2. Compile list of affected order IDs and mandate IDs

  3. Upload retry file for automated reprocessing

  4. Track individual retry status and download retry results for reconciliation

Gateway Timeout Recovery

  1. Prepare CSV with mandate information for transactions that failed due to gateway timeouts

  2. Include order IDs and mandate IDs for timeout-affected transactions

  3. Process bulk retries during optimal gateway performance periods

  4. Use downloaded retry data for payment processing completion and customer notification

Scheduled Retry Operations

  1. Set up regular retry operations for failed mandates during off-peak hours

  2. Create CSV files with failed mandate details from daily processing reports

  3. Upload retry files for automated processing during scheduled maintenance windows

  4. Monitor retry success rates and adjust retry strategies based on results

Troubleshooting

File Upload Validation Errors:

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

  • "Missing mandatory fields": Verify that orderid and mandateid columns are present and not empty

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

  • "Invalid data type": Check that orderid and mandateid fields contain only string values

  • "Order ID not found": Ensure order IDs exist in the system and correspond to actual transactions

  • "Mandate ID not found": Verify mandate IDs are valid and match existing mandates in the system

Retry-Specific Errors:

  • "Mandate already successful": Mandate has already been successfully processed and cannot be retried

  • "Retry window expired": Mandate is outside the allowed retry time window

  • "Insufficient retry attempts remaining": Mandate has reached or exceeded maximum retry limits

  • "Gateway rejection": Payment gateway rejected the retry attempt due to business rules

Permissions and Roles

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

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

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

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

  • Retry Operations Access: Required for performing mandate retry operations (ACL: mandate)

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

Last updated 2 months ago