This API fetches an instant loan offer for a given customer identified by (phone no) if they are pre-approved. If Eligible, the tenure-based offer eligibility details are returned in response. Else it returns the appropriate error code.
API Support
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/getOffer/tenureBased
post /getOffer/tenureBased
appID
X-IBM-Client-Id
(apiKey located in header)
appSecret
X-IBM-Client-Secret
(apiKey located in header)
request
Required in body
object
request
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/tenureBased
Try this operation
Definitions
{
"type": "object",
"properties": {
"InstantLoanOffersRequest": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"serviceAccessId": {
"type": "string",
"description": "For authentication purpose."
},
"serviceAccessCode": {
"type": "string",
"description": "Bank will share credentials of this field values in UAT."
}
}
},
"body": {
"type": "object",
"properties": {
"senderCode": {
"type": "string"
},
"ReqType": {
"type": "string",
"description": "Type of request"
},
"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."
},
"phoneNumber": {
"type": "string",
"description": "The 10 digit phone number registered for this user."
}
}
}
}
}
}
}
{
"type": "object",
"properties": {
"InstantLoanOffersResponse": {
"type": "object",
"properties": {
"responseCode": {
"type": "string"
},
"responseReason": {
"type": "string"
},
"loanEligibleFlag": {
"type": "string"
},
"offerId": {
"type": "string"
},
"maxAllowedEMI": {
"type": "string"
},
"maxTenureMonths": {
"type": "string"
},
"maxAmountDetails": {
"type": "array",
"items": {
"properties": {
"tenure": {
"type": "string"
},
"maxAmount": {
"type": "string"
}
},
"type": "object"
}
},
"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"
}
}
}
}
}