JUSPAY Unified Dashboard

Batch Order Detail

Overview

The Batch Order Detail module allows users to fetch and review details of multiple orders simultaneously. By uploading a CSV file, users can retrieve comprehensive order information for bulk-created orders in a single view. It offers real-time progress tracking, status monitoring, and detailed reporting for all order detail operations processed through the Juspay payment platform.

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 Order Details tab from the bulk operations navigation.

  5. The navigation URL for this module is https://portal.juspay.in/batch/batch-order-detaillink icon.

Batch Order Details
Batch Order Details

Step-by-Step Usage Instructions

Creating Batch Order Detail

Step 1: Access the Batch Order Detail Interface

  1. Navigate to the Batch Order Detail module using the steps above.

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

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

Step 2: Initiate New Batch Order Detail Upload

  1. Click the "Create Batch Order Detail" 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 order detail 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 Order Details
Batch Order Details

Step 3: Prepare and Upload CSV File

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

  2. Prepare Your Data: Fill in your order 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)

    • Column types are validated (Order Id as String)

Step 4: File Processing and Validation

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

    • CSV format validation

    • Mandatory field presence (order_id)

    • Data type validation for each column

    • Order ID existence validation

    • Order status verification

    • Processing authorization validation

    • Row count validation (maximum 1000 rows)

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

    • Missing mandatory fields

    • Invalid order ID (order not found)

    • Order in invalid state for processing

    • Processing authorization failures

    • 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

    • Order detail processing begins

Step 5: Monitor Processing Status

  1. Status Indicators:

    • ACCEPTED: Successfully retrieved order details (Green indicator)

    • FAILED: Failed order detail retrieval attempts (Red indicator)

    • QUEUED: Order detail requests waiting in processing queue (Blue indicator)

Monitoring and Managing Batch Order Detail

Viewing Batch Order Detail 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

    • Total Orders: Number of order detail requests in the file

    • Date Created: File upload timestamp

    • Last Modified: Last update timestamp

    • Total Tasks: Number of order detail requests in the file

    • Tasks Progress: Visual progress bar showing completion status

    • Actions: Sync with Gateway button for manual synchronization

    Batch Order Details - Table View
    Batch Order Details - 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

      • Total Orders with count formatting

      • Current status with color-coded indicators

    • Progress Statistics: Individual task counts for:

      • Total Accepted Tasks: Successfully retrieved order details

      • Total Rejected Tasks: Failed order detail retrieval attempts

      • Total Queued Tasks: Order details in processing queue

    Batch Order Details - Detailed View
    Batch Order Details - 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, Total Orders, 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 order detail data with the following headers:

      • Order ID

      • Processing Status

      • Order Status

      • Order Information

      • Processing Details

      • Task Status

      • Error Message

      • Created At

      • Updated At

  3. File Format:

    • CSV format with comma-separated values

    • Filename format: batch_order_detail.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
Order identifier for detail processing
"ORD_123456789"
Must be valid existing order ID in the system

Order ID Validation Rules

Order ID Requirements:

  • Format: Alphanumeric string identifier

  • Existence Check: Order ID must exist in the system

  • Length: Must be non-empty string

  • Characters: Letters, numbers, underscores, and hyphens allowed

  • Case Sensitivity: Case-sensitive matching

  • Purpose: Retrieves order details

Validation Process:

  1. Order Existence: System verifies order ID exists in database

  2. Order Status: Validates order is in processable state

  3. Processing Authorization: Checks processing permissions and authorization

  4. Order Integrity: Ensures order data integrity for processing

  5. System Integration: Validates integration with order management systems

CSV Format Examples

Complete CSV Format with Sample Data:

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 (order_id)

  • Empty Values: Order ID field is mandatory and cannot be empty

  • Order Validation: All order IDs must exist in the system and be in valid state for processing

Troubleshooting

File Upload Validation Errors:

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

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

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

  • "Order not found": Check that all order IDs exist in the system before upload

  • "Invalid order state": Ensure orders are in valid state for processing

  • "Processing authorization failure": Verify that order processing authorization is valid

Permissions and Roles

Access to the Batch Order Detail module is controlled by the following permissions:

  • Order Detail Module Access: Required for accessing the batch order detail interface (ACL: orders)

  • Order Detail Write Permission: Required for creating and uploading batch order detail files (ACL: orders with ReadWrite access)

  • Order Detail Read Permission: Needed to view batch order detail status and download processed data (ACL: orders)

Last updated 5 months ago