The identity and technical contract details declared by the specification.
PinBlockIso4
object
PIN block related data in ISO-4 format.
4 properties
4 required
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
terminalEntryMode
string
This field indicates the method used for PAN entry on the terminal to initiate the transaction.
newEmvData
string
This field contains integrated circuit card (ICC) related binary data that is transmitted from the card issuer to the ICC. This field is formatted as 510 hexad…
PinBlockDataIso4
string
Contains encrypted PIN information, formatted as an ISO-4 block of 32 hexadecimal characters.
schemas-ResolverByAcceptorKey
object
Used to select a merchant acceptor by key.
1 property
1 required
softPosTerminalCapability
string
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…
AtmTerminal
object
Details about the ATM terminal.
2 properties
2 required
charges-pos_PosAuthorizationIsoFields
object
Object containing the raw values from the ISO8583 response message received from the network.
8 properties
7 required
emvData
string
This field contains integrated circuit card (ICC) related binary data that is transmitted from the ICC to the card issuer and from the card issuer to the ICC.…
expiryMonthOptional
The month the card expires. January is 1. Must be provided together with expiryYear, or omitted alongside it.
AuthenticationExempt
object
3 properties
3 required
FundingIntent
string
The intention of the cardholder
IncompatibleMccErrorDetails
object
5 properties
5 required
authorizationIsoFieldsVisa
AccountNumber
string
The account number.
ChargeResponse
object
A charge
24 properties
12 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
DccDisabled
object
DCC is not enabled for this transaction
1 property
1 required
charges-payout_AccountNumberType
string
The type of the accountNumber.
authenticationValue3ds
string
Base64 encoded result value from the 3DS transaction. Note that Mastercard and Visa use a different underlying format.
AtmTerminalCapability
string
ATM terminal capabilities subset
openapi_components-schemas-line1
string
Address line 1
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…
FundingPayoutThreeDsAuthenticationResult
object
A 3DS result from either the [3DS Authentication endpoint](operation/create3dsAuthentication) or an external party.
5 properties
3 required
scaExemptionRequest
string
This field can be used to indicate an acquirer SCA exemption request. Silverflow supports several SCA exemption request use cases, listed below: - Transaction…
charges-funding_Identification
object
Identification used to verify sender or receiver.
2 properties
2 required
chargeKey
string
Uniquely identifies a charge.
ForbiddenErrorDetails
object
5 properties
5 required
dinersSpecificFields
object
Diners specific ISO8583 raw values
3 properties
1 required
expiryMonth
integer
The month the card expires. January is 1
ChargeCreatePos
object
Create a POS charge
15 properties
5 required
TokenDetailsDigitalWallet
AtmAuthorizationIsoFields
object
Object containing the raw values from the ISO8583 response message received from the network for ATM transactions.
7 properties
6 required
ThreeDsAuthenticationResult
object
A 3DS result from either the [3DS Authentication endpoint](operation/create3dsAuthentication) or an external party.
4 properties
2 required
BlockedMerchantAcceptorErrorDetails
object
5 properties
5 required
EnhancedDataLineItem
object
10 properties
10 required
components-schemas-acceptorKey
string
Uniquely identifies a merchant acceptor.
ClearingStatus
string
Clearing status of the charge
accountSource
string
Indicates the type of account from which the funds should be withdrawn.
schemas-NameOfPeopleAndPlaces
string
IncompatibleCardNetworkForOperation
object
5 properties
5 required
fraudLiability
string
Which party is liable in case of fraud.
cardSequenceNumber
string
Distinguishes among separate cards having the same PAN. This is required if EMV tag 5F34 is present/personalized on the card chip.
schemas-merchantKey
string
Uniquely identifies a merchant.
StoredTokenDetailsDigitalWallet
object
2 properties
1 required
AtmCardInput
object
Card details for ATM transactions.
3 properties
3 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
localTransactionDateTime
string
Date and time of the transaction in the local timezone.
authorizationIsoFieldsDiscover
PayoutOrder
string
The method used to place the order.
components-schemas-CountryCodeAlpha2
object
1 property
1 required
methodBEP
string
Indicates the method that was used to comply to SCA.
CardInputWithOptionalExpiryDate
object
5 properties
1 required
PosCardInput
object
Card data
4 properties
3 required
FundingPayoutThreeDsAuthenticationResultResponse
object
Object containing the information of a 3DS transaction.
3 properties
1 required
commonIsoFields
object
2 properties
2 required
PayoutChargeRequest
object
Create a payout charge
19 properties
4 required
IncompatibleAuthenticationStatus
object
5 properties
5 required
SenderReceiverType
string
schemas-bepKey
string
Uniquely identifies a bep payment
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
UnexpectedCurrencyErrorDetails
object
5 properties
5 required
isoFieldAuthorizationCode
string
Contents of field 38
BaseTerminal
object
2 properties
2 required
authorizationIsoFields
Object containing the raw values from the ISO8583 response message received from the network.
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
FundingAddressInputForReceiver
object
A physical postal address.
6 properties
1 required
FundingReceiverInput
object
Details of the recipient of the funds.
8 properties
4 required
FundingChargeRequest
object
Create a funding charge.
20 properties
5 required
ChargeCreateAtm
object
Create an ATM charge
15 properties
8 required
components-schemas-CountryCodeAlpha3
object
1 property
1 required
openapi_components-schemas-created
string
The date and time this object was created
isoFieldResponseCode
string
Contents of field 39
StatusAtm
object
The status property provides a high-level representation of the lifecycle of an ATM charge. ATM charges do not support authentication (no 3DS).
2 properties
2 required
avsResult
string
The result of the AVS verification
components-schemas-Address
object
A physical postal address
6 properties
4 required
ValidationError
object
3 properties
2 required
ChargeCreatePosResponse
object
A POS charge
19 properties
11 required
ChargeCreateAtmResponse
object
An ATM charge
16 properties
10 required
StoredTokenDetailsNetwork
object
2 properties
1 required
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…
threeDsComplianceReason
string
Indicates the reason for the SCA compliance.
PayoutReceiverInput
object
Details of the recipient of the payout. Must be provided for Mastercard transactions.
9 properties
terminalAction
string
Indicates if the issuer requests a PIN in Single Tap mode, or switching interface.
IncompatibleCardErrorDetails
object
5 properties
5 required
ChargeCreateBEPRequest
object
3 properties
2 required
sequencePos
string
This property indicates that the cardholder has entered Online PIN, when required by the issuer for a Mastercard Single Tap transaction.
EnhancedDataShippingAddress
object
Must be provided if shipment is involved and captured on the invoice
1 property
PayoutSenderAddress
object
A physical postal address returned in payout sender responses. Fields are typed as strings without pattern validation, as payout sender address may originate f…
6 properties
4 required
SenderReceiverOrganizationName
intentPos
string
The intention of the cardholder
TerminalCapability
string
schemas-InvalidRequestErrorDetails
object
5 properties
5 required
components-schemas-acceptorKeyRef
string
Uniquely identifies a merchant acceptor.
OutputCardAtm
object
Card data for ATM transactions. ATM transactions do not support processor tokenization.
1 property
1 required
PinBlockIso0Iso1
object
PIN block related data in ISO-0 or ISO-1 format.
4 properties
4 required
MissingPosAddressErrorDetails
object
5 properties
5 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
FundingSenderInput
object
The details of the sender of the funds. Must be provided for Visa transactions.
10 properties
3 required
amexSpecificFields
object
American Express-specific ISO8583 raw values
3 properties
1 required
ChargeType
object
Describes the kind of charge the merchant wants to submit.
3 properties
3 required
charges-payout_PayoutReceiver
object
Details of the recipient of the payout.
9 properties
TokenDetails
Further details about the token that was used. Required if type.cardEntry is token or token-on-file.
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
isoFieldEciAmex
string
E-commerce Indicator
schemas-AddressInput
object
A physical postal address.
6 properties
4 required
FundingCardEntry
string
The method used to capture the card details.
ThreeDsAuthentication
object
Object container for strong customer authentication.
4 properties
4 required
VisaPayoutInitialTransactionReference
object
1 property
1 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.
ForeignRetailerEnabled
object
Transaction involves a foreign retailer
2 properties
1 required
UnauthorizedErrorDetails
object
5 properties
5 required
Dcc
Dynamic Currency Conversion (DCC) allows cardholders to see the transaction amount in their home currency at the ATM.
transactionReference
string
Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.
authorizationIsoFieldsDiners
PayoutSenderInput
object
The details of the sender of the payout. If not provided or partially provided, the missing sender information will be filled in with the details taken from th…
9 properties
tokenCryptogram
string
The token cryptogram. It must be encoded in base64 format (40 bytes).
openapi_components-schemas-InvalidInputErrorDetails
object
6 properties
6 required
BillingAddressInput
object
The billing address of the cardholder
6 properties
1 required
schemas-processorTokenKey
string
The key to a card tokenized in the [Processor Tokenization](tag/Processor-Tokenization).
schemas-intent
string
The intention of the cardholder. To perform an account-status for AMEX, either card.cvc has to be present or avs has to be set to true.
Terminal
object
Details about the terminal.
openapi_components-schemas-line2
string
Address line 2
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
posAmountValue
integer
An amount in minor units. For example $12.34 should be encoded as 1234.
mastercardSpecificFields
object
Mastercard specific ISO8583 raw values
10 properties
2 required
RequestPosAmount
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
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…
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
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…
cvcResultBEP
The result of cvc verification
ChargeRequest
object
Create a charge
21 properties
4 required
schemas-countryCodeAlpha2
string
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
ReferencedEntityNotFoundErrorDetails
object
5 properties
5 required
schemas-countryCodeNumeric
string
ScaMit
object
3 properties
3 required
components-schemas-pan
string
Full digits of a card
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
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-CountryCode
object
3 properties
3 required
components-schemas-CountryCodeNumeric
object
1 property
1 required
charges-payout_PayoutSender
object
The details of the sender of the payout.
9 properties
ChargeClearingStatus
string
Clearing status of the charge
PayoutFundingSource
string
The source of the funds for the payout. mobile-money-account is specific to Mastercard transactions. The rest are common to both networks. Required for all Mas…
FundingChargeResponse
object
Create a funding charge.
25 properties
14 required
track2Data
string
The information encoded on track 2 of the card magnetic stripe as defined in the ISO 7813 specification, including data element separator but excluding the beg…
schemas-CardByProcessorTokenKey
object
2 properties
1 required
sequence
string
Setting this to initial flags the charge as the initial charge in a sequence of payments.
orderPos
string
The method used to place the order.
fundingScaExemptionRequest
string
This field can be used to indicate an acquirer SCA exemption request. Silverflow supports several SCA exemption request use cases, listed below: - Transaction…
ChargeAuthorizationStatus
string
Authorization status of the charge
authorizationIsoFieldsMastercard
charges-payout_Identification
object
Identification used to verify sender or receiver.
3 properties
2 required
CannotDetermineCardNetworkErrorDetails
object
5 properties
5 required
BillingAddress
object
The billing address of the cardholder
6 properties
1 required
cardEntryPos
string
The method used to capture the card details.
schemas-ResolverByMerchant
object
Used to select a merchant acceptor by merchant key and an optional route.
2 properties
1 required
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…
isoFieldEciDiners
string
E-commerce Indicator
AtmAmount
object
The amount for ATM transactions
2 properties
2 required
ScaBEP
object
Object container for strong customer authentication.
4 properties
4 required
bancontactSpecificFields
object
Bancontact specific ISO8583 raw values
1 property
isoFieldEciVisa
string
E-commerce Indicator
charges-funding_FundingReceiver
object
Required when type.intent is funding. Details of the recipient of the funds.
8 properties
4 required
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…
PayoutTransactionType
string
In case of a special transaction type, this allows you to specify which one. - tax-refund: A transaction involving a tax rebate. Only allowed for payoutType of…
PinBlockDataIso0Iso1
string
Contains encrypted PIN information, formatted as an ISO-0/ISO-1 block of 16 hexadecimal characters.
PinBlockKeyId
string
Encryption key in the specified zone to use.
isoFieldEciDiscover
string
E-commerce Indicator
FundingChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
4 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.
expiryYearOptional
The year the card expires including the century. Must be provided together with expiryMonth, or omitted alongside it.
FundingAddress
object
A physical postal address
6 properties
1 required
UnexpectedMessageSystem
object
5 properties
5 required
schemas-cardEntry
string
The method used to capture the card details.
common_Amount
object
The amount encoded as an object with a value in minor units and a currency code.
2 properties
2 required
TooManyRequestsErrorDetails
object
5 properties
5 required
AuthenticationStatus
string
Strong Customer Authentication (SCA) status of the charge
EnhancedDataDestinationAddressInput
object
Must be provided if shipment is involved and captured on the invoice
2 properties
isoFieldNetworkCode
string
Contents of field 63, subfield 1
method
string
Indicates the method that was used to comply to SCA.
subMerchantResponse
object
Submerchant information used in the Payment Facilitator set-up. This overrides any subMerchant information present on the Merchant Acceptor.
2 properties
PayoutChargeResponse
object
The created payout charge
23 properties
12 required
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
AuthorizationStatus
string
Authorization status of the charge.
openapi_components-schemas-stateOrProvince
string
The state (US) or province (non-US) of the address.
isoFieldResponseCodeDescription
string
The description of the responseCode
openapi_components-schemas-city
string
The city of the address.
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
atmTerminalEntryMode
string
This field indicates the method used for PAN entry on the ATM terminal to initiate the transaction.
ChargePosType
object
Describes the kind of POS charge the merchant wants to submit.
5 properties
4 required
openapi_components-schemas-postalCode
string
The postal code of the address, allowing a single separating space.
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
ChargeAtmType
object
Describes the kind of ATM charge.
2 properties
2 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.
schemas-version
integer
The version of this object
CardWithOptionalExpiryDate
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.
components-schemas-lastModified
string
The date and time this object was last modified
NonMatchingIdempotentRequestErrorDetails
object
5 properties
5 required
ChargeCreateBEPResponse
object
A BEP charge
16 properties
12 required
riskAssessmentKey
string
Key that was returned by the transaction risk assessment.
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.
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…
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
isoFieldEciMastercard
string
Contents of field 48, subelement 42, subfield 1, also known as "UCAF Collection Indicator".
PayoutChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
4 required
avsResultBEP
The result of the AVS verification
avs
boolean
Specifies whether AVS authentication should be used for the charge. When true, billingAddress is required. Not supported for Diners.
OutputCard
object
Card data
2 properties
1 required
PinBlock
object
PIN block related data.
AccountNumberType
string
The type of the accountNumber.
IdempotentRequestIsStillBeingProcessedErrorDetails
object
5 properties
5 required
authorizationIsoFieldsBancontact
object
Object containing the raw values from the ISO8583 response message received from the network.
8 properties
7 required
BepChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
3 required
responseIntentEcommerce
string
The intention of the cardholder.
ResponseChargeType
object
Describes the kind of charge the merchant wants to submit.
4 properties
3 required
BEPAuthenticationResult
object
Object containing the information of a BEP transaction.
1 property
1 required
ThreeDsAuthenticationResultResponse
object
Object containing the information of a 3DS transaction.
2 properties
visaSpecificFields
object
Visa specific ISO8583 raw values
7 properties
1 required
result3DS
string
Type of 3DS authentication result.
MaskedAccountNumber
string
The masked account number.
schemas-eci
string
Zero-padded e-commerce indicator.
InternalServerErrorDetails
object
5 properties
5 required
PinBlockZoneId
string
ID of the encryption zone.
responseCardEntry
string
The method used to capture the card details.
errorStatus
integer
The HTTP status code generated by the origin server for this occurrence of the problem.
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.
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
CardInput
object
Card data
5 properties
3 required
charges-funding_FundingSender
object
Details of the sender of the funds.
10 properties
3 required
common_currencyCode
string
An alphabetic ISO-4217 currency code.
ChargeRefundMastercardInitialTransactionReference
object
1 property
errorType
string
A relative URI reference, this property can be used to perform automated error handling.
intentAtm
string
The intention of the cardholder for ATM transactions
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…
DccEnabled
object
DCC is enabled for this transaction
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Silverflow publishes across the network.