FD: Update Failed Payments

Context

Update failed payment status.

Solution

Scope

Payment Instruction

Status Update for Payment Failed Status

Actors

Employee

Role: System

Details

1. Failed Details (FD) is the API to fetch the failed payment details from JIT.

2. For Request/ Response parameters, please refer the integration approach document.

3. The response data is stored and maintained at MUKTASoft for every FD call.

4. The API call will be scheduled once a day at 10 PM for Completed payment instructions.

API Request

#	Parameter	Description
2	billno	Payment Instruction ID of the payment instruction created in MUKTASoft and then pushed to JIT.
3	billDate	Payment Instruction date of the payment instruction created in MUKTASoft and then pushed to JIT.
4	adviceId	Payment advice ID, generated at JIT-FS
5	onlineBillRefNo	Online bill reference no. generated at JIT and received with PAG response.
6	tokenNo	Token number, generated at JIT-FS
7	tokenDate	Token number, generated at JIT-FS

API Response

#	Parameter	Description
2	billNumber	Bill number of the bill created in MUKTASoft and then pushed to JIT-FS as payment instruction.
3	billDate	Bill date of the bill created in MUKTASoft and then pushed to JIT-FS as payment instruction.
4	voucherNo	Voucher generated at JIT-FS for maintaining the accounting.
5	voucherDate	Voucher date.
6	billRefNo	Online bill reference number generated at JIT and received with PAG response.
7	tokenNumber	Token number generated at JIT-FS
8	tokenDate	Token generation date
	benfDtls
10	benfAcctNo	Beneficiary’s account number.
11	benfBankIfscCode	Beneficiary’s bank / branch IFSC.
12	utrNo	Unique transaction number used by banks to reconcile the transaction.
13	utrDate	UTR date.
14	endToEndId	End to end id generated to identify a particular beneficiary for a transaction while it is pushed to CPC for payment clearance.
15	orgBillRefNumber	Original online bill reference number, In first failure case billRefNo and orgBillRefNumber are same.
16	challanNumber	Challan number of the challan created to put the amount into suspense account
17	challanDate	Challan generation date
18	failedReason	Reason for failure
19	benfId	Beneficiary unique ID, unique to transaction.

No Response

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

2. PI status at MUKTASoft remains unchanged to Completed.

3. Beneficiaries' payment status remains unchanged to Payment Successful.

4. No action is enabled.

Response With Error

1. The error message is stored at MUKTASoft.

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

3. PI status at MUKTASoft remains unchanged to Completed.

4. Beneficiaries' payment status remains unchanged to Payment Successful.

5. No action is enabled.

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 FD API: Response is received and updated successfully]

3. PI status at the MUKTASoft remains unchanged to Completed.

4. The beneficiaries for which details are received in response, the payment status changes to Payment Failed.

5. SMS notification is sent to all the beneficiaries.

6. The option to generate a revised PI is enabled. It triggered the COR API call.

API Call - Status - Payment Status - Actions Mapping

#	Response	PI Status (From)	PI Status (To)	Payment Status	User Action	API Call
1	No Response	Completed	Completed	Payment Successful	No Action
2	Response With Error	Completed	Completed	Payment Successful	No Action
3	Response Without Error	Completed	Completed	Payment Failed	Generate Revised PI	COR

Validations

Not applicable.

Configurations

Master Data

Not applicable.

Attachments

Not applicable.

Workflow

Not applicable.

Actions

Not applicable.

Notifications

To beneficiary for which failure details are received:

Payment of Rs. {amount} for MUKTA, transaction <UTRNO> is failed. Contact MUKTA Cell at ULB for more detail. MUKTA - Govt. of Odisha.

User Interface

Same as View Payment Instruction.

Acceptance Criteria

1. API is called and status is fetched and updated for beneficiaries.

2. SMS notification is sent to the beneficiary for a failed transaction.

3. Status is reflected in the View Payment Instruction Page.

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

5. Technical glitches in the integration are defined as errors and captured.

6. The system keeps trying until a response is received. The latest response is recorded in the log.