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 documentation.
| Drawio | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Table of Contents |
|---|
Find settlement
...
Resource | |
Service |
|
Response |
Get by financial source
| Status | ||||
|---|---|---|---|---|
|
For settlement created with a list of financial sources (a list of organizations), each of the given financial sources may query settlements where they have been added without knowing the buyers ID. Read more about this feature here.
...
Resource | |
Service |
|
Response |
Send intention
...
The flow for intentions could be something like this:
...
Search settlement with buyerID
...
If settlement exists
The settlement contains information on the broker intention (and much more) and can be used in deciding flow and sending intention back to the broker
Send the intention on that settlement as shown above
If no settlement exists
...
Build a complex intention request, containing the properties, buyers and organizationID of the broker, based on the purchase contract
...
Send the intention to our intention endpoint (as shown below)
When sending a complex intention, the service try’s to find a matching settlement. If no match is found, a proxy settlement is created. A proxy settlement is a bank created settlement that will serve as a handler for future communication with broker through AFPant. The service will check AKELDO to verify that the organization is able to consume intention messages from bank, or returns an error message.
...
The request will return a response immediately with the settlementID of the proxy settlement
...
In the background
This service will send the bank intention to the broker and wait for response
Once the response is received, the result will be populated onto the proxy settlement and a event is created to notify the bank about the response.
...
Wait for broker response (polling for events or getting status of proxy settlement)
This process is dependent on the polling frequency of both the producer and consumer of messages on the Altinn channel. Response is expected within a few seconds (at least 3 seconds)
...
Once the response from the broker is available, the response will be available on the proxy settlement created.
...
Deciding whether to generate a digital or paper pantedokument (mortgage document)
Intention from Bank
The bank will assess a settlement, and provide an intention. The intention contains information whether the bank supports a digital flow or not as well as priority and amount information.
...