- The list of accounts available in the Financial Service Provider and their associated balances and transactions
- The list of beneficiaries available in the Financial Service Provider for payouts
Integration with the Financial Service Provider
The Generic Connector interacts with the Financial Service Provider by sending requests formatted according to the Generic Connector API specifications and expecting responses formatted according to the same specifications. As a consequence, it is necessary to create a service on your side that will interact with the Financial Service Provider and expose the data with the expected format. The typical deployment of the Generic Connector is as follows:Polling mechanism
The Generic Connector uses a state-based approach for polling payment data efficiently.How it works
- The connector stores the timestamp of the last successful data retrieval
- In subsequent polls, it uses this timestamp to fetch only new or updated data
- The
UpdatedAtFromquery parameter is passed in API calls to your service - This parameter indicates that only transactions from that specific point in time should be returned
Data storage and updates
The system doesn’t fetch all data fresh every time it polls. Instead:- Each batch of data received is stored
- The internal state is updated with the latest timestamp of the data received
- In the next polling cycle, the updated timestamp is used to fetch only new or changed data
Benefits
This polling method offers several advantages:- Reduced data transfer: Only fetches new or updated information
- Minimized load: Reduces strain on both Formance and your API
- No duplicates: Ensures the database stays up-to-date without duplicating existing data
When setting up the Generic Connector, ensure that your API can handle and respond correctly to the
UpdatedAtFrom query parameter. This allows the system to efficiently retrieve only the necessary data during each polling cycle.Authentication
When instantiating the Generic Connector, you will need to pass an API key that will be used to authenticate the requests to your service. The Generic Connector will send requests with the API key in theAuthorization header so that your service can authenticate the requests.
Example: