3DS SDK Options

The below table provides a list of all possible options which are sent in when the 3DS SDK is initialised as documented in Step 3 of the implementation guide.

Option Description Format Default Required Version

Option	Description	Format	Default	Required	Version
`showChallenge`	If the 3DS authentication requires a challenge, this provides the option to show the challenge or not. If set to false, and a challenge is requested, the authentication will result in a status of N or C. The default value is set at signup time. This can be sent in to override the default.	boolean	true	v2: Y v3: N	2 , 3
showChallen`gePopup`	Option to display the challenge at the bottom of the form, or in a popup window.	boolean	true	N	2
`rebilling`	If this is a recurring billing authentication. If set to true the rebillingData object must be set.	boolean	false	N	2
`rebillingData`	Contains the rebilling options.	object	-	only if rebilling is set to true	2
`rebillingData. rebillingExpiry`	The date that the recurring billing will expire. e.g. for a 12 month magazine subscriotion, it should be set to the last month that a transaction will occur.	string formatted Date. YYYYMMDD	-	only if rebilling is set to true	2
`rebillingData. rebillingFrequency`	The least number of days between a rebilling cycle. If the rebilling is monthly this should be 28 (for February). If a weekly rebill, 7 days.	integer	-	only if rebilling is set to true	2
`rebillingData.amount`	The amount for the rebilling transaction. The rebilling amount must be in the same currency as the amounttotal and for the same currency.	decimal	-	only if rebilling is set to true	2
`addrMatch`	Set to true, the shipping address matches the billing address, and does not need to be set.	boolean	false	N	3
`autoStart`	If set to true, the SDK will attempt to authorization as soon as the user finishes entering data into all the required fields (e.g. card number, CVV, Expiry). This setting can cause many false transactions to be charged to your account, as a user may go back and edit their data, and every time they edit the data, a new transaction will start. It is not recommended to use this feature.	boolean	false	N	2
`formSeparateElements`	If set to true, instead of adding the 3DS data to the form in one element as JSON data. It will print each field as a separate hidden `<input> elements with the name being the JSON key and the data the JSON data.`	boolean	false	N	3
`threeDs1StyleReturn`	Names all the returned data to use 3DS1 naming patterns.	boolean	false	N	3
`convertResponseToMatchVersion`	Converts all the returned data to use the corresponding 3DS versions naming patterns.	boolean	false	N	3
`mcc`	ONLY TO BE USED IN TESTING This setting allows you to change the workflow while in testing mode. On live the MCC is set in the backend system and should never be passed in using this option. 3001 - Challenge Required 3002 - Frictionless 3003 - Decline	string	-	N	3

showChallenge

If the 3DS authentication requires a challenge, this provides the option to show the challenge or not.

If set to false, and a challenge is requested, the authentication will result in a status of N or C.

The default value is set at signup time.

This can be sent in to override the default.

boolean

true

v2: Y v3: N

2 , 3

showChallengePopup

Option to display the challenge at the bottom of the form, or in a popup window.

boolean

true

rebilling

If this is a recurring billing authentication. If set to true the rebillingData object must be set.

boolean

false

rebillingData

Contains the rebilling options.

object

only if rebilling is set to true

rebillingData. rebillingExpiry

The date that the recurring billing will expire. e.g. for a 12 month magazine subscriotion, it should be set to the last month that a transaction will occur.

string formatted Date. YYYYMMDD

only if rebilling is set to true

rebillingData. rebillingFrequency

The least number of days between a rebilling cycle. If the rebilling is monthly this should be 28 (for February). If a weekly rebill, 7 days.

integer

only if rebilling is set to true

rebillingData.amount

The amount for the rebilling transaction. The rebilling amount must be in the same currency as the amounttotal and for the same currency.

decimal

only if rebilling is set to true

addrMatch

Set to true, the shipping address matches the billing address, and does not need to be set.

boolean

false

autoStart

If set to true, the SDK will attempt to authorization as soon as the user finishes entering data into all the required fields (e.g. card number, CVV, Expiry). This setting can cause many false transactions to be charged to your account, as a user may go back and edit their data, and every time they edit the data, a new transaction will start. It is not recommended to use this feature.

boolean

false

formSeparateElements

If set to true, instead of adding the 3DS data to the form in one element as JSON data. It will print each field as a separate hidden <input> elements with the name being the JSON key and the data the JSON data.

boolean

false

threeDs1StyleReturn

Names all the returned data to use 3DS1 naming patterns.

boolean

false

convertResponseToMatchVersion

Converts all the returned data to use the corresponding 3DS versions naming patterns.

boolean

false

mcc

ONLY TO BE USED IN TESTING This setting allows you to change the workflow while in testing mode. On live the MCC is set in the backend system and should never be passed in using this option. 3001 - Challenge Required 3002 - Frictionless 3003 - Decline

string

PreviousImplementation Guidelines Next3DS Response

Last updated 2 years ago