API Reference

Learn about objects and parameters you should use to accept 3D Secure 2.0 payments with the Adyen API.


The following API versions support 3D Secure 2.0 payments:

accountInfo 

Field Type Required Description

accountAgeIndicator

String (error) Cardholder Account Age Indicator

accountChangeDate

String (error) Cardholder Account Change

accountChangeIndicator

String (error) Cardholder Account Change Indicator

accountCreationDate

String (error) Cardholder Account Date

passwordChangeDate

String (error) Cardholder Account Password Change

passwordChangeDateIndicator

String (error) Cardholder Account Password Change Indicator

purchasesLast6Months

String (error) Cardholder Account Purchase Count

addCardAttemptsDay

String (error) Number of Provisioning Attempts Day

pastTransactionsDay

String (error) Number of Transactions Day

pastTransactionsYear

String (error) Number of Transactions Year

paymentAccountAge

String (error) Payment Account Age

paymentAccIndicator

String (error) Payment Account Age Indicator

deliveryAddressUsageDate

String (error) Shipping Addres Usage

deliveryAddressUsageIndicator

String (error) Shipping Addres Usage Indicator

shipNameIndicator

String (error) Shipping Name Indicator

suspiciousAccActivity

String (error) Suspicious Account Activity

homePhone

String (error) Cardholder Home Phone Number

mobilePhone

String (error) Cardholder Home Phone Number

workPhone

String (error)

Cardholder Work Phone Number 

billingAddress

Field Type Required Description

city

String

(error)

Cardholder Billing Address City

country String (error)

Cardholder Billing Address Country

houseNumberOrName

String (error)

Cardholder Billing Address Line 1

postalCode

String (error)

Cardholder Billing Address Postal Code

stateOrProvince

String (error)

Cardholder Billing Address State

street

String (error)

Cardholder Billing Address Line 1

browserInfo

Field Type Required Description
acceptHeader String

The accept header value of the shopper's browser.
colorDepth Int

(error)

The color depth of the shopper's browser.
javaEnabled Boolean

(error)

Whether the shopper's browser has Java enabled.
language String

(error)

The name of the browser language used by the shopper. Usually a two letter country code.

Examples: NL, FR, US.

screenHeight Int

(error)

The pixel height of the shopper's screen.
screenWidth Int

(error)

The pixel width of the shopper's screen.
timeZoneOffset String

(error)

Time difference between UTC time and the shopper's browser local
time, in minutes. Example: "-120"

userAgent String

The user agent value of the shopper's browser.

card

Field Type Required Description

number

String

Cardholder Account Number

expiryMonth String (error) Card/Token Expiry Month
expiryYear String (error) Card/Token Expiry Year

holderName

String (error)

Cardholder Name

installments

Field Type Required Description

value

Int

Installment Payment Data

merchantRiskIndicator

Field Type Required Description
deliveryEmail String (error) Delivery Email Address
deliveryTimeframe String (error) Delivery Timeframe
giftCardAmount String (error) Gift Card Amount
giftCardCount String (error) Gift Card Count
preOrderDate String (error) Pre-Order Date
preOrderPurchase String (error) Pre-Order Purchase Indicator
reorderItems String (error) Reorder Items Indicator
shipIndicator String (error) Shipping Indicator

recurring

Field Type Required Description

recurringFrequency

String

(error)

Recurring Frequency

recurringExpiry

String (error)

Recurring Expiry

shippingAddress

Field Type Required Description

city

String

(error)

Cardholder Shipping Address City

country String (error)

Cardholder Shipping Address Country

houseNumberOrName

String (error)

Cardholder Shipping Address Line 1

street

String (error)

Cardholder Shipping Address Line 1

postalCode

String (error)

Cardholder Shipping Address Postal Code

stateOrProvince

String (error)

Cardholder Shipping Address State

shopperEmail

Cardholder Email Address

threeDS2RequestData

