PIS: Payment Instruction Status

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 integration approach document.

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.