This is a brief description of the API calls most commonly used by banks. For full details about the request and response payloads, se the swagger the swagger documentation.
| Drawio | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Table of Contents |
|---|
Find settlement
There are multiple ways of querying the Settlement API for an existing settlement.
Query by buyer
...
- Finds settlements by buyers SSN
...
Resource
...
...
Service
...
[GET] /v1/settlements?buyerPersonalNumber=<SSN>
...
Response
...
,
Query by buyer and property key
...
- Finds settlements by buyers SSN and PropertyKey
...
Resource
...
...
Service
...
[GET] /v1/settlements?buyerPersonalNumber=<SSN>&propertyKey=<####-##-###-#-#>
...
...
PagedResources<SettlementResource>
Get by financial source
Status colour Green title New feature
...
- a bank may query settlements where
...
their org.no. has been used in bidding without knowing the buyers ID
...
Resource
...
...
Service
...
[GET] /v1/settlements/?isFinancialSource=true&from=2020-01-01T00:00:00.000
...
Response
...
Parameters | Description |
isFinancialSource | Boolean parameter. If true, all active settlements where the organization of the authenticated user will be returned |
from | Filter on settlements created after a given time and date |
Get by unique identifier
...
- Each settlement have a globally unique ID that may be used for getting a specific settlement.
Resource | ||
Service |
| |
Response | SettlementResourceSwagger documentation for finding a settlement | |
Send intention
Deciding whether to generate a digital or paper pantedokument (mortgage document)
...