Silverflow Merchants API is one of 50 APIs that Silverflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Merchants. 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
5 operations
across 2 paths,
and defines 91 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.
Acceptor
object
A Merchant Acceptor
30 properties
10 required
gatewayId
string
Merchant Payment Gateway ID (MPG ID). MPG ID is assigned by Mastercard at the time of registration of the MPG as a Service Provider. The value 999998 must be u…
reference
string
User-specified reference.
marketplaceId
string
Visa provided ID required for marketplaces. If provided, rampProviderId must not be provided. VISA
PreconditionFailedProblemDetail
object
5 properties
5 required
version
integer
The version of this object
amexAcquirerIdCode
string
Acquirer Institution ID code (Submitter ID). For PayFac model, this identifies the Payment Facilitator.
status
string
The status of the object
ExtendedNameOfPeopleAndPlaces
string
DisputeHandling
object
Dispute handling settings
1 property
1 required
MerchantAcceptorTemplate
object
A template object used to bulk create merchant acceptors. EXPERIMENTAL
10 properties
5 required
CountryCodeOnlyAlpha2
object
1 property
1 required
discoverAcquirerIdCode
string
Acquirer Institution ID code.
CountryCode
object
3 properties
3 required
mcc
string
The Merchant category.
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
acceptorStatus
string
The status of the Acceptor (version)
AcceptorRestrictions
array
This field is deprecated. The chargesBlocked property on the MerchantAcceptor serves as its replacement.
amexModel
string
The AMEX business model. In the PayFac model, authorization is performed using the SE Number on the BIN. In the Direct Merchant or Payment Designation model, a…
isoId
string
Unique ID assigned by the card network for the Independent Sales Organization. MASTERCARD
dxsCode
string
The dxsCode is provided to acquirers by Diners during onboarding. A unique dxsCode is provided for each IIC.
ExtendedFreeTextField
string
Clients not enrolled in the "extended character set beta" are still subject to the ^[\w +=.,:;!?$@()-]+$ pattern for field input.
CountryCodeOnlyAlpha3
object
1 property
1 required
merchantVolumeIndicator
string
The Merchant Volume Indicator (MVI) is a Visa assigned field used to classify merchants based on their Visa transaction volume. This field is optional for Visa…
AddressCreate
object
A physical postal address
6 properties
4 required
merchantStatus
string
The status of the Merchant
acceptorKey
string
Uniquely identifies a Merchant Acceptor.
countryCodeNumeric
string
The ISO code of the country. European ISO Country Codes | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 |…
amexPaymentDesignationAcquirerBin
businessType
string
The business type of the merchant. Specifying the businessType for your legal entity may qualify the merchant to benefit from lower interchange fees in the Uni…
currencyCode
string
The three-letter ISO code of the currency. European ISO Currency Codes | Country — Currency | Code | Numeric | Minor Units | | ------------------ | ---- | ----…
MerchantCreate
object
12 properties
5 required
subMerchantId
string
Unique ID assigned by the acquirer or Payment Facilitator to the subMerchant.
created
string
The date and time this object was created
MerchantMergeUpdate
object
11 properties
messageSystem
string
Determines the message structure and Data Element definitions for card network.
chargesBlocked
boolean
A value of true prohibits charges from being created using this Acceptor. If the property is absent upon Acceptor creation a value of false is assumed.
acquirerOrPayFacBusinessId
string
Unique ID assigned by the card network for the Payment Facilitator or the acquirer ( VISA ) that signed up the merchant. Note: Mastercard only uses numeric cha…
discoverAcquirerBin
string
Acquirer Bin. The Bin number as assigned by the card network.
postalCode
string
The postal code of the address. Clients not enrolled in the "extended character set beta" are still subject to the ^[A-Z0-9]+(\ [A-Z0-9])?$ pattern for field i…
Merchant
object
A Merchant acts as a template
17 properties
10 required
binKey
string
A key assigned by Silverflow to uniquely identify a Bin.
email
string
A valid email address
amexPayfacAcquirerBin
string
SE Number assigned by AMEX for the Payment Facilitator.
Address
object
A physical postal address
6 properties
4 required
CountryCodeOnlyNumeric
object
1 property
1 required
BadRequestProblemDetail
A 'problem detail' object for Bad Request (400) errors. Extends the base ProblemDetail with a validationErrors array that provides detailed information about v…
Tags
object
Optional tags provided by the agent to tag the object for maintainability. Tags can be used filtering and sorting on the list views of Disputes. A valid tag-ke…
BaseBin
object
A Bin is a Bank Identification Number
10 properties
8 required
merchantKey
string
Uniquely identifies a Merchant
acceptorRoute
string
An optional route key to force route charges
authorizationCurrencyForAmexDirectMerchant
rampProviderId
string
Visa provided ID required for ramp providers. If provided, marketplaceId must not be provided. VISA
countryCodeAlpha2
string
The ISO code of the country. European ISO Country Codes | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 |…
countryCodeAlpha3
string
The ISO code of the country. European ISO Country Codes | Country | Alpha-2 code | Numeric | | ------- | ------------ | ------- | | Åland Islands | AX | 248 |…
dinersAcquirerIdCode
string
Acquirer Institution ID code. For Diners, this field corresponds to the IIC number.
taxRegistrationId
string
A unique identifier assigned to individuals or entities for tax-related purposes. The format, name and use of this id may vary depending on the country and car…
merchantReference
string
Merchant reference number used by the Agent. Must not start with "mct-".
amexDirectMerchantAcquirerBin
acquirerAgentKey
string
Acquirer Agent Key shows the owner agent Key of the Bin.
discoverIsoId
string
Unique number assigned by Discover to a certified ISO. This field is mandatory if the direct Merchant relationship is maintained by an ISO
mid
string
As per card network requirements, the Merchant ID assigned by the acquirer must uniquely identify a legal merchant per acquirer BIN. Note: For AMEX merchant ac…
networkAssignedId
string
Unique ID assigned by the card network for the merchant. Used for example for Private Label transactions or large merchants. | Network | Length | Characters |…
lastModified
string
The date and time this object was last modified
phoneNumber
string
An international phone number
AcceptorRestriction
object
An object containing restrictions on the Merchant Acceptor
2 properties
foreignRetailer
boolean
Applicable for Visa Marketplace and Ramp Provider programs only. Indicates if the end merchant is in a different country than the Marketplace or Ramp Provider.…
authorizationCurrency
string
agentKey
string
Uniquely identifies an Agent
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Silverflow publishes across the network.
