DIGIT Works
PlatformDomainsAcademyDesign SystemFeedback
Works v1.1
Works v1.1
  • Introducing Works
    • What's New
  • Design Approach
    • Approach
    • Solution Design
  • Specifications
    • Functional Specifications
      • Project
      • Estimates
      • Organisation
      • Attendance Management
      • Measurements
      • Muster Roll
      • Expenditure / Billing
      • Contracts
    • Release Notes
      • MDMS & Configuration Updates
      • Test cases
      • Data Migration
      • Service Build Updates
  • Reference Implementations
    • MUKTASoft v2.1
    • MUKTASoft v2.2
      • Specifications
        • Roadmap
        • User Persona
        • Functional Requirements
          • Product Requirements Document v2.0
          • Product Requirements Document v2.1
            • Employee Mobile Application
            • Aadhaar Integration
            • Estimate Templates
            • SOR Rate Analysis
          • User Stories
            • Time Extension
              • CBO: Create Time Extension
              • Time Extension Workflow
              • EMP: Create Time Extension
              • Search and View Time Extension
              • CBO: My Requests
              • CBO: Edit Time Extension
            • JIT-FS Integration
              • Fund Allocation Register
              • Create Payment Instruction
              • PIS: Payment Instruction Status
              • PAG: Payment Advice Status
              • PD: Update payment details
              • FD: Update Failed Payments
              • Create Revised Payment Instruction
              • Revised PI: Update payment details
              • Revised PI: Updated Failed Payments
              • Search Payment Instruction
              • View Payment Instruction
            • Work Order
              • Create Work Order
              • Work Order Workflow
              • Work Order Inbox Page
              • Create/ Submit Work Order
              • Edit/Submit Work Order
              • Verify & Forward
              • Send Back
              • Send Back To Originator
              • Reject Work Order
              • Approve
              • Search Work Order
              • Work Order PDF
            • Dashboard v1.0
              • Commons
              • KPIs: Actions Items
              • KPIs: SLA Breached
              • KPIs: Leaderboard
              • KPIs: Activities by Status
              • KPIs: Payments
              • KPIs: Expenditure
            • Schedule of rates
              • Create SOR
              • Search SOR
              • View SOR
              • Modify SOR
              • Add/ Modify Rate
            • Detailed Estimate
              • Create Detailed Estimate
              • Change in workflow
              • Change in edit estimate
              • Search and View Detailed Estimate
            • Detailed MB
              • Create MB
              • MB Inbox
              • MB Workflow
              • Search MB
              • View MB
              • Edit MB
            • Employee Mobile Application
              • Employee Login
              • Home Page
              • Work Orders
              • Create/ Edit MB
              • Measurement Books
              • View Measurement Book
            • Aadhar Integration
              • Wage Seeker's Registration
              • Wage Seeker Modification
            • Improvements
              • Moving Skills to SOR Master
              • Re-payment of failed payment
              • Revising estimate calculation logic
              • Material purchase payment to CBO
            • Estimate Template
              • Create Template
              • Search Template
              • View Template
              • Modify Template
              • Change in estimate to add template
            • Rate Analysis
              • Add/ Edit Rate Analysis
              • View Rate Analysis
              • Revising Rate
              • Analysis Statements
              • Utilization Statements
              • Download of analysis statements
            • Data Protection & Privacy
              • Display Privacy Notice In Login
              • Display Bank Account Details On Wage Bill
              • Display Muster Roll Details
              • View Payment Instruction - Mask Account Number & IFSC
              • View /Edit Wage Seeker Details
              • View/Edit Organisation Details
              • Display Engaged Wage Seeker Details
              • Display Organisation Profile & Bank Details
              • Track Attendance Changes
              • View Muster Rolls
              • Search Wage Seeker
              • Remove PII & Sensitive Data From Additional Fields
      • Deployment
        • Release Notes
          • Service Build Updates
          • Data Migration
          • Test Cases
        • Deployment Guide
        • SMS Adapter Services
          • Notification Consumer
          • Notification Consumer Service
          • Contact Notification Service
          • Estimate Notification
          • Expense Notification Service
          • Muster Roll Notification Service
          • Measurement Notification Service
          • Organisation Notification Service
          • Individual Notification Service
        • MUKTASoft Services
          • IFMS Adapter
          • Expense Calculator
          • Works PDF
          • MUKTA Services
          • Bank Account Search
          • Individual Search
          • Organisation Search
          • Bill Scheduler
          • Statements
          • Rate Analysis
        • Configuration
          • Master Data Templates
            • Project Type
            • Target Demography
            • Unit Of Measurement (Units)
            • Overheads
            • Skill Category & Skills
            • Community-Based Organisation Roles
            • Scheme
            • Expense Heads
            • Standard Deductions
            • Organisation Type
            • Organisation Sub Type
            • Organisation Functional Category
            • Organisation Class/Rank
            • HRMS Sections/Departments
            • HRMS Designation
            • HRMS Employment Type
            • User Role
            • Organization
            • Wage Seeker
            • Tenants
            • Ward Boundary
            • Locality Boundary
            • Payment Advice Format
            • Users Data
            • Schedule of rates
            • Rate Analysis
          • Notifications & SMS Templates
          • Localisation
          • Dashboard Reindexing
          • Platform Service Configuration
          • UI Configuration
            • Common Configurations
              • Role Configuration
              • MDMS Configuration
              • APK Generation
            • Modules
              • Project
              • Estimate
              • Workorder
                • Time Extension
              • Muster Roll
              • Bill
              • Organization
              • Wage Seeker
              • Wage Seeker (CBO Application)
              • Attendance (CBO Application)
              • Muster Roll (CBO Application)
              • Mukta Dashboard
              • Measurement
              • SORs and Rates
              • IFMS Adapter UI
              • Rate Analysis
              • Revision Of Rates
              • Estimate Template
              • Measurement Book (Mobile Application)
        • Customisation
          • Works UI
            • UI Tech Flow Diagrams
          • UI Screens Customisation
            • Document Upload Container
            • CSS Customisation
            • Inbox/Search Screen
      • Implementation
        • Pilot Roll Out Plan
        • Pilot Go Live Definition
        • Pilot Sucess Metrics
        • Success Metrics
        • Adoption Metrics
        • Adoption Template
        • Implementation Plan & Checklist
        • Issue Management - Standard Operating Procedures
        • Training Resources
          • User Manual
            • Mobile Application User Manual
              • CBO - Getting Started
                • My Works
                • Track Attendance
                • Muster Rolls
                • My Bills
                • My Requests
              • Employee - Getting Started
                • Work Orders
                • Measurement Books
            • Web Application User Manual
              • Getting Started
              • Project
              • Estimate
              • Work Order
              • Time Extension
              • Measurement Book
              • Muster Roll
              • Billing
              • Payments
              • Rates Revision
              • Registries
                • Wage Seekers
                • Organizations
                • Schedule Of Rates
                  • SOR Definition
                  • Rates
                  • Rate Analysis
                • Estimate Template
            • Kibana Dashboard User Manual
          • Training Videos
        • UAT Planning
          • UAT Test Case Scenarios
          • UAT Schedule Plan
          • Issue Reporting Template
          • UAT Credentials
  • Platform
    • Architecture
      • High Level Design
      • Low Level Design
        • Registries
          • Individual
          • Bank Account
          • Organization
        • Services
          • Project
          • Detailed Estimates
          • Contracts
          • Attendance
          • Muster Roll
          • Expense
          • Schedule of Rates (archive)
          • Detailed Measurement Book
  • Setup
    • Install Works
      • Install Using GitHub Actions In AWS
      • System Data Setup
    • Configure Works
      • Service Configuration
        • Project
        • Estimate
        • Contract
        • Attendance
        • Muster Roll
        • Expense
        • Bank accounts
        • Organisation
        • Individual
        • Estimate Template
  • General
    • Source Code
    • Roadmap
    • Discussion Board
    • Issues
