/Initiate Online Mortgage Lead

Request Endpoint

https://test-api.tbcbank.ge/v1/online-mortgages/leads
https://api.tbcbank.ge/v1/online-mortgages/leads

Authorization

Authorization TypeDescription
Bearer Tokenaccess-token should be added to Authorization header

Request Parameters

ParameterTypeDescription
url (required)stringurl from which the lead generation was initiated
realEstateCodestringreal estate type code.

The following values are allowed:
FLAT, PRIVATE_HOUSE, COUNTRY_HOUSE, LAND_PLOT, CELLAR, GARAGE, LOFT, COMMERCIAL_ESTATE, OTHER
Details are given on Classification Page
companyCodestringcode of building company (e.g m2, iBuild, etc.)
otherCompanyNamestringIn case if company is different from the list provided by the TBC Bank, building company name should be passed in otherCompanyName parameter
propertyPricestringproperty price.
propertyPriceCurrencyCodestringproperty price currency (3 digit ISO code).
The following values are allowed:
GEL, USD, EUR
downPaymentAmountnumber (decimal)amount of down payment
downPaymentAmountCurrencyCodestringdown payment currency (3 digit ISO code).
The following values are allowed:
GEL, USD, EUR
termInMonthsnumber (integer)loan term in months

Request Sample

curl --location --request POST 'https://test-api.tbcbank.ge/v1/online-mortgages/leads' \
--header 'Authorization: Bearer 9UZbzYCGmGMFJjEkOH7oEf1F1bTF' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url":"http://my.ge/myhome/ka/pr/10872462/iyideba-mshenebare-bina",
    "realEstateCode": "FLAT",
    "companyCode": "M2",
    "otherCompanyName": "",
    "propertyPrice": 196200.00,
    "propertyPriceCurrencyCode": "GEL",
    "downPaymentAmount": 19620.00,
    "downPaymentAmountCurrencyCode": "GEL",
    "termInMonths": 120
}'

Response Parameters

response contains location header with correspondins redirect URL and unique leadId of the initiated application.

Response Header

ParameterTypeDescription
locationstring (uri)URI where the client should be redirected to continue application.

Response Body

ParameterTypeDescription
redirectUrlstring (url)URI where the client should be redirected to continue application.
leadIdstring (guid)unique identifier of mortgage lead

Response Sample

{
    "redirectUrl": "https://testonlinemortgage.tbcbank.ge/calculator?leadId=8a8966b2-6782-4d7c-b160-8362481c24fb",
    "leadId": "8a8966b2-6782-4d7c-b160-8362481c24fb"
}

Error Response

In case of error, standard response in problem json will be returned.

Details can be found at Error Code Description