This API is leveraged to create and deliver OTP as SMS for authentication or confirmation as required in the process. Hence the mobile number provided should be a valid number of the Customer, preferably the same number registered with the Bank.
API Support
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/getOtp
post /getOtp
appSecret
X-IBM-Client-Secret
(apiKey located in header)
appId
X-IBM-Client-Id
(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/fedInstantLoan/getOtp
Try this operation
Definitions
{
"type": "object",
"properties": {
"InstantLoanOTPRequest": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"userName": {
"type": "string",
"description": "For authentication purpose.Bank will share credentials of this field values."
},
"password": {
"type": "string",
"description": "For authentication purpose.Bank will share credentials of this field values."
}
}
},
"body": {
"type": "object",
"properties": {
"senderCode": {
"type": "string",
"description": "For authentication purpose.Bank will share credentials of this field values."
},
"applicationId": {
"type": "string",
"description": "The 35 characters, Sender generated application id for this loan application. Used for logging and tracking purposes. This Id will be used for later calls to get the status of the loan and to ensure idem potency of retried loan application calls. -- The application id passed in the subsequent steps will be the same one."
},
"offerId": {
"type": "string",
"description": "The 35 characters, Id associated with this offer."
},
"otpToken": {
"type": "string",
"description": "The 35 characters, String token that’s used to generate the OTP. Will resend the same OTP if the same token is passed within a particular time window."
},
"phoneNumber": {
"type": "string",
"description": "The 10-digit phone number to send this OTP to."
}
}
}
}
}
}
}
{
"type": "object",
"properties": {
"InstantLoanOTPResponse": {
"type": "object",
"properties": {
"responseCode": {
"type": "string"
},
"responseReason": {
"type": "string"
},
"OTP": {
"type": "string"
},
"applicationId": {
"type": "string"
}
}
}
}
}
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"
}
}
}
}
}