API Reference

3DS - SDK Configuration Options

iOS Configuration Options

Method Description Default Values Possible Values
deploymentEnvironment The environment SDK connects to. CardinalSessionEnvironmentProduction

  • CardinalSessionEnvironmentStaging

  • CardinalSessionEnvironmentProduction
uiType Interface types that the device supports for displaying specific challenge user interfaces within the SDK. This setting interacts with renderType in important ways. See renderType below for more information. CardinalSessionUITypeBoth

It is recommended that you use CardinalSessionUITypeBoth to ensure your SDK integration can accept and render both the Native and HTML render types an issuer may use. Deviating from this default value could result in impacts to overall SDK transaction performance.

  • CardinalSessionUITypeBoth

  • CardinalSessionUITypeNative

  • CardinalSessionUITypeHTML

renderType

List of all the RenderTypes that the device supports for displaying specific challenge user interfaces within the SDK.

Note:

  • When using CardinalSessionUiTypeBOTH or CardinalSessionUiTypeHTML, all renderType options must be set.

  • When using CardinalSessionUiTypeNative, all renderType options except CardinalSessionRenderTypeHTML must be set.

See uiType above for more information on which UiType to use.

  • CardinalSessionRenderTypeOTP

  • CardinalSessionRenderTypeHTML

  • CardinalSessionRenderTypeOOB

  • CardinalSessionRenderTypeSingleSelect

  • CardinalSessionRenderTypeMultiSelect

  • CardinalSessionRenderTypeOTP

  • CardinalSessionRenderTypeHTML

  • CardinalSessionRenderTypeOOB

  • CardinalSessionRenderTypeSingleSelect

  • CardinalSessionRenderTypeMultiSelect

proxyServerURL

Proxy server through which the Cardinal SDK Session operates.

nil

String Value 

requestTimeout

Sets the maximum amount of time (in milliseconds) for all exchanges

8000

>=0 Milliseconds (Integer)

challengeTimeout

Challenge Screen Timeout in Minutes.

5

>=5 minutes (Integer)

uiCustomization

Set Custom UICustomization for SDK Controlled Challenge UI.

enableDFSync

Enable DF Sync to get onSetupCompleted (Step 4) called after collected Device Data is sent to the server.

true

Boolean

threeDSRequestorAppURL

Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after OOB authentication has occurred. Each transaction would require a unique Transaction ID by using the SDK Transaction ID.

String Value 

collectLogs

Enables collecting SDK logs 

true

Boolean

enableQuickAuth (deprecated)

Enable Quick Authentication

false

Boolean

darkModeUiCustomization

Set Custom UICustomization for SDK Controlled Challenge UI.

-

Android Configuration Options

Method Description Default Values Possible Values
deploymentEnvironment The environment SDK connects to. CardinalSessionEnvironmentProduction

  • CardinalSessionEnvironmentStaging

  • CardinalSessionEnvironmentProduction
uiType Interface types that the device supports for displaying specific challenge user interfaces within the SDK. This setting interacts with renderType in important ways. See renderType below for more information. CardinalSessionUITypeBoth

It is recommended that you use CardinalSessionUITypeBoth to ensure your SDK integration can accept and render both the Native and HTML render types an issuer may use. Deviating from this default value could result in impacts to overall SDK transaction performance.

  • CardinalSessionUITypeBoth

  • CardinalSessionUITypeNative

  • CardinalSessionUITypeHTML

renderType

List of all the RenderTypes that the device supports for displaying specific challenge user interfaces within the SDK.

Note:

  • When using CardinalSessionUiTypeBOTH or CardinalSessionUiTypeHTML, all renderType options must be set.

  • When using CardinalSessionUiTypeNative, all renderType options except CardinalSessionRenderTypeHTML must be set.

See uiType above for more information on which UiType to use.

  • CardinalSessionRenderTypeOTP

  • CardinalSessionRenderTypeHTML

  • CardinalSessionRenderTypeOOB

  • CardinalSessionRenderTypeSingleSelect

  • CardinalSessionRenderTypeMultiSelect

  • CardinalSessionRenderTypeOTP

  • CardinalSessionRenderTypeHTML

  • CardinalSessionRenderTypeOOB

  • CardinalSessionRenderTypeSingleSelect

  • CardinalSessionRenderTypeMultiSelect

proxyServerURL

Proxy server through which the Cardinal SDK Session operates.

nil

String Value 

requestTimeout

Sets the maximum amount of time (in milliseconds) for all exchanges

8000

>=0 Milliseconds (Integer)

challengeTimeout

Challenge Screen Timeout in Minutes.

5

>=5 minutes (Integer)

uiCustomization

Set Custom UICustomization for SDK Controlled Challenge UI.

enableDFSync

Enable DF Sync to get onSetupCompleted (Step 4) called after collected Device Data is sent to the server.

true

Boolean

threeDSRequestorAppURL

Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after OOB authentication has occurred. Each transaction would require a unique Transaction ID by using the SDK Transaction ID.

String Value 

collectLogs

Enables collecting SDK logs 

true

Boolean

enableQuickAuth (deprecated)

Enable Quick Authentication

false

Boolean

darkModeUiCustomization

Set Custom UICustomization for SDK Controlled Challenge UI.

-

Questions? Contact Sales or make a post