6. Creditor Payment status query API

This API is used to fetch the status of creditor/bill payment transactions made through National Payment Interface (NPI). Creditor status query API can be triggered after the payment transaction (confirm bill) is successful where debit status should be successful (000) and credit status (‘000’, DEFER,’999’, ACSC). Refer creditorPaymentDetail object in below sample response for the actual status of creditor payment.

POST URL: /api/v1/query-transaction

Request parameters

#	Parameter Name	Data Type	Length	Required	Remarks
1	instructionId	String	35	C	Unique identification for the transaction for reconciliation purpose later.
2	batchId	String	20	C	Unique Identification for the batch for later reconciliation.
4	transactionId	String	20	C	Unique id returned by the system for system level verification.
5	realTime	Boolean	-	M	CIPS transaction = true, IPS transaction = false

POST URL for Authentication: /oauth/token Sample Request:

{
 "instructionId": "", 
 "batchId": "712021382", 
 "transactionId": "", 
 "realTime": true 
}

Sample Response:

{
  "responseCode": "000",
  "responseMessage": "Transaction detail Retrieved successfully.",
  "responseData": {
    "cipsBatchResource": {
      "batchId": "221111063444778335",
      "recDate": "2022-11-11",
      "batchAmount": 1000.00,
      "batchCount": 1,
      "batchChargeAmount": 5.00,
      "batchCurrency": "NPR",
      "debtorAgent": "2501",
      "debtorBranch": "53",
      "debtorName": "Namrata Shrestha",
      "debtorAccount": "0530030072000016",
      "debtorPhone": "Namrata Shrestha",
      "debtorMobile": "+977-9812345678",
      "debtorEmail": "test@test.com",
      "rcreTime": "2022-11-11T06:34:44.847+0000",
      "debitStatus": "000",
      "isoTxnId": 740240,
      "sessionSrlNo": 2578
    },
    "cipsTransactionResources": [
      {
        "transactionId": 12347652,
        "batchId": 712021382,
        "recDate": "2022-11-11",
        "instructionId": "CIT221111063444778335",
        "endToEndId": "221111063444778335",
        "amount": 1000.00,
        "chargeAmount": 5.00,
        "creditorAgent": "2101",
        "creditorName": "CITIZEN INVESTMENT TRUST SARAL KARJA",
        "creditorAccount": "01600197GL",
        "reasonDesc": "SUCCESS",
        "refId": "001CPS0000001",
        "remarks": "1971/05/19",
        "particulars": "Keshav Raj Khatiwada",
        "tnxDateTime": "2022-11-11T06:34:44.847+0000",
        "creditStatus": "DEFER",
        "isoTxnId": 740240
      }
    ],
    "creditorPaymentDetail": {
      "txnDate": "2022-11-10T18:15:00.000+0000",
      "status": "SUCCESS",
      "description": "SUCCESS", 
      "txnId": 12347652
    },
    "responseErrors": null,
    "responseStatus": "SUCCESS"
  }
}

Error Handling For Creditor Status Query

HTTP Status	Code	Description
HttpStatus.OK	200	SUCCESS
HttpStatus.BAD_REQUEST	400 / E001	INPUT PARAMETER MISSING ( Please, provide at least one search parameters)
HttpStatus.NOT_FOUND	200 / E010	RECORD NOT FOUND

Note: In case original transaction exits in the system however it’s corresponding creditor payment status not available or pending, the status will be creditorPaymentDetail: null.

Response Code Handling For service payment transaction, handling of Http status and transaction response code will be same as payment integration with National Payment Interface (NPI) for fund transfer. Refer to NPI Specification document for further details