PD: Update payment details
Context
Solution
Scope
Payment Instruction
Status Update for Payment Status
Actors
Employee
Role: System
Details
Payment Details (PD) is the API to fetch the payment details from JIT.
For Request/ Response parameters, please refer the integration approach document.
The response data is stored and maintained at MUKTASoft for every PD call.
The API call to be scheduled once in a day at 10 PM for In Process payment instruction.
API Request
# | Parameter | Description |
1 | finYear | Financial year received in the APIs response of PAG. |
2 | ExtAppName | The name of the application from which the call is being made. |
3 | billRefNo | Online bill reference number received in the APIs response of PAG. |
4 | tokenNumber | Token number received in the APIs response of PAG. |
6 | tokenDate | Token date received in the APIs response of PAG. |
API Response
# | Parameter | Description |
1 | billNumber | Payment Instruction ID of the payment instruction created in MUKTASoft and then pushed to JIT. |
2 | billDate | Payment Instruction date of the payment instruction created in MUKTASoft and then pushed to JIT. |
3 | voucherNumber | Voucher number of the voucher created in JIT to maintain the accounting. |
4 | voucherDate | The voucher creation date of the voucher created in JIT-FS for payment. |
5 | billRefNo | Online bill reference number generated in JIT and received in PAG response. |
6 | paymentStatus | Payment status Message Received from RBI at the time of Debit Scroll. |
7 | tokenNumber | Token number generated in JIT and received in PAG response. |
8 | tokenDate | Token date of the token generated in JIT and received in PAG response. |
| Debit Scroll Details |
|
9 | benfAcctNo | Beneficiary’s account number. |
10 | benfBankIfscCode | Beneficiary’s bank / branch IFSC. |
11 | utrNo | Unique transaction number used by banks to reconcile the transaction. |
12 | utrDate | The date of transaction which is used by bank. |
13 | endToEndId | End to end id generated to identify a particular beneficiary for a transaction while it is pushed to CPC for payment clearance. |
14 | benfId | Beneficiary unique ID, unique to transaction. |
No Response
Error message displayed on View Payment Instruction Page. [Message: On call of PD API: No response is received.]
PI status at MUKTASoft remain unchanged to In Process.
All beneficiaries payment status remain unchanged to Payment In Process.
Option to refresh the status is provided. It triggers call of PD.
Response With Error
Error message is stored at MUKTASoft.
Error message displayed on View Payment Instruction Page. [Message: On call of PD API: <JIT error message>]
PI status at MUKTASoft remain unchanged to In Process.
All beneficiaries payment status remain unchanged to Payment In Process.
Option to refresh the status is provided. It triggers call of PD.
Response Without Error
Success message is received and same is stored at MUKTASoft.
Info message displayed on View Payment Instruction Page. [Message: On call of PD API: Response is received and updated successfully]
PI status at the MUKTASoft changes to Completed.
The beneficiaries payment status is changed to “Payment Successful”.
No action is enabled.
SMS notification is sent to all the beneficiaries.
API Call - Status - Payment Status - Actions Mapping
# | Response | PI Status (From) | PI Status (To) | Payment Status | User Action | API Call |
1 | No Response | In Process | In Process | Payment In Process | Refresh | PD |
2 | Response With Error | In Process | In Process | Payment In Process | Refresh | PD |
3 | Response Without Error | In Process | Completed | Payment Successful | No Action |
|
Validations
Not applicable.
Configurations
Master Data
Not applicable.
Attachments
Not applicable.
Workflow
Not applicable.
Actions
Not applicable.
Notifications
To all the beneficiaries:
Payment of Rs. {amount} for MUKTA, transaction <UTRNO> is made to your registered bank account. Contact your bank if not credited within 72 hours. MUKTA - Govt. of Odisha.
User Interface
View Payment Instruction
Acceptance Criteria
API is called and status is fetched and updated for both PI and Beneficiary.
SMS notification is sent to all the beneficiaries.
Status is reflected in 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 until a response is received. The latest response is recorded in the log.