Field Type Required Description
authenticationOnly Boolean (error)

If set to true, you will only do the 3D Secure 2.0 authentication, not the payment authorization.

challengeIndicator String (error)

Possibility to specify a preference for receiving a challenge from the issuer.

deviceChannel String

The environment of the shopper. Allowed values:

  • app
  • browser
deviceRenderOptions Object (error)

Display options for the 3DS2.0 SDK. Only for deviceChannel is set to app.

  sdkInterface String (error)

Supported SDK interface types.

  sdkUiType Array (error)

String array of UI types supported for displaying specific challenges.

notificationURL String (error) URL where the Challenge Response value will be sent. Only for deviceChannel set to browser.

sdkAppID

String (error)

The sdkAppID value as received from the 3DS 2.0 SDK. Only for deviceChannel set to app.

sdkEncData String (error) The sdkEncData value as received from the 3DS 2.0 SDK. Only for deviceChannel set to app

sdkEphemPubKey

Object (error) The sdkEphemPubKey value as received from the 3DS 2.0 SDK. Only for deviceChannel set to app.
  crv String (error) The crv value as received from the 3D Secure 2.0 SDK.
  kty String (error) The kty value as received from the 3D Secure 2.0 SDK.
  x String (error) The x value as received from the 3D Secure 2.0 SDK.
  y String (error) The y value as received from the 3D Secure 2.0 SDK.
sdkMaxTimeout Integer (error) The maximum amount of time in minutes for the 3DS 2.0 authentication process. Only for deviceChannel set to app.
sdkReferenceNumber String (error) The sdkReferenceNumber value as received from the 3DS 2.0 SDK. Only for deviceChannel set to app.
sdkTransID String (error) The sdkTransID value as received from the 3DS 2.0 SDK. Only for deviceChannel set to app.
threeDSCompInd String (error) Completion indicator for the threeDSMethodUrl fingerprinting.
threeDSRequestorURL String (error) URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3DS2.0 process

threeDS2Result

Field Type Required Description
authenticationValue String

The value for the 3D Secure 2.0 authentication session. The returned value is a Base64-encoded 20-byte array.

Example: AQIDBAUGBwgJCgsMDQ4PEBESExQ=

eci String

The Electronic Commerce Indicator returned from the schemes for the 3D Secure 2.0 payment session.

Example: 02

threeDSServerTransID String

The unique identifier assigned to the transaction by the 3D Secure 2.0 Server.

timestamp String

The date and time of the cardholder authentication, in UTC.

Format = YYYYMMDDHHMM

transStatus String

Indicates whether a transaction was authenticated, or whether additional verification is required.

Possible values:

  • Y = Authentication / Account verification successful.
  • N = Not Authenticated / account not verified. Transaction denied.
  • U = Authentication / account verification could not be performed.
  • A = Authentication / verification was attempted but could not be verified.
  • C = Challenge Required. Additional authentication is required using a Challenge.
  • R = Authentication / account verification rejected by the Issuer.
transStatusReason String

Provides information on why the transStatus field has the specified value.

Possible values:

  • 01 = Card authentication failed.
  • 02 = Unknown device.
  • 03 = Unsupported device.

  • 04 = Exceeds authentication frequency limit.

  • 05 = Expired card.

  • 06 = Invalid card number.

  • 07 = Invalid transaction.

  • 08 = No Card record.

  • 09 = Security failure.

  • 10 = Stolen card.

  • 11 = Suspected fraud.

  • 12 = Transaction not permitted to cardholder.

  • 13 = Cardholder not enrolled in service.

  • 14 = Transaction timed out at the ACS.

  • 15 = Low confidence.

  • 16 = Medium confidence.

  • 17 = High confidence.
  • 18 = Very high confidence.
  • 19 = Exceeds ACS maximum challenges.
  • 20 = Non-Payment transaction not supported.
  • 21 = 3RI transaction not supported.