SWswissfintechinnovations
Mortgage Order

Get the current status of the order

Changed on

Returns the current status of the order. An order can be in accepted rejected or pending status. In addition, further details regarding the status can be transferred.

get/mortgages/orders/{orderId}/status

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/orders/{orderId}/status
  • 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

orderIdstring uuid required

Uuid v4 of the order defined by FI.

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

Uuid v4 of an order.

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.

detailstring
status'accepted' | 'rejected' | 'pending'

Example response

{
  "detail": "Waiting for details",
  "status": "pending"
}

Changes