SWswissfintechinnovations
Mortgage Offers

Get the details of a specific offer

Changed on

Get the details of a specific offer for a specific placed application.

get/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/offers/{offerId}

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/offers/{offerId}
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://example.com/oauth/authorize
      Token URL: https://example.com/oauth/token scopes: read, write

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.

offerIdstring uuid required

Uuid v4 of the specific order.

Example:4bf92636-14a0-4511-98e2-acfde576e644

Uuid v4 of the offer.

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

{
  "offer": {
    "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"
  }
}

Changes

  • 735bf0a87227Revision changes
    • info

      api operation id getApplicationFinancingRequestOffer was added

  • 13f87d5f5f25Revision changes
    • breaking

      added the new path request parameter applicationId

    • breaking

      added the new path request parameter financingRequestId

    • breaking

      added the new path request parameter offerId

    • warning

      deleted the path request parameter Application ID

    • warning

      deleted the path request parameter Financing Request ID

    • warning

      deleted the path request parameter Offer ID