This API lets a merchant know the status of a transaction, which was previously initiated by him /her. The TransactionId for which the status needs to be enquired is specified as part of TranEnqBody of the request message.
Saran K Joseph
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/tran_enq
post /tran_enq
appId
X-IBM-Client-Id
(apiKey located in header)
appSecret
X-IBM-Client-Secret
(apiKey located in header)
req
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
Example Request
Example Response
POST https://devgateway.federalbank.co.in/fedbnkdev/dev/upi/tran_enq
Try this operation
Definitions
{
"type": "object",
"properties": {
"TransactionEnqReq": {
"type": "object",
"properties": {
"TranEnqHeader": {
"type": "object",
"properties": {
"SenderUserId": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"SenderPassword": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"SenderCode": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
}
}
},
"TranEnqBody": {
"type": "object",
"properties": {
"TransactionId": {
"description": "TransactionId of the original request (ReqPay), about which the status is being enquired by this API.",
"type": "string"
},
"APIType": {
"description": "API Type should be “ReqAuthDetails,ReqTxnConfirmation,ReqPay”.",
"type": "string"
}
}
}
}
}
},
"required": [
"SenderUserId",
"SenderPassword",
"SenderCode",
"TransactionId"
]
}
{
"type": "object",
"properties": {
"UPITransactionEnqResp": {
"type": "object",
"properties": {
"TansactionId": {
"type": "string"
},
"ResponseCode": {
"type": "string"
},
"ResponseReason": {
"type": "string"
},
"PayerVirtualId": {
"type": "string"
},
"PayeeVirtualId": {
"type": "string"
},
"CustomerRefNo": {
"type": "string"
},
"Amount": {
"type": "number"
}
}
}
}
}
error Response Structure
{
"type": "object",
"properties": {
"errorResponse": {
"type": "object",
"properties": {
"tranTimeStamp": {
"type": "string",
"description": "Server Timestamp of the transaction"
},
"statuscode": {
"type": "string",
"description": "HTTP Status Code of the Transaction"
},
"statusreason": {
"type": "string",
"description": "HTTP status reasonphrase of the transaction"
},
"customcode": {
"type": "string",
"description": "custom reference code of the status of the transaction."
},
"customreason": {
"type": "string",
"description": "short description of the result of the transaction"
},
"tranId": {
"type": "string",
"description": "Server Transaction Id"
},
"description": {
"type": "string",
"description": "description of the error"
},
"additionalDetails": {
"type": "object",
"description": "further details related to the transaction"
}
}
}
}
}
{
"type": "object",
"properties": {
"UPITransactionEnqResp": {
"type": "object",
"properties": {
"TransactionId": {
"type": "string",
"description": "Unique and random ID to be generated by the client, for each request. In UAT, this value should always start with ‘FDR’. In Production env. the pattern will be different."
},
"ResponseCode": {
"type": "string"
},
"ResponseReason": {
"type": "string"
}
}
}
}
}