Page Comparison

This is a brief description of the API calls most commonly used by brokers. For full details about the request and response payloads, se the swagger documentation.

Create settlement

A settlement is created by the broker to provide information to the bank and to create a channel where all parties can communicate and share documents.

...

Monitoring settlements

The Event resource provides a rich functionality for monitoring the portfolio of settlements for a broker. It provides a list of recent events with good filtering possibilities. Events can be found by querying with either a timestamp, eventid or settlementId. If your search returns 500 records (max records returned), use ‘fromEventId’ to get the more records in a new request. This is much easier than iterating over all “open” settlements to detect changes.

Event types

To see a list of event types follow this link: swagger documentation.

Querying for all events

Querying with filtering

To get only new events since the last check, use either the last retrieved eventid or a timestamp as query parameter.

For a full list of filtering and sorting options, check the swagger documentation.

Validate flow

This service can be used to validate if this property can be part of a settlement with electronic flow. To see a list of rules that are applied, please follow this link: Validate flow rules

Monitoring the service

As a client, you might be interested if the service is fully operational.

The ping resource will tell you the details about the status of the system.