Silverflow Retrieve Charges API
Retrieve a single or multiple charges.
Silverflow Retrieve Charges 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 Charges. 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 191 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.
2 operations
2 paths
191 schemas
2 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Silverflow Retrieve Charges 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 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Retrieve Charges 2
Retrieve a single or multiple charges.
GET
/charges/{chargeKey}
Get Charge
GET
/charges
List Charges
Schemas 191
The contract defines 191 schemas that model the data the API accepts and returns. The most detailed are GenericCharge (25 properties), MitFundingCharge (20 properties), FundingCharge (20 properties), PayoutCharge (19 properties). Each schema is shown below with its type and property counts.
GenericCharge
object
A charge
25 properties
12 required
BaseTerminal
object
2 properties
2 required
mitFundingSca
authorizationIsoFields
Object containing the raw values from the ISO8583 response message received from the network.
POS
SoftPOS
ForeignRetailerDisabled
object
Transaction does not involve a foreign retailer
1 property
1 required
StatusPos
object
The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used.
3 properties
3 required
terminalEntryMode
string
This field indicates the method used for PAN entry on the terminal to initiate the transaction.
AuthorizationStatus
string
Authorization status of the charge.
ChargeStatus
object
The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used.
3 properties
3 required
complianceReasonBEP
string
Indicates the reason for the SCA compliance.
TransactionType
string
In case of a special transaction type, this allows you to specify which one. type.intent needs to be purchase. - cryptocurrency: A transaction involving the pu…
openapi_components-schemas-stateOrProvince
string
The state (US) or province (non-US) of the address.
isoFieldResponseCodeDescription
string
The description of the responseCode
schemas-foreignRetailer
Used for transactions fulfilled partly or fully by end seller that is in a different country than the Marketplace or Ramp Provider. VISA EXPERIMENTAL
components-schemas-offsetToken
string
FundingPayoutThreeDsAuthentication
object
Object container for strong customer authentication.
4 properties
4 required
clearingMode
string
The clearing method for the charge. - auto: The charge is cleared automatically as soon as possible. To delay clearing, provide a clearAfter timestamp. - manua…
softPosTerminalCapability
string
PayoutCharge
object
A payout charge
19 properties
12 required
purposeOfPayment
string
A code that describes the purpose of payment to classify and report the nature and purpose of the transaction. Refer to Visa documentation for country specific…
PosCharge
object
A POS charge
15 properties
11 required
openapi_components-schemas-city
string
The city of the address.
cvcResultBEP
The result of cvc verification
GetResponseChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
3 required
components-schemas-CountryCodeAlpha3
object
1 property
1 required
StatusWithoutPartialApproval
object
The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used.
3 properties
3 required
complianceBEP
string
Indicates SCA compliance of the charges
AuthenticationOutOfScope
object
3 properties
3 required
openapi_components-schemas-created
string
The date and time this object was created
schemas-countryCodeAlpha2
string
isoFieldResponseCode
string
Contents of field 39
avsResult
string
The result of the AVS verification
fundingPayoutSca
AuthenticationExempt
object
3 properties
3 required
FundingIntent
string
The intention of the cardholder
sca
components-schemas-Address
object
A physical postal address
6 properties
4 required
ValidationError
object
3 properties
2 required
atmTerminalEntryMode
string
This field indicates the method used for PAN entry on the ATM terminal to initiate the transaction.
Identification
object
Identification used to verify sender or receiver.
3 properties
2 required
authorizationIsoFieldsVisa
ChargePosType
object
Describes the kind of POS charge the merchant wants to submit.
5 properties
4 required
schemas-countryCodeNumeric
string
StoredTokenDetailsNetwork
object
2 properties
1 required
openapi_components-schemas-postalCode
string
The postal code of the address, allowing a single separating space.
MitChargeFromInitialCharge
BaseAmountBreakdown
object
A breakdown of the transaction value. All provided amounts must exactly add up to value. Providing a breakdown is only required if any other amounts besides th…
1 property
1 required
components-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.
MitFundingThreeDsAuthenticationResultResponse
object
Object containing the information of a 3DS transaction.
1 property
Charge
ScaMit
object
3 properties
3 required
isoFieldRetrievalReferenceNumber
string
Contents of field 37
threeDsComplianceReason
string
Indicates the reason for the SCA compliance.
FraudioResult
object
The result of the fraudio risk assessment.
4 properties
4 required
schemas-version
integer
The version of this object
components-schemas-lastModified
string
The date and time this object was last modified
ChargeAuthenticationBEP
object
Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.
3 properties
3 required
MitCharge
object
The created charge.
17 properties
11 required
FundingReceiver
object
Required when type.intent is funding. Details of the recipient of the funds.
6 properties
5 required
errorTitle
string
A short, human-readable summary of the problem type. It does not change from occurrence to occurrence of the error.
sequencePos
string
This property indicates that the cardholder has entered Online PIN, when required by the issuer for a Mastercard Single Tap transaction.
AuthorizationStatusWithoutPartialApproval
string
Authorization status of the charge.
AtmTerminalCapability
string
ATM terminal capabilities subset
openapi_components-schemas-line1
string
Address line 1
schemas-CountryCode
object
3 properties
3 required
clearAfter
string
If provided, clearing will not occur before this point in time. If no timezone is included, it is assumed to be UTC. The value may be at most 6 months in the f…
FundingSender
object
Details of the sender of the funds.
6 properties
5 required
components-schemas-CountryCodeNumeric
object
1 property
1 required
ResponsePosAmount
object
The amount encoded as an object with a value in minor units and a currency code. An optional breakdown can be provided to indicate specific sub-amounts.
3 properties
2 required
isoFieldSystemTraceAuditNumber
string
Contents of field 11
discoverSpecificFields
object
Discover specific ISO8583 raw values
4 properties
1 required
intentPos
string
The intention of the cardholder
ChargeClearingStatus
string
Clearing status of the charge
isoFieldEciMastercard
string
Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator".
TerminalCapability
string
ChargeAuthenticationMit
object
Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.
3 properties
3 required
PayoutChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
4 required
BepCharge
object
A BEP charge
16 properties
12 required
PayoutReceiver
object
Details of the recipient of the payout.
7 properties
sequence
string
Setting this to initial flags the charge as the initial charge in a sequence of payments.
MitChargeTypeFunding
object
Describes the kind of charge the merchant wants to submit.
5 properties
5 required
MitFundingCharge
object
A MIT funding charge
20 properties
14 required
MitAdditionalProperties
object
3 properties
payout-charge_AccountNumberType
string
The type of the accountNumber.
avsResultBEP
The result of the AVS verification
riskProvider
string
Provider for the risk check.
ChargeAuthentication
object
Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.
3 properties
3 required
orderPos
string
The method used to place the order.
ChargesPage
chargeKey
string
Uniquely identifies a charge.
ForbiddenErrorDetails
object
5 properties
5 required
MitResponseChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
3 required
dinersSpecificFields
object
Diners specific ISO8583 raw values
3 properties
1 required
ChargeAuthorizationStatus
string
Authorization status of the charge
OutputCard
object
Card data
2 properties
1 required
amexSpecificFields
object
American Express-specific ISO8583 raw values
3 properties
1 required
PayoutSender
object
The details of the sender of the payout.
7 properties
MitFundingThreeDsAuthentication
object
Object container for strong customer authentication.
4 properties
4 required
authorizationIsoFieldsMastercard
MitChargeIntent
string
The intention of the cardholder. To perform an account-status for AMEX, avs has to be set to true.
BillingAddress
object
The billing address of the cardholder
6 properties
1 required
AccountNumberType
string
The type of the accountNumber.
StatusBep
object
The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used.
3 properties
3 required
cardEntryPos
string
The method used to capture the card details.
schemas-EntityNotFoundErrorDetails
object
5 properties
5 required
isoFieldEciAmex
string
E-commerce Indicator
FundingType
string
Describes the type of funding charge. - account-to-account: Transfer funds to a specific type of account. This can be specified in the receiver. - general-fund…
schemas-AddressInput
object
A physical postal address.
6 properties
4 required
AtmCharge
object
An ATM charge (withdrawal transaction)
17 properties
13 required
FundingCardEntry
string
The method used to capture the card details.
ThreeDsAuthentication
object
Object container for strong customer authentication.
4 properties
4 required
isoFieldEciDiners
string
E-commerce Indicator
components-schemas-Amount
object
The amount encoded as an object with a value in minor units and a currency code.
2 properties
2 required
authorizationIsoFieldsBancontact
object
Object containing the raw values from the ISO8583 response message received from the network.
8 properties
7 required
openapi_components-schemas-currencyCode
string
An alphabetic ISO-4217 currency code.
ScaBEP
object
Object container for strong customer authentication.
4 properties
4 required
BepChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
3 required
bancontactSpecificFields
object
Bancontact specific ISO8583 raw values
1 property
isoFieldEciVisa
string
E-commerce Indicator
ForeignRetailerEnabled
object
Transaction involves a foreign retailer
2 properties
1 required
UnauthorizedErrorDetails
object
5 properties
5 required
MitChargeOrder
string
The method used to place the order.
components-schemas-acceptorKey
string
Uniquely identifies a merchant acceptor.
BEPAuthenticationResult
object
Object containing the information of a BEP transaction.
1 property
1 required
schemas-recurringExpiry
string
Date at which the recurring authorization expires. Required for recurring charges. Format: YYYY-MM-DD
ClearingStatus
string
Clearing status of the charge
ThreeDsAuthenticationResultResponse
object
Object containing the information of a 3DS transaction.
2 properties
isoFieldEciDiscover
string
E-commerce Indicator
FundingChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
4 required
transactionReference
string
Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.
visaSpecificFields
object
Visa specific ISO8583 raw values
7 properties
1 required
PosAuthorizationIsoFields
object
Object containing the raw values from the ISO8583 response message received from the network.
8 properties
7 required
result3DS
string
Type of 3DS authentication result.
MaskedAccountNumber
string
The masked account number.
authorizationIsoFieldsDiners
schemas-eci
string
Zero-padded e-commerce indicator.
mPOS
schemas-NameOfPeopleAndPlaces
string
InternalServerErrorDetails
object
5 properties
5 required
cvcResult
string
The result of cvc verification
StoredTokenDetails
Further details about the token that was used. Required if type.cardEntry is token or token-on-file.
initialChargeKey
string
Key of the initial charge in case of a recurring or installment transaction.
openapi_components-schemas-InvalidInputErrorDetails
object
6 properties
6 required
fraudLiability
string
Which party is liable in case of fraud.
MitFundingChargeAuthentication
object
Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.
3 properties
3 required
StoredTokenDetailsDigitalWallet
object
2 properties
1 required
responseCardEntry
string
The method used to capture the card details.
errorInstance
string
A reference that identifies the specific occurrence of the error. The instance is unique for every error.
components-schemas-AcceptorRef
object
Reference key and status of the acceptor
2 properties
2 required
schemas-countryCodeAlpha3
string
RiskCheckResult
object
Result of the risk check. The field is always present on a charge if a risk check was requested.
4 properties
3 required
localTransactionDateTime
string
Date and time of the transaction in the local timezone.
authorizationIsoFieldsDiscover
errorStatus
integer
The HTTP status code generated by the origin server for this occurrence of the problem.
PayoutOrder
string
The method used to place the order.
components-schemas-CountryCodeAlpha2
object
1 property
1 required
MitCardEntry
string
The method used to capture the card details.
schemas-processorTokenKey
string
The key to a card tokenized in the [Processor Tokenization](tag/Processor-Tokenization).
methodBEP
string
Indicates the method that was used to comply to SCA.
common_Amount
object
The amount encoded as an object with a value in minor units and a currency code.
2 properties
2 required
PageWithMoreItems
object
2 properties
FundingCharge
object
A funding charge
20 properties
14 required
refundedChargeKey
string
The charge key of the refunded charge. This field is only available for charges created on the [Refund endpoint](operation/refund) with createRefundCharge set…
TooManyRequestsErrorDetails
object
5 properties
5 required
FundingPayoutChargeAuthentication
object
Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.
3 properties
3 required
PayoutCardEntry
string
The method used to capture the card details.
errorDetail
string
A human readable explanation specific to this occurrence of the problem.
ResponseAmountBreakdown
AuthenticationStatus
string
Strong Customer Authentication (SCA) status of the charge
MitFromInitialChargeSequence
string
This endpoint only allows subsequent transaction of an initial charge which can be created through the /charges endpoint.
CardholderBillingAmount
Terminal
object
Details about the terminal.
FundingPayoutThreeDsAuthenticationResultResponse
object
Object containing the information of a 3DS transaction.
3 properties
1 required
commonIsoFields
object
2 properties
2 required
schemas-DynamicDescriptor
object
Field supports the merchant customizing the DBA name and city on a per-transaction basis, to allow the cardholder to recognize the business name and city on th…
2 properties
Status
object
The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used.
3 properties
3 required
common_currencyCode
string
An alphabetic ISO-4217 currency code.
schemas-recurringFrequency
integer
Number of days between recurring authorizations. Required for recurring charges.
errorType
string
A relative URI reference, this property can be used to perform automated error handling.
FundingOrder
string
isoFieldNetworkCode
string
Contents of field 63, subfield 1
openapi_components-schemas-line2
string
Address line 2
method
string
Indicates the method that was used to comply to SCA.
intentAtm
string
The intention of the cardholder for ATM transactions
InvalidToOrFromDateErrorDetails
object
5 properties
5 required
authorizationIsoFieldsAmericanExpress
posAmountValue
integer
An amount in minor units. For example $12.34 should be encoded as 1234.
isoFieldAuthorizationCode
string
Contents of field 38
mastercardSpecificFields
object
Mastercard specific ISO8583 raw values
10 properties
2 required
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 Charges
Where this information came from
This is an independent, third-party profile of Silverflow Retrieve Charges 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.