Skip to main content
Version: v3

Order of calls

LinX has various endpoints that the user can call to retrieve data. This webpage describes the order that needs to be used to call these endpoints. Some of these endpoints require data from other calls in other to execute the request. This webpage will describe each type of endpoint and what data is required.

The first type of endpoint allows users to create a consent collection. Two methods are currently supported:

  1. Starting a Consent Wizard by requesting a URL.
  2. Requesting a URL to initiate the PSD2 permission at the bank itself.

These calls will result in a Consent Collection that can be used for subsequent endpoint calls. A new GUID must be generated to uniquely identify the resulting Consent Collection.

The second type of endpoint uses a Bank export file or a Consent Collection to analyse transactions and provide requested data.

info

The Budget endpoint requires both the Profile and Aggregate outputs as an exception.

The third type of endpoint are used to view or modify Consent Collections that were created in previous steps.

Calls with no requirements​

The last type are information endpoints. These give information that is nessesary to understand the output of the other endpoints such as categories and banks. These don’t require previous calls.