Reports
Reports
List the reports generated for your client, filtered by type and period, then use the returned id with the get-report endpoint to obtain a download link.
GET
List reports
Retrieve the reports that have been generated for your client. This is the first step of a two-step flow: list the available reports here and copy the id of the one you want, then call the get-report endpoint to obtain a time-limited download link.
Authenticate every request with two headers provided by Flinks during onboarding: x-api-key and x-client-id.
Use filteringTypes to fetch only the reports you need. ClientSettlement is the daily settlement report and DailyProgress is the daily processing report. Narrow the results by period with startDate and endDate.
Delivery methods
Reports can be consumed in two ways:- Pull (this API): list reports, then request a time-limited download link, as described above.
- Push (SFTP): Flinks uploads the generated CSV to your SFTP server automatically, as soon as the report is produced.
SFTP delivery
SFTP is an optional, per-client delivery mechanism and can be configured for any report type. To enable it, contact Flinks and provide:- Host and port of the destination SFTP server.
- Username: Flinks authenticates with an SSH key pair (key-based authentication, no password). Authorize the Flinks public key for this user.
- Target directory for the uploaded file.
- PGP public key (optional): when supplied, the file is PGP-encrypted before upload.
Headers
API key issued by Flinks.
Your Flinks client ID.
Query Parameters
Filter by report type; repeat the parameter for multiple values.
Available options:
ClientSettlement, DailyProgress, DailyGEft, InternalMonthlyTransaction Start of the report period range in ISO 8601 format.
End of the report period range in ISO 8601 format.