Payment Instruction
Status Update API Call
Employee
Role: System
Payment instruction status (PIS) is the API to fetch the PI status from JIT.
Once a PI is accepted at JIT, it is then approved with a digital sign by SSU in JIT.
The approved ones only has the Payment Instruction ID and Date available in response.
For Request/ Response parameters, please refer the integration approach document.
The response data is stored and maintained at MUKTASoft for every PIS call.
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”.
#
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.
#
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
Error message displayed on View Payment Instruction Page. [Message: On call of PIS API: No response is received.]
PI status at MUKTASoft remain unchanged to Initiated.
All beneficiaries payment status remain unchanged to Payment Initiated.
Option is given to user to refresh the status. On refresh API call is triggered.
Error message is stored at MUKTASoft.
Error message displayed on View Payment Instruction Page. [Message: On call of PIS API: <JIT error message>]
PI status at MUKTASoft remain unchanged to Initiated.
All beneficiaries payment status remain unchanged to Payment Initiated.
Option is given to user to refresh the status. On refresh API call is triggered.
If the PI is rejected by SSU user, the same is received in error message.
Error message displayed on View Payment Instruction Page. [Message: On call of PIS API: <JIT error message>]
PI status at MUKTASoft changes to Rejected.
All beneficiaries payment status changes to NA.
A reverse expense transaction is recorded under Fund Allocation Register.
Option to generate new PI is provided from View Payment Instruction Page.
Success message is received and same is stored at MUKTASoft.
Info message displayed on View Payment Instruction Page. [Message: On call of PIS API: Response is received and updated successfully]
PI status at the MUKTASoft changes to Approved.
All beneficiaries payment status remain unchanged to Payment Initiated.
Option to refresh the status is provided. It triggers call of PAG.
#
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
Not applicable.
Not applicable.
Not applicable.
Not applicable.
Not applicable.
Not applicable
View Payment Advice
There is scheduler running to fetch the PI status and updated at MUKTASoft.
Status is updated based on response received.
Both the statuses are reflected in View Payment Instruction.
Option to Generate Revised PI is given to user through View Payment Instruction Page.
The response is captured in MUKTASoft for debugging and error reporting.
Technical glitched in the integration are defined as error and captured.
System keep trying based on schedule until a response is received. The latest response is recorded in the log.