Txn Status Check API (401)
Last updated
Last updated
API for checking the txn status at NPCI (401 API) by providing either refId or NPCI Txn Ref ID
| Endpoint |
|---|
Request Parameters
The various parameters are explained below:
| Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
Response Parameters
The various parameters are explained below:
| Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
Json Formatted Request Example
Json Formatted Response Example
Request:POST /couapp/transactions/status
[ROOT] (No parent property / element)
tenantId
M
Alphanumeric
Fixed Length – 4
id
M
Alphanumeric
35 in case of refId and 12/20 in case of NPCI Txn Ref ID
idType
M
Alphanumeric
Specifies whether RefId or TxnNpci ID is provided. Possible values are ‘txnId’ and ‘refId’
[ROOT] (No parent property / element)
txnStatusReqRefId
C
String
Ref ID of the 401 Txn Status Check Request sent to NPCI
agentId
C
String
Masked Agent ID of the agent via which transaction was done
billerId
C
String
Biller ID of the biller for which transaction has happened
approvalRefNum
C
String
Approval Ref Number of the transaction
txnRefId
C
String
12/20 characters Txn NPCI ID
mti
C
String
Message Type Indicator - Value will be PAYMENT
txnDate
C
String
Txn Date in RFC3339 format
amount
C
String
Txn Amount in Paise
txnStatus
C
String
Status of the transaction. Possible values are SUCCESS and FAILED
customerMobile
C
String
Mobile number of the customer who initiated the transaction
generalResp
statusCode
M
Numeric
200- SUCCESS Other than 200-Failure
status
M
String
It is either “Success” or Failure
message
M
String
Contains the reason message for failure / success
remarks
C
String
Contains the reason message for failure / success