Loading...
For configuration code samples, see our Configuration Code for SDKs article.
When a merchant requests an exemption, they will no longer be able to avail of a liability shift in the event of a chargeback.
For Mastercard exemption requests, see our Mastercard Message Extension article.
| Field | Format | Type | Description |
|---|---|---|---|
| Version Check Endpoint | String | M | Your server-side endpoint responsible for handling the Check Version request and response. |
| accountId | String | O | Your Account ID assigned by us. |
| card | Object | M | Object containing the card information. |
| cardHolderName | String | O | The full name of the cardholder. |
| customerReference | String | O | Merchant-defined field to reference the customer. |
| cvn | String | O | The numeric value printed on the physical card. |
| expMonth | String | O | The expiry date month of the card. |
| expYear | String | O | The expiry date year of the card. |
| number | String | O | The card account number used to authorize the transaction. Also known as PAN. |
| reference | String | O | Merchant-defined field to reference the transaction. |
| merchantId | String | O | Your Merchant ID assigned by us. |
| methodNotificationUrl | String | O | The URL that will receive the Method Completion message. |
| methodWindow | ChallengeWindowOptions | O | Object containing the options on how to present the Challenge Window to the cardholder. |
| Merchant Data | String | O | Any data you want to pass from the 3DS JavaScript to your server-side code. |
| Field | Format | Type | Description |
|---|---|---|---|
| Authentication Endpoint | String | M | Your server-side endpoint responsible for handling the Initiate Authentication request and response. |
| accountId | String | O | Your Account ID assigned by us. |
| authenticationRequestType | Enum | O | Indicates the type of channel used to initiate the transaction. Allowed values: AddCard<br />CardholderVerification<br />MaintainCard<br />InstalmentTransaction<br />PaymentTransaction<br />RecurringTransaction |
| authenticationSource | Enum | O | Indicates the type of channel used to initiate the transaction. Allowed values: Browser<br />MobileSDK<br />StoredRecurring |
| browserData | Object | M | Object containing the details of the user's browser. |
| colorDepth | String | M | Browser color depth. |
| javaEnabled | Boolean | M | Whether the browser can execute Java. |
| javascriptEnabled | Boolean | M | Whether the browser can execute Javascript. |
| language | String | M | Browser language. |
| screenHeight | Number | M | Total height of the customer's screen in pixels. |
| screenWidth | Number | M | Total width of the customer's screen in pixels. |
| time | Date | M | |
| timezoneOffset | Number | M | Time difference between UTC time and the customer's browser local time. |
| userAgent | String | M | Exact content of the HTTP user-agent header sent by the browser. |
| card | Object | O | Object containing the card information. |
| challengeNotificationUrl | String | O | URL that receives the Challenge Result message and informs your application that the customer has completed the challenge. |
| challengeRequestIndicator | Enum | O | Indicates whether a challenge is requested for this transaction. The Issuer may override whatever preference is specified in this field. Allowed values: ChallengeMandated<br />ChallengePreferred<br />NoChallengeRequested<br />NoPreference |
| challengeWindow |
| Object |
| M |
| Object containing the options on how to present the challenge window to the cardholder. |
| displayMode | String | O |
| encodedChallengeRequest | String | O |
| hide | Boolean | O |
| origin | String | O |
| requestUrl | String | O |
| response | String | O |
| target | String | O |
| timeout | Number | O |
| windowSize | String | O | Dimensions of the challenge window displayed to the customer. The ACS replies with content that fits the window size. |
| merchantId | String | O | Your Merchant ID assigned by us. |
| merchantContactUrl | String | O | URL of the merchant's website or customer support site. Should provide contact information for use in the event of a problem. |
| messageCategory | Enum | O | Indicates the type of channel used to initiate the transaction. Allowed values: NonPayment<br />Payment |
| methodUrlComplete | Enum | O | Indicates whether the 3DS Method was completed successfully. Allowed values: Unavailable<br />No<br />Yes |
| serverTransactionId | String | O | Unique identifier for the authentication in our 3DS solution (3DS server). Must be used for all requests. |
| Merchant Data | String | O | Any data you want to pass from the 3DS JavaScript to your server-side code. |