Loan Calculator

Service Description

Garanti Loan Calculator API helps you determine payment plan options, payment details on any available and selected loan. Simply enter requested data below to inquiry any loan amount. The calculator can be used just for General Puspose Loan for now. We are working to add more soon.

API Profile

Attribute

Value

Name Loan Calculator
Version V1
Synopsis Loan Calculator API
Description Getting monthly re-payments on a loan
Pre-Conditions HTTP POST method is allowed only in Loan Calculator API
Authentication API Key or OAuth 2.0 with Client Credentials

Before your application can access the API, it must obtain a new an access token for each request. The access token can be used only one time.

Endpoint Definition

Loan Calculator API’s development live and mock environments routing data 

EndPoint / DEVELOPMENT SANDBOX SERVICE

URI /loans/v1/paymentPlan
Base URL https://apis.garanti.com.tr:443


Technology

Technology Stack / DESIGN TIME

Property Value
HTTP Call Method POST
Response Content Type application/json; charset=utf-8


Request

HTTP POST method  is allowed only in Loan Calculator API.

https://apis.garanti.com.tr:443/loans/v1/paymentPlan

Arguments

The list of arguments by the Loan Calculator API to be invoked

Request Fields Type Description Obligation
loanType String Indicates the requested loan type Mandatory
campaignCode String Campaign code defined by Garanti Bank for firm Mandatory
loanAmount String The loan application is the total principal value borrowed from the ending bank. Mandatory
dueNum String If this parameter exists, the API returns detailed payment plan  Optional
showOnlyBestOptions String If this parameter value is true, the API returns the best payment plan options Optional

 

​Sample request for payment plan list


{
  "loanType": "2",
  "campaignCode": "TESTFIRM",
  "loanAmount": 1000
}

Sample request for detailed payment plan

{
  "loanType": "2",
  "campaignCode": "TESTFIRM",
  "loanAmount": 1000,
  "dueNum":3
}

Sample request for best payment plan options

{
  "loanType": "2",
  "campaignCode": "TESTFIRM",
  "loanAmount": 1000,
  "showOnlyBestOptions":true
}

Response  

The Loan Calculator API is return the payment plan according to request parameters

Arguments

The list of response parameters 

Response Fields

Type

      Description     
dueNum Number It is the repayment period of the loan
installmentAmount Number It is the amount of repayment of the loan periodically or for the specified periods.
monthlyInterestRate Number It is the interest rate to be used during the usage
capitalAmount Number The amount of interest, funds and taxes included in the payment schedule of the loan is subtracted from the installment amount and the principal amount to be paid that month is determined in the installment.
totalInstallmentAmount Number
 
It is the sum of all the installments to be paid in the payment plan of the credit.
advancePaymentAmount Number It is the current credit campaign commission amount.
expenseAmount Number It is the allocation fee information obtained from the cost matrix for the relevant loan
annualCostRate Number It is the annual effective interest rate
monthlyContractRate Number It includes all costs reflected as a component of the customer interest rate
interestAmount Number The amount of interest to be paid in an installment included in the payment schedule of the credit
fundAmount Number It is Resource Utilization Support Fund included in the payment plan of the credit
taxAmount Number It is the Insurance Treaty Tax included in the payment plan of the credit 
installmentNumber Number t is the repayment period of the loan
installmentDate Date The credit repayment date for the installment amount included in the payment schedule of the credit. The date format is dd.MM.yyyy
remainingCapitalAmount Number For an installment that is included in the payment plan of the loan, the remaining principal amount of the loan after the related installment payment
Total Object This parameter shows total payment plan arguments

Return Codes & Error Handling

Response codes from Send Money service request

Code

Description

Type

200 OK SUCCESS
405 {http.method} Method Not Allowed CALL METHOD ERROR
400 Invalid Request MISSING PARAMETERS
401 Invalid Credentials UNAUTHORIZED
429 API plan limit exceeded RATE LIMITING
500 Internal Server Error SYSTEM ERROR


Return Messages 

CODE

RETURN RESPONSE

401
{
 "result": {
   "code": 401,
   "info": "Invalid Credentials"
  }
}
405
{
 "result": {
   "code": 405,
   "info": "GET Method Not Allowed"
  }
}
400
{
 "result": {
   "code": 400,
   "info": "Invalid Request"
  }
}
429
{
 "result": {
   "code": 429,
   "info": "API plan limit exceeded"
  }
}
500
{
 "result": {
   "code": 500,
   "info": "Internal Server Error"
  }
}