Get Report File
Returns the Report data as a downloadable file. This will return a 307 (redirect) status code, redirecting the request to the location of the file.
To optimize the file download, the contents are gzip encoded. The Response contents need to be unzipped.
Not every report is in application/json format, thus there aren't response schema's available for every report type.
The file URL the request is redirected to, will remain available for 1 hour. After this time, you need to call this endpoint to generate a new URL. Make sure your HTTP client is configured to follow redirects, so you can correctly obtain the file.
Requires one of the following permissions depending on the report:
- reports:Download
- reports:DownloadSchemeFeeDetails
- reports:DownloadReconciliationDetails
- reports:DownloadQuarterlySchemeReport
- reports:DownloadNetworkFundsTransfers
- reports:DownloadCharges
- reports:DownloadFraudNotifications
- reports:DownloadDisputeHistoryEvents
Please check our detailed reporting guide including best practices integration and other considerations here.
Request
- Base URLhttps://eu-west-1.api.silverflow.com/v1
- Auth
- HTTP basic
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Uniquely identifies a report object
Response
The report is not available to download yet
Changes
No recorded changes to this operation across all 1 revision of this API.