Silverflow Fees API is one of 50 APIs that Silverflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Fees. 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
2 operations
across 2 paths,
and defines 95 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.
The identity and technical contract details declared by the specification.
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…
currencyCodeEnum
string
The three-letter ISO code of the currency. European ISO Currency Codes | Country — Currency | Code | Numeric | Minor Units | | ------------------ | ---- | ----…
amountValueInteger
number
The amount in minor units. For example $12.34 should be encoded as 1234. Note that not all currencies have 2 minor units. Some have three or zero.
numberOfTiers
integer
The number of tiers defined for this fee.
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…
SchemeFeeRequest
object
The request body format for a scheme fee estimation
5 properties
5 required
components-schemas-order
string
The method used to place the order.
components-schemas-terminalEntryMode
string
Required when cardEntry is terminal. This field indicates the method used for PAN entry on the terminal to initiate the transaction.
softPosTerminalCapability
string
BancontactFeeDesignator
object
2 properties
value
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…
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…
NonTieredBillingAmountTier
TieredBillingAmount
object
1 property
1 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…
baseTerminal
object
1 property
1 required
TieredFeeProperties
object
4 properties
4 required
schemas-errorType
string
A relative URI reference, this property can be used to perform automated error handling.
feeDescription
string
The Mastercard "Event description" or the Visa "Description", as they appear on the corresponding invoices.
openapi_components-schemas-currencyCode-4
string
The three-letter ISO code of the currency. European ISO Currency Codes | Country — Currency | Code | Numeric | Minor Units | | ------------------ | ---- | ----…
TieredEnum
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…
openapi_components-schemas-acceptorKeyRef
string
Uniquely identifies a Merchant Acceptor.
AcceptorKey
string
Uniquely identifies a Merchant Acceptor.
errorTitle
string
A short, human-readable summary of the problem type. It does not change from occurrence to occurrence of the error.
components-schemas-sequence
string
Required for recurring charges. This field indicates whether a charge is part of a recurring sequence. The initial charge of a recurring sequence should be fla…
PublicFee
object
1 required
TieredBillingAmountTierProperties
object
3 properties
1 required
TieredFee
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…
BusinessServiceArrangement
object
5 properties
3 required
BaseFeeRateTier
object
2 properties
2 required
InterchangeFeeEstimateResponse
object
Estimated value under conditions of dates
5 properties
5 required
AmountRequest
object
An amount encoded as an object with a value in minor units and a currency code.
2 properties
2 required
BaseFee
object
6 properties
4 required
NonTieredBillingAmount
object
1 property
1 required
CardNetworkMismatchErrorDetails
object
5 properties
5 required
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…
terminal
object
Details about the terminal.
components-schemas-cardNetwork
string
The card network
tierNumber
integer
The logical (1-based) tier number.
BaseFeeRate
object
2 properties
1 required
intent
string
The intention of the cardholder.
schemas-ThreeDsAuthentication
string
3DS settings
VisaFeeDesignator
object
2 properties
1 required
openapi_components-schemas-cardEntry-2
string
The method used to capture the card details.
openapi_components-schemas-cardEntry
string
The method used to capture the card details.
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…
BaseSchemeFeeEstimate
object
The scheme fee estimation.
2 properties
1 required
NotFoundErrorDetails
object
5 properties
5 required
NonTieredFee
A non-tiered scheme fee estimate.
openapi_components-schemas-pan-2
string
Full digits of a card
payoutType
string
- online-gambling - payouts of online casino winnings - general-funds-disbursement - generic funds disbursement transaction used to push funds from a business…
FloatAmount
object
An amount encoded as an object with a value in minor units and a currency code.
2 properties
2 required
NonTieredEnum
string
The type of tiering. The value none indicates that this fee is not tiered.
InterchangeFeeEstimateRequest
object
Elements required to construct an authorization request
7 properties
6 required
BancontactAdditionalNetworkProperties
object
1 property
TieredFeeRateTierProperties
object
3 properties
1 required
openapi_components-schemas-ChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
2 required
NonTieredFeeBillingAmount
NonTieredFeeProperties
object
3 properties
3 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…
NonTieredFeeRate
object
A (non-tiered) fee rate.
1 property
1 required
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
schemas-amountValue
integer
The amount in minor units. For example $12.34 should be encoded as 1234. Note that not all currencies have 2 minor units. Some have three or zero.
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…
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
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
IntegerAmount
object
An amount encoded as an object with a value in minor units and a currency code.
2 properties
2 required
PublicSchemeFeeEstimate
The scheme fee estimation.
PublicSchemeFeeEstimateFees
object
1 property
1 required
BaseBillingAmount
object
The actual billing amount for this fee, denominated in the feeRate currency (if defined) or the sourceAmount currency.
1 property
1 required
MastercardFeeDesignator
object
2 properties
2 required
FeeSegments
object
Segments of which the total interchange fee is made up
5 properties
errorInstance
string
A reference that identifies the specific occurrence of the error. The instance is unique for every error.
schemas-ProblemDetail
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
ConversionRate
object
5 properties
5 required
errorStatus
integer
The HTTP status code generated by the origin server for this occurrence of the problem.
terminalCapability
string
feeId
string
The Mastercard "Event ID" or the Visa "Billing line", as they appear on the corresponding invoices.
errorDetail
string
A human readable explanation specific to this occurrence of the problem.
BaseBillingAmountTier
object
2 properties
2 required
openapi_components-schemas-currencyCode-5
string
The three-letter ISO code of the currency. European ISO Currency Codes | Country — Currency | Code | Numeric | Minor Units | | ------------------ | ---- | ----…
components-schemas-ChargeType
object
Describes the kind of charge the merchant wants to submit.
7 properties
3 required
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…
floatAmountValue
number
The amount in minor units with decimal precision. For example $0.345 should be encoded as 34.5. Note that not all currencies have 2 minor units. Some have thre…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Silverflow publishes across the network.
