1. Individual transaction report
Post: /nQR/v1/merchanttxnreport Query parameters
# | Data Items | Type | Length | Required | Remarks |
---|---|---|---|---|---|
1 | validationTraceId | String | 20 | C | Unique QR validation Id provided by NCHL during QR generation |
2 | merchantId | String | M | Creditor Id/ Merchant Code | |
3 | acquirerId/issuerId | String | M | Acquirer/Issuer of the QR code | |
4 | nQrTxnId | String | 20 | C | Unique payment transaction id generated by NCHL. |
5 | instructionId | String | 20 | C | Unique reference id to trace the request by issuer/acquirer. |
Response parameters
# | Data Items | Type | Length | Required | Remarks |
---|---|---|---|---|---|
1 | sessionSrlno | String | Session number for the transaction. | ||
2 | recDate | Date | Date of transaction recording. | ||
3 | instructionId | String | 20 | Unique reference id to trace the request by issuer/acquirer. | |
4 | nQrTxnId | String | 20 | Unique payment transaction id generated by NCHL. | |
5 | acquirerId | String | Acquirer of the QR code. | ||
6 | issuerId | String | Issuer id. | ||
7 | Network | String | Network of the QR code. | ||
8 | issuerNetwork | String | Network of the issuer. | ||
9 | Amount | Numeric | (12,2) | Amount. | |
10 | interchangeFee | Numeric | (10,2) | Charge if applicable else 0.00. | |
11 | transactionFee | Numeric | (10,2) | IF additional cost to be paid by the customer for the transaction. else 0.00. | |
12 | debitStatus | String | Payer Account Debit status. | ||
13 | creditStatus | String | Receiver Account Credit status. | ||
14 | PayerName | String | 200 | Name of the payer. | |
15 | transactionType | String | PMT-Payment, RFND-Refund | ||
16 | payerMobileNumber | String | Mobile No of Payer. | ||
17 | merchantName | String | |||
18 | merchantTxnRef | String | |||
19 | Terminal | String | Terminal id of the QR code. | ||
20 | merchantBillNo | String | Bill No of merchant. |
Sample Request
{
"validationTraceId":"2312060000216812DWB",
"merchantId":"2501DBGLNQG",
"acquirerId":"00002501"
}
Sample Response
{
"timestamp":"2024-02-07T07:10:47.928+0000",
"responseCode":"200",
"responseStatus":"SUCCESS",
"responseMessage":null,
"responseBody":[
{
"sessionSrlNo":"5005",
"recDate":"2023-12-06",
"instructionId":"EVOL1saurv",
"nQrTxnId":"2312060000059575KMB",
"acquirerId":"00002501",
"issuerId":"00010016",
"network":"NQR",
"issuerNetwork":"NQR",
"amount":500.0,
"interchangeFee":0.0,
"transactionFee":0.0,
"debitStatus":"000",
"creditStatus":"DEFER",
"payerName":"Saurav Khatri",
"tranType":"PMT",
"payerMobileNumber":"9800000417",
"merchantName":"Evolve Pvt. Ltd. ",
"merchantTxnRef":"MerchantTxnReference",
"terminal":null,
"merchantBillNo":"0",
"instrument":null,
"validationTraceId":null,
"merchantPan":null,
"nfcTxnId":null
}
]
}
Sample Request
{
"fromDate":"2023-12-10",
"toDate":"2023-12-12",
"merchantId":"2501DBGLNQG",
"acquirerId":"00002501"
}
Sample Response
{
"timestamp":"2024-02-07T07:18:17.551+0000",
"responseCode":"200",
"responseStatus":"SUCCESS",
"responseMessage":null,
"responseBody":[
{
"sessionSrlNo":"5039",
"recDate":"2023-12-10",
"instructionId":"H11wew23",
"nQrTxnId":"2312100000059653HMX",
"acquirerId":"00002501",
"issuerId":"00010020",
"network":"NQR",
"issuerNetwork":"NQR",
"amount":784.0,
"interchangeFee":0.0,
"transactionFee":0.0,
"debitStatus":"000",
"creditStatus":"DEFER",
"payerName":"Saurav Khatri",
"tranType":"PMT",
"payerMobileNumber":"9813979589",
"merchantName":"Evolve Pvt. Ltd. ",
"merchantTxnRef":"MerchantTxnReference",
"terminal":null,
"merchantBillNo":"0",
"instrument":null,
"validationTraceId":null,
"merchantPan":null,
"nfcTxnId":null
},
{
"sessionSrlNo":"5039",
"recDate":"2023-12-10",
"instructionId":"H11wewre23",
"nQrTxnId":"2312100000059654CCE",
"acquirerId":"00002501",
"issuerId":"00010020",
"network":"NQR",
"issuerNetwork":"NQR",
"amount":784.0,
"interchangeFee":0.0,
"transactionFee":0.0,
"debitStatus":"000",
"creditStatus":"DEFER",
"payerName":"Saurav Khatri",
"tranType":"PMT",
"payerMobileNumber":"9813979589",
"merchantName":"Evolve Pvt. Ltd. ",
"merchantTxnRef":"MerchantTxnReference",
"terminal":null,
"merchantBillNo":"0",
"instrument":null,
"validationTraceId":null,
"merchantPan":null,
"nfcTxnId":null
},
{
"sessionSrlNo":"5040",
"recDate":"2023-12-10",
"instructionId":"Hswre23",
"nQrTxnId":"2312100000059655VIU",
"acquirerId":"00002501",
"issuerId":"00010020",
"network":"NQR",
"issuerNetwork":"NQR",
"amount":20000.0,
"interchangeFee":0.0,
"transactionFee":0.0,
"debitStatus":"000",
"creditStatus":"DEFER",
"payerName":"Saurav Khatri",
"tranType":"PMT",
"payerMobileNumber":"9813979589",
"merchantName":"Evolve Pvt. Ltd. ",
"merchantTxnRef":"MerchantTxnReference",
"terminal":null,
"merchantBillNo":"0",
"instrument":null,
"validationTraceId":null,
"merchantPan":null,
"nfcTxnId":null
},
{
"sessionSrlNo":"5040",
"recDate":"2023-12-10",
"instructionId":"Mere23",
"nQrTxnId":"2312100000059656KZT",
"acquirerId":"00002501",
"issuerId":"00010020",
"network":"NQR",
"issuerNetwork":"NQR",
"amount":20000.0,
"interchangeFee":0.0,
"transactionFee":0.0,
"debitStatus":"000",
"creditStatus":"DEFER",
"payerName":"Saurav Khatri",
"tranType":"PMT",
"payerMobileNumber":"9813979589",
"merchantName":"Evolve Pvt. Ltd. ",
"merchantTxnRef":"MerchantTxnReference",
"terminal":null,
"merchantBillNo":"0",
"instrument":null,
"validationTraceId":null,
"merchantPan":null,
"nfcTxnId":null
}
]
}
Note:
For the finality of transaction, kindly consider debitStatus 000 and creditStatus (‘000’,’DEFER’ and 999).
If validation trace id is used as input parameter for transaction query, there can have more than one record for same validation traceid. For example, in case of dynamic QR, the validation trace id is fixed during QR generated. Customer can make the multiple payments if earlier made payment is failed. Now the response will be the details of earlier failed and current success transaction as well. This will help to identiify the number of transactions made for same validation trace id with their corresponding status.