Version Field Status Definitions Required
Required fields must be sent. If the data is not sent Ravelin will return an error.
Important
Important fields are crucial for performance.
Optional
Optional fields are additional data points that can be shared with the
card schemes, issuers, and Ravelin. These fields may impact performance or dashboard usability.
Conditional
Fields that may be required under certain conditions.
Jump to Response
POST
3ds.live.pci.ravelin.com/3ds/versionReturns the 3DS versions which the customer’s card and issuer support.
Version Request Show all
optional
Enterprise Merchants: the unique identifier for the customer used throughout Ravelin's platform. For an example of its use, see the Checkout endpoint .
PSPs: the unique identifier for the customer used on the Transaction endpoint .
This is required if you want to associate the 3D Secure authentication with the customer.
Example: "123-abc-XYZ"
Minimum length: 1
optional
Enterprise Merchants: the unique identifier for the transaction used on the Checkout endpoint .
PSPs: the unique identifier for the transaction used on the Transaction endpoint .
Required if you want to associate the 3D Secure authentication with the transaction.
Example: "123-abc-XYZ"
optional
The unique identifier for the transaction step within the transaction used only for PSP clients on the Transaction endpoint .
Example: "123-abc-XYZ"
Minimum length: 1
optional
The card scheme that will be used to recommend version for co-badged cards .
Required if you want version recommendation for a domestic card scheme (e.g. Cartes Bancaires or eftpos).
Options:
American ExpressBOV CashlinkCartes BancaireseftposDiscoverJCBMastercardVisaRavelin (sandbox only)Ravelin Domestic (sandbox only)
optional
Individual payment method identifier across the Ravelin platform. For an example of its use in this way, see the Checkout endpoint .
This can be used to associate the 3D Secure authentication with a payment method. The customerId field is also required to create this association.
It must be unique per payment method.
Example: "123-abc-XYZ"
Minimum length: 1
conditional
The Primary Account Number (PAN) of the card being used for the transaction.
If EMV Tokenisation is supported, this may be an EMV Payment Token instead of a PAN.
This field is cardholder data. Submission of this field requires PCI DSS SAQ-D certification.
Please see our PCI DSS documentation for more information.
Example: "4900000000001234"
Conditions: Either pan or paymentMethod must be provided.
conditional
Conditions: Either paymentMethod or pan must be provided.
Hide definition
required
The card ciphertext produced by the Ravelin card encryption SDK.
This field constitutes cardholder data. Submission of this field requires PCI DSS SAQ-A or SAQ-AEP certification.
Please see our PCI DSS documentation for more information.
required
The AES key ciphertext produced by the Ravelin card encryption SDK .
Minimum length: 1
required
The algorithm used to generate the ciphertexts.
Example: "RSA_WITH_AES_256_GCM"
Minimum length: 1
optional
The version of the Ravelin mobile or JavaScript SDK that performed the encryption.
Example: "0.0.13-ravelinjs"
optional
The index of the public RSA key used to encrypt the card.
optional
An identifier for the public RSA key used to encrypt the card.
Version Response Show all
The HTTP response status code.
2.1.0
2.2.0
2.3.1
The card scheme which the card uses.
Example: "Visa"
The Version Response details.
Hide definition
2.1.0
2.2.0
2.3.1
The unique identifier for tracking the transaction throughout Ravelin.
Example: "123-abc-XYZ"
threeDSServerTransID
string
2.1.0
2.2.0
2.3.1
The unique identifier (UUID) for tracking the transaction throughout the 3DS process.
Example: "c5584543-b67e-5117-bb34-3567ac6a1123"
2.1.0
2.2.0
2.3.1
Example: "https://www.example-acs.com/method-url"
versionRecommendation
string
2.1.0
2.2.0
2.3.1
Ravelin's version recommendation - the highest available 3DS protocol version up to 2.2.0 .
Example: "2.2.0"
2.1.0
2.2.0
2.3.1
The 3DS protocol versions which are available to use.
acsStartProtocolVersion
string
2.1.0
2.2.0
2.3.1
The earliest 3DS 2 protocol version that is supported by the ACS.
Example: "2.1.0"
acsEndProtocolVersion
string
2.1.0
2.2.0
2.3.1
The most recent 3DS 2 protocol version that is supported by the ACS.
Example: "2.2.0"
dsStartProtocolVersion
string
2.1.0
2.2.0
2.3.1
The earliest 3DS 2 protocol version that is supported by the directory server.
Example: "2.1.0"
dsEndProtocolVersion
string
2.1.0
2.2.0
2.3.1
The most recent 3DS 2 protocol version that is supported by the directory server.
Example: "2.2.0"
2.2.0
2.3.1
ACS Information Indicator - provides information about the ACS. The element lists all applicable values for the card range.
Options: 013DS authentication is available at the ACS 2.2.0
2.3.1 02Attempts supported by the ACS or the DS 2.2.0
2.3.1 03Decoupled authentication supported 2.2.0
2.3.1 04Whitelisting supported 2.2.0
2.3.1 05Device Binding Supported 2.3.1 06WebAuthn Authentication Supported 2.3.1 07SPC Authentication Supported 2.3.1 08Transaction Risk Analysis Exemption Supported 2.3.1 09Trust List Exemption Supported 2.3.1 10Low Value Exemption Supported 2.3.1 11Secure Corporate Payment Exemption Supported 2.3.1 80American Express Card range issued in EU/EEA. Subject to PSD2.
2.2.0
2.3.1 80Mastercard Enrolled in Smart Authentication Stand-In Service
2.2.0
2.3.1 81Mastercard Enrolled in Smart Authentication Direct
2.2.0
2.3.1 84Mastercard Supports payment authentications
2.2.0
2.3.1 85Mastercard Supports non-payment authentications
2.2.0
2.3.1 86Mastercard Supports the app device channel
2.2.0
2.3.1 87Mastercard Supports the browser device channel
2.2.0
2.3.1 88Mastercard Supports challenges using the app device channel
2.2.0
2.3.1 89Mastercard Supports challenges using the browser device channel
2.2.0
2.3.1 90Mastercard Enrolled in Identity Check Express
2.2.0
2.3.1 91Mastercard Supports Authentication Express Merchant Delegation for Identity Check Express (Type I)
2.2.0
2.3.1 92Mastercard Supports Authentication Express Low Fraud Merchant (Type II)
2.2.0
2.3.1 93Mastercard Supports Authentication Express Wallet Delegation
2.2.0
2.3.1 94Mastercard Supports Authentication Express Device Delegation
2.2.0
2.3.1
The matching card ranges for different card schemes.
Show definition
The card scheme to which the card range belongs.
Example: "Visa"
List of 3DS versions supported by the Directory Server.
acsProtocolVersions
array
List of 3DS versions supported by the Access Control Server with the corresponding ACS info indicators and method URL.
Show definition
2.1.0
2.2.0
2.3.1
3DS Version supported by the ACS.
Example: "2.2.0"
2.1.0
2.2.0
2.3.1
Example: "https://www.example-acs.com/method-url"
2.2.0
2.3.1
ACS Information Indicator - provides information about the ACS. The element lists all applicable values for the card range.
Options: 013DS authentication is available at the ACS 2.1.0
2.2.0
2.3.1 02Attempts supported by the ACS or the DS 2.1.0
2.2.0
2.3.1 03Decoupled authentication supported 2.1.0
2.2.0
2.3.1 04Whitelisting supported 2.1.0
2.2.0
2.3.1 05Device Binding Supported 2.3.1 06WebAuthn Authentication Supported 2.3.1 07SPC Authentication Supported 2.3.1 08Transaction Risk Analysis Exemption Supported 2.3.1 09Trust List Exemption Supported 2.3.1 10Low Value Exemption Supported 2.3.1 11Secure Corporate Payment Exemption Supported 2.3.1 80American Express Card range issued in EU/EEA. Subject to PSD2.
2.1.0
2.2.0
2.3.1 80Mastercard Enrolled in Smart Authentication Stand-In Service
2.1.0
2.2.0
2.3.1 81Mastercard Enrolled in Smart Authentication Direct
2.1.0
2.2.0
2.3.1 84Mastercard Supports payment authentications
2.1.0
2.2.0
2.3.1 85Mastercard Supports non-payment authentications
2.1.0
2.2.0
2.3.1 86Mastercard Supports the app device channel
2.1.0
2.2.0
2.3.1 87Mastercard Supports the browser device channel
2.1.0
2.2.0
2.3.1 88Mastercard Supports challenges using the app device channel
2.1.0
2.2.0
2.3.1 89Mastercard Supports challenges using the browser device channel
2.1.0
2.2.0
2.3.1 90Mastercard Enrolled in Identity Check Express
2.1.0
2.2.0
2.3.1 91Mastercard Supports Authentication Express Merchant Delegation for Identity Check Express (Type I)
2.1.0
2.2.0
2.3.1 92Mastercard Supports Authentication Express Low Fraud Merchant (Type II)
2.1.0
2.2.0
2.3.1 93Mastercard Supports Authentication Express Wallet Delegation
2.1.0
2.2.0
2.3.1 94Mastercard Supports Authentication Express Device Delegation
2.1.0
2.2.0
2.3.1
Feedback Was this page helpful?
Yes
No Thanks for the feedback.
If you'd like to provide more detail, please email support@ravelin.com .