Powered by GitBook

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page
  • Context
  • Solution
  • Scope
  • Actors
  • Details
  • Validations
  • Configurations
  • User Interface
  • Acceptance Criteria

Was this helpful?

  1. Reference Implementations
  2. MUKTASoft v2.2
  3. Specifications
  4. Functional Requirements
  5. User Stories
  6. JIT-FS Integration

PIS: Payment Instruction Status

PreviousCreate Payment InstructionNextPAG: Payment Advice Status

Was this helpful?

Context

Solution

Scope

Payment Instruction

Status Update API Call

Actors

Employee

Role: System

Details

  1. Payment instruction status (PIS) is the API to fetch the PI status from JIT.

  2. Once a PI is accepted at JIT, it is then approved with a digital sign by SSU in JIT.

  3. The approved ones only has the Payment Instruction ID and Date available in response.

  4. For Request/ Response parameters, please refer the .

  5. The response data is stored and maintained at MUKTASoft for every PIS call.

  6. The API call to be scheduled once in a day at 10:00PM every day for the Payment Instructions Initiated, and the Payment Instructions Declined having error “Duplicate Payment Information Id”.

API Request

#

Parameter

Is Mandatory?

Description

1

jitBillNo

Yes

Payment Instruction ID of the payment instruction created in MUKTASoft and then pushed to JIT.

