This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible based on their Phone Number, Account Number (with last 4 digits), Transaction/Loan Amount, and Loan Tenure combination. If the customer is eligible for Instant Loan then details as the maximum loan amount offered, EMI tenure, interest rate, processing fees, etc. will be shared.
API Support
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/getOffer/AcctNumAmt
post /getOffer/AcctNumAmt
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/getOffer/AcctNumAmt
Try this operation
Definitions
{
"type": "object",
"properties": {
"InstantLoanOffersRequest": {
"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."
},
"phoneNumber": {
"type": "string",
"description": "The 10 digit phone number registered for this user."
},
"ReqType": {
"type": "string",
"description": ""
},
"applicationId": {
"type": "string",
"description": "The 35 character unique reference number.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."
},
"maskedAccountNumber": {
"type": "string",
"description": "Last 4 digits of the account number of the user."
},
"tranAmount": {
"type": "string",
"description": "Loan amount from the user"
},
"loanTenure": {
"type": "string",
"description": "Loan tenure from the user"
}
}
}
}
}
}
}
{
"type": "object",
"properties": {
"InstantLoanOffersResponse": {
"type": "object",
"properties": {
"responseCode": {
"type": "string"
},
"responseReason": {
"type": "string"
},
"loanEligibleFlag": {
"type": "string"
},
"offerId": {
"type": "string"
},
"maxAmount": {
"type": "number"
},
"maxAllowedEMI": {
"type": "string"
},
"maxTenureMonths": {
"type": "string"
},
"interestRate": {
"type": "array",
"items": {
"properties": {
"rangeFrom": {
"type": "number"
},
"rangeTo": {
"type": "number"
},
"type": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"processingFeePercentage": {
"type": "array",
"items": {
"properties": {
"rangeFrom": {
"type": "number"
},
"rangeTo": {
"type": "number"
},
"type": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"serviceTax_GST": {
"type": "number"
},
"expiryDateTimestampSeconds": {
"type": "number"
},
"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"
}
}
}
}
}