The identity and technical contract details declared by the specification.
authorizationIsoFields
Object containing the raw values from the ISO8583 response message received from the network.
components-schemas-expiryYear
integer
The year the card expires including the century
ForeignRetailerDisabled
object
Transaction does not involve a foreign retailer
1 property
1 required
AuthorizationStatus
string
Authorization status of the charge.
WipType
object
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…
FundingAddressInputForReceiver
object
A physical postal address.
6 properties
1 required
openapi_components-schemas-stateOrProvince
string
The state (US) or province (non-US) of the address.
MitChargeType
object
Describes the kind of charge the merchant wants to submit.
3 properties
3 required
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
FundingReceiverInput
object
Details of the recipient of the funds.
8 properties
4 required
MastercardInitialTransactionReference
object
2 properties
1 required
schemas-ResolverByAcceptorKey
object
Used to select a merchant acceptor by key.
1 property
1 required
ScaWip
object
4 properties
3 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…
MitChargeResponse
object
The created charge.
21 properties
11 required
MitFundingCardEntry
string
The method used to capture the card details.
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…
openapi_components-schemas-city
string
The city of the address.
DinersInitialTransactionReference
object
3 properties
3 required
AuthenticationOutOfScope
object
3 properties
3 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
components-schemas-CountryCodeAlpha3
object
1 property
1 required
openapi_components-schemas-created
string
The date and time this object was created
schemas-countryCodeAlpha2
string
isoFieldResponseCode
string
Contents of field 39
subMerchant
object
Submerchant information used in the Payment Facilitator set-up. If present, will override any subMerchant information present on the Merchant Acceptor. DISCOVE…
2 properties
AuthenticationExempt
object
3 properties
3 required
avsResult
string
The result of the AVS verification
FundingIntent
string
The intention of the cardholder
components-schemas-Address
object
A physical postal address
6 properties
4 required
ValidationError
object
3 properties
2 required
ReferencedEntityNotFoundErrorDetails
object
5 properties
5 required
MitFromInitialChargeOrder
string
The method used to place the order.
IncompatibleMccErrorDetails
object
5 properties
5 required
authorizationIsoFieldsVisa
AccountNumber
string
The account number.
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.
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
allowPartialApproval
boolean
Indicates whether to allow partial approvals for this charge. If set to true the charge's and the authorization action's amount field will contain the approved…
ScaMit
object
3 properties
3 required
threeDsCryptogram
string
The 3DS cryptogram provided by the digital wallet. It must be encoded in base64 format (40 bytes).
isoFieldRetrievalReferenceNumber
string
Contents of field 37
threeDsComplianceReason
string
Indicates the reason for the SCA compliance.
schemas-version
integer
The version of this object
components-schemas-pan
string
Full digits of a card
ChargeAuthenticationWip
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
MitFromInitialChargeType
object
Describes the kind of charge the merchant wants to submit.
3 properties
3 required
AmexInitialTransactionReference
object
1 property
1 required
components-schemas-lastModified
string
The date and time this object was last modified
NonMatchingIdempotentRequestErrorDetails
object
5 properties
5 required
riskAssessmentKey
string
Key that was returned by the transaction risk assessment.
UnexpectedSequenceErrorDetails
object
5 properties
5 required
IncompatibleCardErrorDetails
object
5 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.
schemas-acceptorRoute
string
Route key used to uniquely reference an acceptor when used in combination with its card network and merchant key.
schemas-cvc
string
The CVC of the card For Mastercard, Visa, Discover, Bancontact, and Diners the length must be 3. For American Express the length must be 4.
AuthorizationStatusWithoutPartialApproval
string
Authorization status of the charge.
authenticationValue3ds
string
Base64 encoded result value from the 3DS transaction. Note that Mastercard and Visa use a different underlying format.
openapi_components-schemas-line1
string
Address line 1
EnhancedDataShippingAddress
object
Must be provided if shipment is involved and captured on the invoice
1 property
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…
MitFundingChargeRequest
object
Create a MIT funding charge.
18 properties
6 required
MissingNetworkReferenceErrorDetails
object
5 properties
5 required
schemas-holderName
string
The name of the cardholder. In case of AVS, it will be truncated by the scheme if longer than 26 characters (Visa) or 22 characters (Mastercard). More informat…
components-schemas-CountryCodeNumeric
object
1 property
1 required
SenderReceiverOrganizationName
isoFieldSystemTraceAuditNumber
string
Contents of field 11
discoverSpecificFields
object
Discover specific ISO8583 raw values
4 properties
1 required
isoFieldEciMastercard
string
Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator".
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
schemas-InvalidRequestErrorDetails
object
5 properties
5 required
schemas-CardByProcessorTokenKey
object
2 properties
1 required
components-schemas-acceptorKeyRef
string
Uniquely identifies a merchant acceptor.
charges-funding_Identification
object
Identification used to verify sender or receiver.
2 properties
2 required
MitChargeFromInitialChargeResponse
object
The created MIT charge
22 properties
13 required
schemas-IncompatibleCardNetworkErrorDetails
object
5 properties
5 required
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
VisaInitialTransactionReference
object
1 property
1 required
chargeKey
string
Uniquely identifies a charge.
ForbiddenErrorDetails
object
5 properties
5 required
avs
boolean
Specifies whether AVS authentication should be used for the charge. When true, billingAddress is required. Not supported for Diners.
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
FundingSenderInput
object
The details of the sender of the funds. Must be provided for Visa transactions.
10 properties
3 required
expiryMonth
integer
The month the card expires. January is 1
OutputCard
object
Card data
2 properties
1 required
amexSpecificFields
object
American Express-specific ISO8583 raw values
3 properties
1 required
MitFundingThreeDsAuthentication
object
Object container for strong customer authentication.
4 properties
4 required
authorizationIsoFieldsMastercard
MitFundingChargeTypeInput
object
Describes the kind of charge the merchant wants to submit.
4 properties
4 required
MitChargeIntent
string
The intention of the cardholder. To perform an account-status for AMEX, avs has to be set to true.
CannotDetermineCardNetworkErrorDetails
object
5 properties
5 required
BillingAddress
object
The billing address of the cardholder
6 properties
1 required
TokenDetails
Further details about the token that was used. Required if type.cardEntry is token or token-on-file.
TokenDetailsDigitalWallet
AccountNumberType
string
The type of the accountNumber.
schemas-EntityNotFoundErrorDetails
object
5 properties
5 required
MitFundingThreeDsAuthenticationResult
object
A 3DS result from either the [3DS Authentication endpoint](operation/create3dsAuthentication) or an external party.
3 properties
2 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-ResolverByMerchant
object
Used to select a merchant acceptor by merchant key and an optional route.
2 properties
1 required
schemas-AddressInput
object
A physical postal address.
6 properties
4 required
ThreeDsAuthentication
object
Object container for strong customer authentication.
4 properties
4 required
isoFieldEciDiners
string
E-commerce Indicator
ThreeDsAuthenticationResult
object
A 3DS result from either the [3DS Authentication endpoint](operation/create3dsAuthentication) or an external party.
4 properties
2 required
MitFundingChargeType
object
Describes the kind of charge the merchant wants to submit.
5 properties
5 required
authorizationIsoFieldsBancontact
object
Object containing the raw values from the ISO8583 response message received from the network.
8 properties
7 required
BlockedMerchantAcceptorErrorDetails
object
5 properties
5 required
IdempotentRequestIsStillBeingProcessedErrorDetails
object
5 properties
5 required
ScaBEP
object
Object container for strong customer authentication.
4 properties
4 required
schemas-Card
This field represents the card or token information. The card credentials can either be passed directly in the request or be referenced using a key.
bancontactSpecificFields
object
Bancontact specific ISO8583 raw values
1 property
isoFieldEciVisa
string
E-commerce Indicator
WipChargeRequest
object
4 properties
1 required
EnhancedDataLineItem
object
10 properties
10 required
ForeignRetailerEnabled
object
Transaction involves a foreign retailer
2 properties
1 required
charges-funding_FundingReceiver
object
Required when type.intent is funding. Details of the recipient of the funds.
8 properties
4 required
UnauthorizedErrorDetails
object
5 properties
5 required
CreateMitChargeFromInitialChargeRequest
object
14 properties
MitChargeOrder
string
The method used to place the order.
components-schemas-acceptorKey
string
Uniquely identifies a merchant acceptor.
schemas-AcceptorResolver
object
The resolver is used to select the appropriate merchant acceptor for creating the charge. It can accept either a merchantAcceptorKey or a combination of mercha…
BEPAuthenticationResult
object
Object containing the information of a BEP transaction.
1 property
1 required
ClearingStatus
string
Clearing status of the charge
DiscoverInitialTransactionReference
object
2 properties
2 required
ThreeDsAuthenticationResultResponse
object
Object containing the information of a 3DS transaction.
2 properties
isoFieldEciDiscover
string
E-commerce Indicator
transactionReference
string
Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.
AmountInEuro
object
The amount encoded as an object with a value in minor units and a currency code. Only EUR currency is supported.
2 properties
2 required
visaSpecificFields
object
Visa specific ISO8583 raw values
7 properties
1 required
MaskedAccountNumber
string
The masked account number.
authorizationIsoFieldsDiners
WipChargeResponse
object
A charge
16 properties
12 required
MitFromInitialChargeResponseChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
3 required
schemas-eci
string
Zero-padded e-commerce indicator.
CreateMitChargeRequest
object
20 properties
5 required
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.
tokenCryptogram
string
The token cryptogram. It must be encoded in base64 format (40 bytes).
FundingAddress
object
A physical postal address
6 properties
1 required
IncompatibleCardNetworkForOperation
object
5 properties
5 required
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.
WalletDetails
object
The values to send to Bancontact to perform a Wallet Initiated Payment. The fields are in hexadecimal format as described by the Bancontact specifications.
3 properties
3 required
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
schemas-merchantKey
string
Uniquely identifies a merchant.
StoredTokenDetailsDigitalWallet
object
2 properties
1 required
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
BillingAddressInput
object
The billing address of the cardholder
6 properties
1 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.
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
MitFundingChargeResponse
object
Create a MIT funding charge.
23 properties
13 required
TooManyRequestsErrorDetails
object
5 properties
5 required
MitFromInitialChargeCardEntry
string
The method used to capture the card details.
errorDetail
string
A human readable explanation specific to this occurrence of the problem.
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.
commonIsoFields
object
2 properties
2 required
WipTypeResponse
object
4 properties
4 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
charges-funding_FundingSender
object
Details of the sender of the funds.
10 properties
3 required
SenderReceiverType
string
CardInput
object
Card data
5 properties
3 required
common_currencyCode
string
An alphabetic ISO-4217 currency code.
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
EnhancedDataDestinationAddressInput
object
Must be provided if shipment is involved and captured on the invoice
2 properties
errorType
string
A relative URI reference, this property can be used to perform automated error handling.
isoFieldNetworkCode
string
Contents of field 63, subfield 1
openapi_components-schemas-line2
string
Address line 2
UnexpectedCurrencyErrorDetails
object
5 properties
5 required
method
string
Indicates the method that was used to comply to SCA.
authorizationIsoFieldsAmericanExpress
enhancedDataInput
object
An optional object for submitting Level 2 (tax and order references) and Level 3 (granular line-item details) payment data. Providing this data can qualify tra…
11 properties
1 required
subMerchantResponse
object
Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor.
2 properties
FundingTransactionType
string
In case of a special transaction type, this allows you to specify which one. EXPERIMENTAL - cryptocurrency: A transaction involving the purchasing of cryptocur…
isoFieldAuthorizationCode
string
Contents of field 38
mastercardSpecificFields
object
Mastercard specific ISO8583 raw values
10 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Silverflow publishes across the network.