Leasing Calculator - Rent Calculate
Service Description
Garanti BBVA Leasing Rent Calculator – Calculate API lets you know monthly rent of a equipment based on given inputs.
|
API Profile |
|
|---|---|
|
Attribute |
Value |
| Name |
Leasing Calculator – Rent Calculate |
| Version | V1 |
| Synopsis |
Leasing Calculator – Rent Calculate API |
| Description |
Getting monthly rent of leasing equipment |
| Pre-Conditions |
HTTP POST method is allowed only in Leasing Rent Calculator – Calculate API |
| Authentication |
OAuth 2.0 with Client Credentials |
Before your application can access the API, it must obtain a new access token for each request. The access token can be used only one time.
Endpoint Definition
Routing information for Rent Calculator – Calculate API’s live environment
|
EndPoint SERVICE |
|
|---|---|
| URI | /garantileasing/calculator/basic/calculate/rent/v1 |
| Base URL | https://apis.garantibbva.com.tr |
Technology
|
Technology Stack / DESIGN TIME |
||
|---|---|---|
| Property | Value | Note (if exist) |
| HTTP Call Method | POST | |
| Response Content Type | application/json | |
Request
Only HTTP POST method is allowed in Rent Calculator API.
https://apis.garantibbva.com.tr:443/garantileasing/calculator/basic/calculate/rent/v1
Arguments
The list of arguments by the Rent Calculator – Calculate API to be invoked
| Name | Type | Description | Obligation |
|---|---|---|---|
| equipmentCurrencyCode | String | The currency type of asset amount | Mandatory |
| paymentPlanCurrencyCode | String | The currency type of payment amount | Mandatory |
| advanceRate | Decimal | The rate of advance payment | Mandatory |
| creditAmount | Decimal | Asset amount | Mandatory |
| maturityNum | Integer | Number of maturities | Mandatory |
Sample Request
{
"basicCalculationDTO": {
"equipmentCurrencyCode": "USD",
"paymentPlanCurrencyCode": "TL",
"advanceRate": 10,
"creditAmount": 10000,
"maturityNum": 12
}
}
Response
Leasing Rent Calculator – Calculate API returns the monthly rent of a equipment based on request parameters.
Arguments
The list of response parameters.
| Response Fields | Type | Description |
|---|---|---|
| paymentPlanCurrencyCode | String | The currency type of payment amount |
| rentAmount | Decimal | Rent amount |
| advancePayment | Decimal | Advance Payment Amount |
| maturityNum | Number | Number of maturities |
| totalRentAmount | Decimal | Total rent amount |
Sample Response
{
"result": {
"returnCode": 200,
"reasonCode": "1",
"messageText": "Success"
},
"basicCalculationDTO": {
"paymentPlanCurrencyCode": "TL",
"rentAmount": 7165.2,
"advancePayment": 8273,
"maturityNum": 12,
"totalRentAmount": 94255.4
}
}
Return Codes & Error Handling
Response codes from Rent Calculator service request
|
Code |
Description |
Type |
|---|---|---|
| 200 | OK | SUCCESS |
| 400 | Invalid Request | MISSING PARAMETERS |
| 401 | Invalid Credentials | UNAUTHORIZED |
| 405 | {http.method} Method Not Allowed | CALL METHOD ERROR |
| 429 | API plan limit exceeded | RATE LIMITING |
| 500 | Internal Server Error | SYSTEM ERROR |
Return Messages
|
CODE |
RETURN RESPONSE |
|---|---|
| 400 |
{
"result": {
"code": 400,
"info": "Invalid Request"
}
}
|
| 401 |
{
"result": {
"code": 401,
"info": "Invalid Credentials"
}
}
|
| 405 |
{
"result": {
"code": 405,
"info": "POST Method Not Allowed"
}
}
|
| 429 |
{
"result": {
"code": 429,
"info": "API plan limit exceeded"
}
}
|
| 500 |
{
"result": {
"code": 500,
"info": "Internal Server Error"
}
}
|
-
API URL : https://apis.garantibbva.com.tr
-
-
-