Skip to main content
POST
https://finlend.fincode.software
/
api
/
v1
/
services
/
user
/
calculate-apr
[https://finlend.fincode.software/api/v1/services/user/calculate-apr](https://finlend.fincode.software/api/v1/services/user/calculate-apr)
{
  "status": "<string>",
  "data": {
    "apr": 123,
    "totalInterest": 123,
    "totalFees": 123,
    "totalAmountPayable": 123,
    "monthlyPayment": 123,
    "breakdown": {}
  }
}
Calculates the APR for a loan application, providing customers with a clear understanding of the total cost of borrowing including interest and fees.
[https://finlend.fincode.software/api/v1/services/user/calculate-apr](https://finlend.fincode.software/api/v1/services/user/calculate-apr)

Request Headers

X-Auth-Token
string
required
The JWT Access Token obtained from the /login or /refresh-token endpoint.
x-idempotency-key
string
required
Unique idempotency key for the request to prevent duplicate processing.
x-fapi-auth-date
string
required
The date and time at which the request was initiated (ISO 8601 format).
x-fapi-customer-ip-address
string
required
The IP address of the customer making the request.
x-fapi-interaction-id
string
required
Unique identifier for the interaction/session.
Content-Type
string
default:"application/json"
required
Must be application/json.

Request Body

loanAmount
number
required
The loan amount for which to calculate APR.
interestRate
number
required
Annual interest rate (as a percentage, e.g., 12.5 for 12.5%).
tenure
number
required
Loan tenure in months.
processingFee
number
Processing fee amount (if applicable).
otherFees
array
Array of other fees applicable to the loan.
loanProductId
string
Optional loan product ID to use product-specific fee structure.

Response

Returns the calculated APR and related cost information.
status
string
default:"SUCCESS"
Overall status of the API request.
data
object
APR calculation results.

Code Examples

curl --location --request POST 'https://finlend.fincode.software/api/v1/services/user/calculate-apr' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'x-idempotency-key: unique-key-12345' \
--header 'x-fapi-auth-date: 2024-01-15T10:30:00Z' \
--header 'x-fapi-customer-ip-address: 192.168.1.1' \
--header 'x-fapi-interaction-id: interaction-12345' \
--header 'Content-Type: application/json' \
--data '{
    "loanAmount": 50000,
    "interestRate": 12.5,
    "tenure": 12,
    "processingFee": 500,
    "loanProductId": "123e4567-e89b-12d3-a456-426614174000"
}'