Mortgage Offers
List all binding offers for a given financing request
Lists the offers for a transferred application and the corresponding financing request.
get/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/offers
Path parameters
applicationIdstring uuid required
The application identifier (UUID v4) defined by FI.
Example:4bf92636-14a0-4511-98e2-acfde576e644
Uuid v4 of the application request.
financingRequestIdstring uuid required
Uuid v4 of the financing request defined by FI.
Example:4bf92636-14a0-4511-98e2-acfde576e644
Uuid v4 of the financing request.
Headers
X-CorAPI-Client-IDstring required
ID of the client forwarded to the provider.
X-Correlation-IDstring required
Unique ID (defined by the caller) which will be reflected back in the response.
User-Agentstring required
Name and version of the of the Client software.
Response
OK.
Example response
{
"offerList": [
{
"financingRequestId": "4bf92636-14a0-4511-98e2-acfde576e644",
"offerId": "4bf92636-14a0-4511-98e2-acfde576e644",
"offerItems": [
{
"offerItemId": "d452083f-8316-410d-a609-d49463687329",
"product": {
"interestRateType": "libor",
"names": [
{
"description": "Fixed rate mortgage",
"language": "fr"
}
],
"productId": "4bf92636-14a0-4511-98e2-acfde576e644",
"productVariations": [
{
"duration": 5,
"rate": 0.5,
"saronperiod": "3m"
}
]
},
"trancheId": "51b017e1-5e59-4b58-a0a0-c638c87db463",
"conditions": [
{
"amortization": 1000,
"amountRange": {
"currency": "CHF",
"maxContent": "5000000",
"minContent": "1000000"
},
"conditionId": "ef737eb0-c0a7-4f44-bdeb-32ba9bd99327",
"duration": 5,
"interest": {
"currentRate": 0.5,
"base": 0.5
},
"maturityDate": "2018-04-13",
"productIdRef": "0b34cd1b-32a5-4bb7-bcc5-bf81f8f8aaf1",
"amortizations": {
"amortizationAccountNr": "IE12BOFI90000112345678",
"amortizationAmount": {
"content": "235.45",
"currency": "CHF"
},
"amortizationPeriodicity": "quarterly",
"amortizationStart": "2018-04-13",
"amortizationType": "direct"
}
}
]
}
],
"totalAmount": {
"content": "235.45",
"currency": "CHF"
},
"validTo": "2018-04-13",
"offerType": "binding"
}
]
}