Adyen · Schema
ThreeDS2RequestData
ThreeDS2RequestData schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| acctInfo | object | Additional information about the Cardholder’s account provided by the 3DS Requestor. |
| acctType | string | Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit |
| acquirerBIN | string | Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should mat |
| acquirerMerchantID | string | Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's |
| addrMatch | string | Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not m |
| authenticationOnly | boolean | If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. |
| challengeIndicator | string | Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` |
| deviceChannel | string | The environment of the shopper. Allowed values: * `app` * `browser` |
| deviceRenderOptions | object | Display options for the 3D Secure 2 SDK. Optional and only for `deviceChannel` **app**. |
| homePhone | object | The home phone number provided by the Cardholder. |
| mcc | string | Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/a |
| merchantName | string | Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they |
| messageVersion | string | The `messageVersion` value indicating the 3D Secure 2 protocol version. |
| mobilePhone | object | The mobile phone number provided by the Cardholder. |
| notificationURL | string | URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. |
| payTokenInd | boolean | Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. |
| paymentAuthenticationUseCase | string | Indicates the type of payment for which an authentication is requested (message extension) |
| purchaseInstalData | string | Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters. |
| recurringExpiry | string | Date after which no further authorisations shall be performed. Format: YYYYMMDD |
| recurringFrequency | string | Indicates the minimum number of days between authorisations. Maximum length: 4 characters. |
| sdkAppID | string | The `sdkAppID` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. |
| sdkEncData | string | The `sdkEncData` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. |
| sdkEphemPubKey | object | The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. |
| sdkMaxTimeout | integer | The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes. |
| sdkReferenceNumber | string | The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. |
| sdkTransID | string | The `sdkTransID` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. |
| sdkVersion | string | Version of the 3D Secure 2 mobile SDK. Only for `deviceChannel` set to **app**. |
| threeDSCompInd | string | Completion indicator for the device fingerprinting. |
| threeDSRequestorAuthenticationInd | string | Indicates the type of Authentication request. |
| threeDSRequestorAuthenticationInfo | object | Information about how the 3DS Requestor authenticated the cardholder before or during the transaction |
| threeDSRequestorChallengeInd | string | Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * |
| threeDSRequestorID | string | Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Dir |
| threeDSRequestorName | string | Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory |
| threeDSRequestorPriorAuthenticationInfo | object | Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction. |
| threeDSRequestorURL | string | URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process. |
| transType | string | Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi- |
| transactionType | string | Identify the type of the transaction being authenticated. |
| whiteListStatus | string | The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. |
| workPhone | object | The work phone number provided by the Cardholder. |