Silverflow Retrieve Reports API
The Retrieve Reports API from Silverflow — 3 operation(s) for retrieve reports.
Silverflow Retrieve Reports API is one of 50 APIs that Silverflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Retrieve Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 3 operations across 3 paths, and defines 141 schemas. It is described by OpenAPI 3.2.0, at version 1.417.0.
Requests are made against 3 base URLs: https://eu-west-1.api.silverflow.com/v1, https://us-east-2.api.silverflow.com/v1, https://eu-west-1.api-sbx.silverflow.com/v1.
3 operations
3 paths
141 schemas
3 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Silverflow Retrieve Reports API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (ApiKey).
It accepts HTTP bearer tokens (JWT) (BearerToken).
An API key is passed in the header as - (MutualTLS).
By default, every request must be authenticated.
ApiKey— The primary method of authenticating to the Silverflow API is through API keys. API keys can be created by calling the [createApiKey](operation/createApiKey) e…BearerToken— Bearer tokens are temporary security credentials that can be used to authorize 'third parties' (bearers) access to the Silverflow API on behalf of the agent. T…MutualTLS— The client must set up mTLS connection with a valid X.509 client certificate signed by a customer-provided CA (certificate authority) that is registered to a s…
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Retrieve Reports 3
GET
/reports
List Reports
GET
/reports/{reportKey}
Get Report
GET
/reports/{reportKey}/file
Get Report File
Schemas 141
The contract defines 141 schemas that model the data the API accepts and returns. The most detailed are schemas-BaseFee (24 properties), PublicReport (10 properties), InputValidationError (6 properties), ReportNotFoundErrorDetails (5 properties). Each schema is shown below with its type and property counts.
sourceAmountValue
string
The source amount value, encoded as string. If this value holds a fraction, it will use a . "dot" as decimal separator. Note that it may hold up to 11 decimals…
chargesReportParameters
object
The query parameters used for a report.
2 properties
2 required
merchantAcceptorKey
string
The unique ID of the Merchant Acceptor for which this fee has been calculated.
schemas-NonTieredBillingAmountTier
object
components-schemas-version
integer
The version of this object
reportName
string
schemas-TieredFee
object
A tiered scheme fee estimate. A tiered fee defines multiple fee rates. When tiering is set to count the applicable tier is selected based on the total number o…
4 properties
2 required
openapi_components-schemas-merchantKey
string
The unique ID of the Merchant for which this fee has been calculated.
Fee
object
A scheme fee estimate.
1 required
reconciliationDetailsReportByCreatedTimeParameters
object
The query parameters used for a report.
2 properties
2 required
schemeFeeDetailsReportMimeType
string
The mime-type in which the scheme fee details report is available.
VisaQuarterlySchemeReport
object
A Visa Quarterly Scheme report
3 properties
3 required
above
integer
This field indicates the value above which this tier applies. If tiering is set to volume, this value indicates the total sourceAmount (in feeRate currency). I…
components-schemas-offsetToken
string
currency
string
Specifies the currency in which the report will be generated.
schemeFeeDetailsReportParameters
object
The query parameters used for a report.
2 properties
1 required
ConversionRates
array
A list of conversion rates, used to convert the sourceAmount into the convertedSourceAmount. This list is only present if currency conversion was applied. Curr…
schemas-moreItems
boolean
Boolean indicating if there are more items to retrieve
SettlementDetailsReportByNftKeyParameters
object
The query parameters used for a report.
1 property
1 required
schemas-numberOfTiers
integer
The number of tiers defined for this fee.
upToIncluding
integer
This field indicates the value up to (including) which this tier applies. If tiering is set to volume, this value indicates the total sourceAmount (in feeRate…
bookDateTo
string
Include all scheme fees that have been created earlier than and including from the date specified.
NotAuthorizedErrorDetails
object
5 properties
5 required
sourceAmountImpact
string
The impact of the source amount. This value has no relation to the the direction of the funds of the transaction. By default every amount will have the impact…
AgentKey
string
Uniquely identifies an Agent
disputeHistoryEventsReportMimeType
string
The mime-type in which the disputes report is available.
schemas-TieredFeeRate
object
A tiered fee rate defines multiple fee rates or tiers. Tier applicability is determined by the upToIncluding and above values. For a fee with tiering set to co…
1 property
1 required
ListReportResponse
object
3 properties
2 required
schemas-BaseBillingAmount
object
1 property
1 required
AMMFReportName
string
The name of the report.
NetworkFundsTransfersReport
object
A network funds transfers report.
4 properties
3 required
feeDescription
string
The Mastercard "Event description" or the Visa "Description", as they appear on the corresponding invoices.
openapi_components-schemas-actionReference
string
The action reference of the action for which this fee has been calculated. Only present if a reference field was specified on the Charge action API call.
bookDate
string
The timestamp of which the scheme fee estimate was booked.
networkFundsTransferKey
string
Uniquely identifies a Networks Funds Transfer
MastercardQuarterlySchemeReportName
string
schemas-tierId
string
The (optional) Mastercard "Tier ID" for this fee, as it appears on the Mastercard invoice. Note that the presence of this field does not indicate if this fee h…
fraudNotificationsReportParameters
object
The query parameters used for a report.
2 properties
errorTitle
string
A short, human-readable summary of the problem type. It does not change from occurrence to occurrence of the error.
networkFundsTransfersReportParameters
object
The query parameters used for a report.
1 property
1 required
noTiering
string
The type of tiering. The value none indicates that this fee is not tiered.
SettlementDetailsReportName
string
The name of the report.
schemas-InvalidOffsetTokenError
object
5 properties
5 required
ammfAcquirerIdCode
string
the Acquirer Institution ID. For Visa, this is the BIC. It should be a 6-digit numeric value.
schemas-TieredFeeRateTier
object
3 properties
1 required
schemas-bin
string
The value of the BIN for which this fee has been calculated.
schemas-NonTieredFee
object
A non-tiered scheme fee estimate.
3 properties
1 required
ReportNotFoundErrorDetails
object
5 properties
5 required
AMMFReportParameters
object
The parameters used for the AMMF Report.
3 properties
2 required
SettlementDetailsReport
object
A SettlementDetails report.
3 properties
3 required
chargesReportMimeType
string
The mime-type in which the Charges report is available.
chargeActionKey
string
The unique ID of the Charge Action for which this fee has been calculated. Only present if category is set to authorization or clearing.
feeRateImpact
string
The impact of the fee.
ammfReportMimeType
string
The mime-type in which the AMMF Report is available.
openapi_components-schemas-ProblemDetail-2
object
The 'problem detail' object relays detailed information about the error that occurred. It is defined by [RFC 7807 - Problem Details for HTTP APIs](https://tool…
5 properties
NetworkFundsTransfersReportName
string
The name of the report.
schemas-NonTieredFeeRateTier
object
currencyRateValue
string
The currency rate (decimal) value, encoded as string. If this value holds a fraction, it will use a . "dot" as decimal separator. Note that it may hold up to 1…
schemas-NonTieredFeeRate
object
A (non-tiered) fee rate.
1 property
1 required
schemas-BaseBillingAmountTier
object
2 properties
2 required
billingAmountImpact
string
The impact of the billing amount.
openapi_components-schemas-lastModified
string
The date and time this object was last modified
reportStatus
string
The status of the report.
SettlementDetailsReportByCreatedTimeParameters
object
The query parameters used for a report.
2 properties
1 required
schemas-TieredBillingAmountTier
object
3 properties
1 required
UnsupportedMimeTypeErrorDetails
object
5 properties
5 required
key
string
The unique ID of this scheme fee estimate.
TransactionFeesReportName
string
The name of the report.
FraudNotificationsReport
object
A fraud notifications report.
3 properties
3 required
SchemeFeeDetailsReport
object
A scheme fee details report.
3 properties
3 required
MastercardQuarterlySchemeReport
object
A Mastercard Quarterly Scheme report
3 properties
3 required
year
integer
The year for which the report is being generated. It should be a four-digit number (e.g., 2023).
VisaQuarterlySchemeReportName
string
schemas-BaseFee
object
24 properties
15 required
Report
object
openapi_components-schemas-chargeKey
string
The unique ID of the Charge for which this fee has been calculated. Only present if category is set to authorization or clearing.
billingAmountValue
string
The billing amount (decimal) value, encoded as string. If this value holds a fraction, it will use a . "dot" as decimal separator. Note that it may hold up to…
reconciliationDetailsReportByNftKeyParameters
object
The query parameters used for a report.
1 property
1 required
disputeHistoryEventsReportParameters
object
The query parameters used for a report.
2 properties
2 required
networkFundsTransfersReportMimeType
string
The mime-type in which the network funds transfers report is available.
DisputeHistoryEventsReport
object
A disputes history events report.
3 properties
3 required
billingFrequency
string
The frequency or interval at which this fee is witheld from settlement (or invoiced separately). This frequency also defines the aggregation period for tiered…
SchemeFeeDetailsReportName
string
The name of the report.
InputValidationError
object
6 properties
6 required
ChargesReport
object
A Charges report.
3 properties
3 required
FraudNotificationsReportName
string
The name of the report.
quarter
integer
Specifies the quarter of the year for the report. Valid values are 1 (Q1), 2 (Q2), 3 (Q3), and 4 (Q4).
ChargesReportName
string
The name of the report.
quarterlySchemeReportMimeType
string
The mime-type in which the Quarterly Scheme Report is available.
openapi_components-schemas-mid
string
The value of the MID for which this fee has been calculated.
fraudNotificationsReportMimeType
string
The mime-type in which the fraud notifications report is available.
ReconciliationDetailsReport
object
A reconciliation details report.
4 properties
3 required
reportKey
string
Uniquely identifies a report object
AmmfReport
object
An AMMF report.
3 properties
3 required
openapi_components-schemas-created-2
string
The date and time this object was created
openapi_components-schemas-transactionReference
string
The transaction reference of the transaction for which this fee has been calculated. Only present if a transactionReference field was specified on the 3DS or C…
SettlementDetailsReportMimeType
string
The mime-type in which the SettlementDetails report is available.
openapi_components-schemas-ValidationError
object
3 properties
3 required
schemas-ConversionRate
object
5 properties
5 required
conversionRateDate
string
The date of the conversion rate. Conversion rates are published (daily) by the card schemes. The method of publication introduces certain delays. Hence, this d…
feeRateValue
string
The value of the fee rate, encoded as string. If this value holds a fraction, it will use a . "dot" as decimal separator. Note that it may hold up to 11 decima…
schemas-BaseFeeRate
object
2 properties
1 required
schemas-BaseFeeRateTier
object
2 properties
2 required
ammfDirectSubmission
boolean
set to true to indicate that the AMMF report should be directly submitted to Visa's AMMF service
openapi_components-schemas-cardNetwork-2
The card network imposing the fee.
SchemeFeeDetailsReportFile
array
The JSON format of the scheme fee details report.
reportScheduleKey
string
Uniquely identifies a report schedule object
errorInstance
string
A reference that identifies the specific occurrence of the error. The instance is unique for every error.
components-schemas-reference
string
Unique ID used to identify a report.
SettlementDetailsReportParameters
errorStatus
integer
The HTTP status code generated by the origin server for this occurrence of the problem.
scheme-fee-details_currency
string
The currency.
feeId
string
The Mastercard "Event ID" or the Visa "Billing line", as they appear on the corresponding invoices.
operation
string
reconciliationDetailsReportParameters
bookDateFrom
string
Include all scheme fees that have been created later than and including from the date specified. Required when querying with book dates.
volumeCountTiering
string
The type of tiering. The value volume indicates that the applicable fee tier is determined using the total sourceAmount for a given period. The value count ind…
ReconciliationDetailsReportName
string
The name of the report.
MerchantPayoutReportName
string
The name of the report.
SourceAmount
object
The source amount of the transaction event, in either the original (transaction) currency or the settlement currency. This amount is the amount to which the fe…
3 properties
3 required
schemas-NonTieredBillingAmount
object
The actual billing amount for this fee, denominated in the feeRate currency (if defined) or the sourceAmount currency.
1 property
1 required
openapi_components-schemas-binKey
string
The unique ID of the BIN for which this fee has been calculated.
distributionKey
string
Uniquely identifies a distribution object
errorDetail
string
A human readable explanation specific to this occurrence of the problem.
DisputeHistoryEventsReportName
string
The name of the report.
threeDsKey
string
The unique ID of the 3DS for which this fee has been calculated. Only present if category is set to authentication.
clearingArn
string
The unique (clearing) ARN for which this fee has been calculated. Only present if category is set to clearing.
openapi_components-schemas-agentKey
string
The unique ID of the Agent (platform tenant) for which this fee has been calculated.
PublicReport
object
A report entity.
10 properties
5 required
schemas-TieredBillingAmount
object
The actual billing amount for this fee, denominated in the feeRate currency (if defined) or the sourceAmount currency.
1 property
1 required
InterchangeFeeDowngradeAdvicesReportName
string
The name of the report.
feeRateType
string
The type of fee. The value fixed indicates that the value field holds a fixed fee amount, denominated in the specified currency. The value basisPoints indicate…
errorType
string
A relative URI reference, this property can be used to perform automated error handling.
ConvertedSourceAmount
object
The source amount denominated in the feeRate currency. This field is only present when currency conversion has been applied. Currency conversion is only applie…
3 properties
3 required
openapi_components-schemas-acquirerIdCode
string
The value of the Acquirer ID Code for which this fee has been calculated. For Mastercard, this field corresponds to the Acquirer ICA. For Visa, this field corr…
MastercardQuarterlySchemeReportParameters
object
The parameters used for the MastercardQuarterlySchemeReport.
5 properties
5 required
reconciliationDetailsReportMimeType
string
The mime-type in which the reconciliation details report is available.
feeDate
string
The fee date. This is the date (and time) of the event for which this fee was incurred. Formatted as [ISO 8601 Date](https://en.wikipedia.org/wiki/ISO8601) and…
schemas-Result
object
The result properties of generating the report.
3 properties
1 required
VisaQuarterlySchemeReportParameters
object
The parameters used for the VisaQuarterlySchemeReport.
5 properties
5 required
schemas-tierNumber
integer
The logical (1-based) tier number.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Silverflow 12
Other APIs Silverflow publishes across the network.
Silverflow 3DS Authentication API
Silverflow Agents API
Silverflow AMMF Submission Events API
Silverflow API Keys API
Silverflow BEP Authentication API
Silverflow Bins API
Silverflow Card Info API
Silverflow Card Management API
Silverflow Card Network Reports API
Silverflow Charge Actions API
Silverflow Charges Events API
Silverflow Charges Reports API
#Retrieve Reports
Where this information came from
This is an independent, third-party profile of Silverflow Retrieve Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.