Silverflow Enrollments API is one of 50 APIs that Silverflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Enrollments. 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 107 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.
AmexSponsoredMerchantEnrollmentUpdate
object
Update Sponsored Merchant request for American Express.
7 properties
1 required
posDeviceDownloadIndicator
Defines how the POS device is managed/updated. In particular, describes how IIN range updates are made at the POS. Mandatory if Merchant Type is self-managed-o…
VtsEnrollmentCreate
object
Create VTS enrollment.
5 properties
2 required
AmexSponsoredMerchantEnrollmentCreate
amexCancellationReason
string
This field required when cancelling an AMEX Enrollment.
AcceptorRef
object
Reference key and status of the acceptor
2 properties
2 required
signerFirstName
string
The Seller's Authorized Signer complete first name.
ScofProgramName
string
SCOF program name.
version
integer
The version of this object
status
string
The status of the object
ExtendedNameOfPeopleAndPlaces
string
CountryCodeOnlyAlpha2
object
1 property
1 required
businessPrincipal
object
Primary contact person at the Merchant DBA location
4 properties
4 required
businessIdentificationType
string
VtsEnrollmentDetail
object
VTS specific detail.
12 properties
6 required
discoverAcquirerIdCode
string
Acquirer Institution ID code.
CountryCode
object
3 properties
3 required
mcc
string
The Merchant category.
enrollmentStatus
string
Status of an Enrollment.
ScofEnrollmentDetail
object
SCOF specific detail
7 properties
5 required
VauEnrollmentDetail
object
VAU specific detail
8 properties
8 required
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
headquarterAccountNumber
string
Headquarter account number. Required only when merchantType is outlet-reporting-to-headquarter.
amex_phoneNumber
string
The phone number for the Seller's physical location. Phone numbers must contain the international telephone country code.
acquirerBin
string
Acquirer Bin. The Bin number as assigned by the card network. For Mastercard, this is also referred to as the Acquirer Reference ID.
IssmEnrollmentArchive
object
Unenroll from ISSM and archive the enrollment
2 properties
acquirerIdCode
string
Acquirer Institution ID code. For Mastercard, this field corresponds to the Acquirer ICA. For Visa, this field corresponds to the CIB, which usually has the sa…
CountryCodeOnlyAlpha3
object
1 property
1 required
Enrollment
object
10 properties
8 required
signerDateOfBirth
string
The date of birth of the Seller's Authorized Signer, in the format .
businessIdentification
object
Business identification should be used to enroll with VTS wherever possible. Use the combination of binKey and mid for non-profit Merchants or if none of the b…
2 properties
2 required
discoverDoingBusinessAsName
string
Assumed, trade or fictitious name of the merchant.
ScofProgramType
string
ProgramType in SCOF. Please reach out to your TAM before using commerceplatformobo program type.
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 |…
DiscoverMerchantEnrollment
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 | | ------------------ | ---- | ----…
nullableBusinessRegistrationNumber
stringnull
The Seller's Tax Identification Number or their functional equivalents.
AmexSponsoredMerchantEnrollmentArchive
object
Archive Sponsored Merchant request for American Express.
2 properties
2 required
addressCreateForAmexSMApi
object
6 properties
4 required
deleteReason
string
Issm Unenrollment reason. If empty Other will be used.
discoverMerchantStatus
string
signerLastName
string
The Seller's Authorized Signer complete last name. For individuals whose name includes two or more family names (i.e. father's surname and mother's surname), a…
businessRegistrationNumber
string
The Seller's Tax Identification Number or their functional equivalents.
BaseEnrollmentCreate
object
3 properties
2 required
acquirerSegmentId
number
VAU acquirer segment identifier
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…
binKey
string
A key assigned by Silverflow to uniquely identify a Bin.
addressForAmexSMApi
object
6 properties
4 required
NameOfPeopleAndPlaces
string
AmexSponsoredMerchantEnrollment
email
string
A valid email address
Address
object
A physical postal address
6 properties
4 required
sellerDoingBusinessAsName
signerUpdate
object
Base properties for the Seller's Authorized Signer.
5 properties
AmexSponsoredMerchantEnrollmentDetail
object
AMEX Sponsored Merchant Enrollment Detail
13 properties
12 required
CountryCodeOnlyNumeric
object
1 property
1 required
addressUpdateForAmexSMApi
object
6 properties
BadRequestProblemDetail
A 'problem detail' object for Bad Request (400) errors. Extends the base ProblemDetail with a validationErrors array that provides detailed information about v…
merchantKey
string
Uniquely identifies a Merchant
enrollmentCreateType
string
Type of the enrollment. amexsm - American Express, Sponsored Merchant (Please reach out to your technical account manager to enable your production access) dis…
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 |…
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…
DiscoverMerchantEnrollmentCreate
tokenizationConfiguration
object
VTS tokenization configuration.
3 properties
3 required
IssmEnrollmentDetail
object
ISSM specific detail
6 properties
5 required
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
DiscoverMerchantEnrollmentDetail
object
Discover merchant enrollment details
19 properties
16 required
enrollmentKey
string
Uniquely identifies an Enrollment.
discoverMerchantType
string
This field identifies the type of Merchant Profile established with Discover.
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…
signerIdentificationNumber
string
The identification number of the Seller's Authorized Signer.
businessIdentificationValue
string
phoneNumber
string
An international phone number
authorizationCurrency
string
discoverMid
string
As per card network requirements, the Merchant ID assigned by the acquirer must uniquely identify a legal merchant per acquirer BIN.
enrollmentType
string
Type of the enrollment. amexsm - American Express, Sponsored Merchant (Please reach out to your technical account manager to enable your production access) dis…
signerBase
object
Base properties for the Seller's Authorized Signer.
4 properties
4 required
agentKey
string
Uniquely identifies an Agent
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Silverflow publishes across the network.