2

jitBillDate

Yes

Payment Instruction date of the payment instruction created in MUKTASoft and then pushed to JIT.

3

ssuIaId

Yes

Special spending unit ID. A master value maintained in JIT-FS.

API Response

#

Parameter

Description

1

pmtInstId

The unique id of payment instruction that’s been generated at JIT.

2

payInstDate

The date of payment instruction created.

3

jitBillNumber

Payment Instruction ID of the payment instruction created in MUKTASoft and then pushed to JIT.

4

jitBillDate

Payment Instruction date of the payment instruction created in MUKTASoft and then pushed to JIT.

5

ssuIaId

Special spending unit ID. A master value maintained in JIT-FS.

6

billNetAmount

Net bill amount sent in the PI

7

billGrossAmount

Gross bill amount sent in the PI

8

schemeCode

Scheme code under which PI is created

9

totalNumberOfBeneficiary

Total beneficiary count

No Response

  1. Error message displayed on View Payment Instruction Page. [Message: On call of PIS API: No response is received.]

  2. PI status at MUKTASoft remain unchanged to Initiated.

  3. All beneficiaries payment status remain unchanged to Payment Initiated.

  4. Option is given to user to refresh the status. On refresh API call is triggered.

Response With Error (Others)

  1. Error message is stored at MUKTASoft.

  2. Error message displayed on View Payment Instruction Page. [Message: On call of PIS API: <JIT error message>]

  3. PI status at MUKTASoft remain unchanged to Initiated.

  4. All beneficiaries payment status remain unchanged to Payment Initiated.

  5. Option is given to user to refresh the status. On refresh API call is triggered.

Response With Error (Rejected)

  1. If the PI is rejected by SSU user, the same is received in error message.

  2. Error message displayed on View Payment Instruction Page. [Message: On call of PIS API: <JIT error message>]

  3. PI status at MUKTASoft changes to Rejected.

  4. All beneficiaries payment status changes to NA.

  5. A reverse expense transaction is recorded under Fund Allocation Register.

  6. Option to generate new PI is provided from View Payment Instruction Page.

Response Without Error

  1. Success message is received and same is stored at MUKTASoft.

  2. Info message displayed on View Payment Instruction Page. [Message: On call of PIS API: Response is received and updated successfully]

  3. PI status at the MUKTASoft changes to Approved.

  4. All beneficiaries payment status remain unchanged to Payment Initiated.

  5. Option to refresh the status is provided. It triggers call of PAG.

API Call - Status - Payment Status - Actions Mapping

#

Response

PI Status (From)

PI Status (To)

Payment Status

User Action

API Call

1

No Response

Initiated

Initiated

Payment Initiated

Refresh

PIS

2

Response with Error Others

Initiated

Initiated

Payment Initiated

Refresh

PIS

3

Response with Error Rejected

Initiated

Rejected

Payment Initiated

Generate New PI

PI

4

Response Without Error

Initiated

Approved

Payment Initiated

Refresh

PAG

Validations

Not applicable.

Configurations

Master Data

Not applicable.

Attachments

Not applicable.

Workflow

Not applicable.

Actions

Not applicable.

Notifications

Not applicable

User Interface

View Payment Advice

Acceptance Criteria

  1. There is scheduler running to fetch the PI status and updated at MUKTASoft.

  2. Status is updated based on response received.

  3. Both the statuses are reflected in View Payment Instruction.

  4. Option to Generate Revised PI is given to user through View Payment Instruction Page.

  5. The response is captured in MUKTASoft for debugging and error reporting.

  6. Technical glitched in the integration are defined as error and captured.

  7. System keep trying based on schedule until a response is received. The latest response is recorded in the log.

integration approach document