3D Secure & PDS2

Add 3D Secure data or a PDS2 SCA exemption to your transaction request.

Add 3D Secure data

To add 3D Secure (3DS) data to your transaction, add the following snippet to the body of your request.

{
  "threeDSecureData": {
    "cardHolderAuthenticationVerificationValue": "AAABAURAWAAAAAAAAEBYAAAAAAA=",
    "directoryServerTransactionId": "qzGsElBII4VcDNOAEN9bVDlQ6FA=",
    "electronicCommerceIndicator": "06",
    "threeDSecureVersion": "2.2.0",
    "threeDSecureTransactionStatus": "A"
  }
}
ParameterDescription
threeDSecureData
object
Details about the 3DS data.
threeDSecureData.cardHolderAuthenticationVerificationValue
string
The Cardholder Authentication Verification Value (CAVV) is generated by the card issuer as part of the 3D Secure authentication process for Visa transactions. It indicates that the cardholder has been authenticated, and it should be appended to the authorisation request.
threeDSecureData.directoryServerTransactionId
string
The 3DS 2.0 transaction identifier returned by the card issuer, unique to each authentication attempt.
threeDSecureData.electronicCommerceIndicator
string
The Electronic Commerce Indicator (ECI) specifies the security level of an online transaction and the authentication outcome, crucial for determining liability in the event of a dispute.

Possible values:
01: Transaction processed with SSL or equivalent but without cardholder authentication (considered less secure, higher risk).
02: Transaction processed with cardholder authentication (e.g., 3D Secure), indicating a higher level of security.
05: Transaction processed with 3D Secure authentication, cardholder authenticated successfully (high security).
06: Transaction attempted 3D Secure authentication but could not be completed; cardholder not authenticated (medium security).
07: Transaction processed without 3D Secure authentication, due to issuer or cardholder not participating in 3D Secure (considered less secure, higher risk).
threeDSecureData.threeDSecureVersion
string
The version of the 3D Secure protocol used for the transaction's authentication, as returned by the Payment Service Provider (PSP)'s 3D Secure service. This indicates the specific set of 3D Secure features and security measures applied.
threeDSecureData.threeDSecureTransactionStatus
string
The status of the transaction after being authenticated using the 3D Secure protocol, as provided by the Payment Service Provider (PSP). This indicates the result of the 3D Secure authentication process.

Add a PSD2 exemption

PSD2 requires that Strong Customer Authentication (SCA) is applied to all electronic payments including proximity and remote payments, within the European Economic Area (EEA) and the UK. However, you can request an exemption for certain types of transactions, such as low value transactions (under 50€).

To add an SCA exemption, add the following snippet to the body of your request.

{
  "psd2Data": {
    "scaExemption": "LowValue"
  }
}
ParameterDescription
psd2Data
object
Details about PSD2-related information for the transaction, including any applicable Strong Customer Authentication (SCA) exemptions.
psd2Data.scaExemption
string
required
The type of SCA exemption being requested for this transaction.

Possible values:
AnonymousCard
LowValue
SecureCorporate
TransactionRiskAnalysis
TrustedBeneficiary