Server Control

Properties   Methods   Events   Config Settings   Errors  

The 3DS Server control provides support EMV® 3-D Secure (EMV 3DS) functionality designed with a web server in mind.

Syntax

Server

Remarks

This control is designed to be used in a web server, or in a process used by a web server to facilitate EMV® 3-D Secure (EMV 3DS) functionality. The control is used primarily for the browser-based flow, but also for some operations in the app-based flow as detailed in other parts of the documentation.

Connecting with SSL Client Authentication

Many directory servers require client authentication via a client certificate. The SSLCert* properties are used to load the SSL client certificate. In order to properly authenticate to the directory server the entire certificate chain must be presented to the directory server during the initial SSL handshake. The sections below describe options for making sure the CA chain is included.

Option 1: PFX With CA Certs

The first option is to specify a PFX file which includes both the client certificate, and CA certificates. In this case the control will read the CA certificates from the PFX file and include them in the request.

Option 2: SSLCACerts Configuration Setting

Another option is to specify the CA certificates separately from the client certificate. To do this the SSLCACerts configuration setting may be set to a CrLf separated list of CA certificates. For instance:

Option 3: CA Certs in Windows Store

When running on Windows the CA certificates will also be included in the request if they are present in the Personal store of the user under which the application is running.

Card Ranges

The application using the 3DS Server control should maintain a cache of card range information that can be queried when a transaction is initiated. The RequestCardRanges method will retrieve card range information to be cached.

RequestCardRanges requests card ranges and additional information from the directory server.

When a transaction is initiated, the first step that should be taken is to find information about the card range to which the card number belongs. This includes the protocol version(s) supported by the ACS and DS, and if one exists, any corresponding Method URL (used in the browser flow).

Results of this method should be cached in order to quickly look up information when processing transactions. It is recommended to call this method once every 24 hours at a minimum, and once per hour as a maximum to refresh the cache. The control will not cache the returned values; it is up to the user to cache these values in an appropriate location.

The first time this method is called, SerialNumber will be empty, indicating that all results should be returned. This is an offset the server will use to return only new updates to the card ranges (if any) since the last request. The SerialNumber will be populated after this method returns, and this value should be saved to be used in subsequent calls.

When a response is received, the card ranges will be made available via the component events and properties.

When ProtocolVersion is set to 2.3.1, the CardRangeData event will fire for each card range data object received, and the Ranges and ACSProtocolInfos properties will be populated to be accessed within the event handler.

When ProtocolVersion is set to 2.2.0 or 2.1.0, the CardRange event will fire for each card range that is returned, and the results will also be held in the CardRanges property.

The following properties are applicable when calling this method:

• DirectoryServerURL (required)
• SerialNumber
• ServerTransactionId
• ServerOperatorId
• EnableDownloadCardRangeDataFile (2.3.1 only)

The following properties are populated after calling this method:

• CardRanges
• DSStartProtocolVersion
• DSEndProtocolVersion
• SerialNumber
• DSTransactionId
• ResendRequestCardRanges

Note that when ProtocolVersion 2.3.1, the card range data is only available using the CardRangeData event.

When using ProtocolVersion 2.2.0 or 2.3.1, the returned ranges may include ACS Information Indicators. These are used to indicate additional functionality supported by the ACS for the card range(s). For 2.2.0, a ACSInformationIndicator field is exposed in both CardRanges collection and CardRange event. In version 2.3.1, this information is availalbe in the ACSProtocolInfos collection via the Indicator field. Possible values are:

• 01 - Authentication Available at ACS
• 02 - Attempts Supported by ACS or DS
• 03 - Decoupled Authentication Supported
• 04 - Whitelisting Supported
• 05 - Device Binding Supported (2.3.1 only)
• 06 - WebAuthn Authentication Supported (2.3.1 only)
• 07 - SPC Authentication Supported (2.3.1 only)
• 08 - Transaction Risk Analysis Exemption Supported (2.3.1 only)
• 09 - Trust List Exemption Supported (2.3.1 only)
• 10 - Low Value Exemption Supported (2.3.1 only)
• 11 - Secure Corporate Payments Exemption Supported (2.3.1 only)
• 80-99 - Reserved for DS Use

If an error is identified with the card range data received from the directory server when calling the RequestCardRanges method, the ResendRequestCardRanges configuration setting will be true, indicating that the request should be resent. When resending, if SerialNumber was specified for the initial request, it should be set to an empty string before calling RequestCardRanges again. Otherwise, the request can be sent without the serial number again, but the server may respond with an error due to multiple requests within an hour.

Note that retrieving card ranges can consume a lot of memory, especially when retrieving the initial set of ranges. The StoreCardRangeData and UseJsonDOM configuration settings can be set to help minimize the amount of memory used. A CardRangeTempPath setting can also be used to specify a temporary path to which the PRes packet will be temporarily written prior to parsing.

When using ProtocolVersion 2.3.1, if UseJsonDOM is false, the card ranges will need to be cached and processed after the RequestCardRanges method returns. The card ranges would then need to be processed in the order indicated by the CardRangeRecordsReadOrder configuration setting. A check will also need to be made for overlap of ranges. If issue(s) are found, the ReportCardRangeError configuration setting should be used to report the error to the directory server.

Method Invocation

The GetMethodData method prepares data to be transmitted to the ACS via the cardholder's browser.

When a transaction begins, the card range cache should be queried to find details about the card range to which the card number belongs. If a CardRangeMethodURL is defined for the card range, this method should be used to prepare data to be sent via the cardholder's browser to the CardRangeMethodURL.

If the CardRangeMethodURL is not set for the specified card range, set MethodCompletionIndicator to U before calling SendAuthRequest.

The following properties are applicable when calling this method:

• MethodNotificationURL (required)

This method returns a string which contains encoded data to be sent to the ACS. This includes ServerTransactionId and MethodNotificationURL. After calling this method, the returned string can be transmitted to the ACS via the cardholder's browser.

As per the EMVCo specification, create a hidden iframe in the browser and send a form with the field name threeDSMethodData containing the return value from this method and post the form to the CardRangeMethodURL.

The ACS will record information about the customer's environment and then POST back to the MethodNotificationURL. The page at this URL should expect a form variable with the name threeDSMethodData which will contain the original ServerTransactionId value in order to match the response with the request. The form variable value will be base64url encoded and may be passed directly to the CheckResponse method. The control will decode and parse the received value and populate ServerTransactionId with the value from the received data.

If the response from the ACS is not received within 10 seconds, set MethodCompletionIndicator to N before calling SendAuthRequest.

Sending the Authentication Request

SendAuthRequest begins the 3-D Secure transaction flow by sending an authentication request to the DirectoryServerURL.

After calling this method, check TransactionStatus to determine if the cardholder is authenticated (frictionless flow) or further cardholder interaction is required to complete the authentication (challenge flow).

Prior to calling SendAuthRequest, data must to be collected to facilitate fraud checks by the ACS. The following properties are applicable for both app-based and browser-based flows:

• AcquirerBIN (required)
• AcquirerMerchantId (required)
• CardholderName (required)
• CardNumber (required)
• DirectoryServerURL (required)
• MerchantCategoryCode (required)
• MerchantCountryCode (required)
• MerchantName (required)
• PurchaseAmount (required)
• PurchaseDate (required)
• RequestorId (required)
• RequestorName (required)
• RequestorURL (required)
• ResultsURL (required)
• AccountType
• AuthenticationIndicator
• BillingAddress*
• CardholderEmail
• CardholderHomePhone
• CardholderMobilePhone
• CardholderWorkPhone
• DecoupledMaxTimeout
• DecoupledRequestIndicator
• DeviceChannel
• MessageCategory
• PurchaseCurrency
• PurchaseExponent
• ServerOperatorId
• ServerTransactionId
• ShippingAddress*
• ThreeRIIndicator

App-Based Flow

In the app-based flow, device specific information is prepared by the 3DS SDK on the customer's device. This is transmitted to the 3DS Server control via a secure channel, the specifics of which are outside the scope of the controls. Set ClientAuthRequest to this data prepared by the 3DS SDK.

Browser-Based Flow

Before calling this method, first check the cached card-range data to determine if a CardRangeMethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.

If no CardRangeMethodURL is present for the given card, set MethodCompletionIndicator to U.

If a CardRangeMethodURL has been specified by the ACS for the card number, the URL must be loaded in the cardholder's browser to allow the ACS to collect additional browser information for risk-based decision making. See the GetMethodData for further details.

Once the method URL invocation is complete, the authentication request may be sent. If the method URL invocation failed, set MethodCompletionIndicator to N before calling SendAuthRequest.

The following additional properties are applicable in browser-based flow:

• NotificationURL (required)
• BrowserAcceptHeader (required)
• BrowserLanguage (required)
• BrowserScreenHeight (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserScreenWidth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserTimeZone (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserUserAgent (required)
• BrowserIPAddress (conditional)
• BrowserJavaEnabledVal (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserJavaScriptEnabledVal (not valid in 2.1.0, required in 2.2.0 and 2.3.1)
• BrowserScreenColorDepth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• AcceptLanguage (2.3.1 only)
• AcquirerCountryCode (2.3.1 only)

Response Handling

After calling this method the TransactionStatus property holds the result. Possible values are:

Transaction Status	Description
Y	Authenticated successfully
C	Cardholder challenge required
N	Not authenticated
A	Not authenticated, but a proof of authentication attempt was generated in AuthenticationValue
U	Not authenticated due to technical or other issue
R	Not authenticated because the issuer is rejecting authentication
D	Challenge required; decoupled authentication confirmed
I	Informational only; 3DS Requestor challenge preference acknowledged
S	Challenge using SPC

If the transaction is authenticated (Y or A), no further steps are required. The flow is considered frictionless and the 3-D Secure processing is complete. If processing a payment, the AuthenticationValue and AuthenticationECI values can be included as proof of 3-D Secure authentication.

If the transaction requires a cardholder challenge (C, D or S), further steps are required.

If the transaction is not authenticated, TransactionStatusReason may contain details about the reason.

The following properties are applicable after calling this method:

• AuthenticationECI
• AuthenticationValue
• TransactionStatus
• TransactionStatusReason
• CardholderInformation
• ACSURL (if challenge required)
• ACSChallengeMandatedIndicator (if challenge required)
• AuthenticationType (if challenge required)
• DecoupledConfirmationIndicator

Response Handling - App-Based Flow

After calling this method, ClientAuthResponse is populated with data to be transmitted back to the 3DS SDK. If a challenge is required, the ClientAuthResponse data is used by the 3DS SDK to start when initiating the challenge process.

The 3DS Server is responsible for indicating to the 3DS SDK the results of the SendAuthRequest process, and whether or not a challenge is required. Exactly how this is done is outside the scope of the controls themselves. The response to the 3DS SDK over the secure channel should include information on what to do next.

Note: The TransactionStatus is also populated in the 3DS Server control and may be inspected prior to transmitting ClientAuthResponse back to the 3DS SDK.

Response Handling - Browser-Based Flow

If TransactionStatus is C, then additional steps are required to complete the authentication. The GetChallengeRequest method should be called next to obtain data to be sent to the ACSURL in an authentication window in the customer's browser. Once authentication is complete, the ACS will post the results to the ResultsURL value that was specified when calling SendAuthRequest.

See the GetChallengeRequest method for more details.

If TransactionStatus is D, then decoupled authentication has been accepted by the ACS. DecoupledConfirmationIndicator will have a value of Y as well. Authentication will happen outside of the 3-D Secure flow and, when complete, the ACS will post the results to the ResultsURL that was specified when calling SendAuthRequest.

The DecoupledTimeRemaining value, which is calculated based on the DecoupledMaxTimeout value sent in the initial authentication request, can be checked to see the amount of time remaining before decoupled authentication must be completed. If the ACS does not post the results before this value runs out, it can be assumed that decoupled authentication was not successful.

SPC-Based Authentication

SPC (Secure Payment Confirmation) provides a method to perform a challenge using preestablished FIDO credentials when using a Browser. The SPC authentication can be initiated by the 3DS Requestor via an extra AReq/ARes message pair or by the ACS via a standard Browser Challenge Flow.

For an SPC authentication to execute correctly, the following prerequisites apply:

1. The ACS has an enrolled FIDO authenticator on the device for this Cardholder.
2. The 3DS Requestor and/or the ACS have detected that the Cardholder Browser supports the related SPC APIs (allow="payment *; publickey-credentialsget *"). For the ACS, this information can be obtained via the Browser User Agent data element or via data obtained via the 3DS Method

SPC-based authentication can be enabled with the following additions:

Prior to sending the initial authentication request packet (AReq) using the SendAuthRequest method, the ThreeDSRequestorSpcSupport configuration setting should be set to Y to indicate that SPC is supported by the 3DS Requestor.

If SPC is accepted by the ACS, the resulting TransactionStatus should be S. The response will also contain a list of enrolled FIDO (WebAuthn) credentials associated with the cardholder, and SPC transaction data. This data is available in the following configuration settings:

• WebAuthnCredentialListCount
• WebAuthnCredentialListWebAuthnCredential
• WebAuthnCredListRelyingPartyId
• SPCTransactionAdditionalData
• SPCTransactionChallenge
• SPCTransactionChallengeInfoText
• SPCTransactionCurrency
• SPCTransactionDisplayName
• SPCTransactionIcon
• SPCTransactionIssuerImage
• SPCTransactionIssuerImageDark
• SPCTransactionIssuerImageMonochrome
• SPCTransactionPayeeName
• SPCTransactionPayeeOrigin
• SPCTransactionPSImage
• SPCTransactionPSImageDark
• SPCTransactionPSImageMonochrome
• SPCTransactionTimeout
• SPCTransactionValue

If a new instance of the Server component will be used after authentication to send the second AReq, the AuthenticationInformation value should be saved to be used later.

This information is relayed to the 3DS Requestor implementation, and the 3DS Requestor invokes the SPC authentication (SPC API) against the WebAuthn Credential list. The cardholder authenticates using the FIDO authenticator on their device, and the 3DS Requestor retrieves the Assertion Data from the SPC API call.

The 3DS Server is then configured to includes this FIDO Assertion Data is then included in a new authentication request by setting the ReqAuthData and a ReqAuthMethod of 09. If the AuthenticationInformation value was saved earlier, it can be set via the same configuration setting. If the 3DS Requestor encounters an error during SPC API invokation, this can be indicated using the SPCIncompletionIndicator.

The SendAuthRequest method should then be called again to transmit this data to the ACS (by way of the DS) in a second AReq.

When SendAuthRequest returns, the 3DS Server proceed the same as the regular browser-based flow when the ARes is returned.

Note that SPC-based authentication is only available when a ProtocolVersion of 2.3.1 is used.

Challenge Interaction

If the TransactionStatus is C, a challenge is required.

The GetChallengeRequest method is used to build the Challenge Request (CReq) which will be sent in a form post to the ACSURL property via the cardholder browser.

An iframe should be created in the cardholder's browser, which will be used to send the challenge request and allow the cardholder and ACS to interact directly.

The size of the challenge window (iframe) may be any of the sizes listed in ChallengeWindowSize. Before calling this method set ChallengeWindowSize to the appropriate value to let the ACS know the size of the window on the cardholder's browser.

Calling this method will return a string which should be placed in a creq form variable.

The SessionData setting may also be set with any data that may be helpful to continue processing the transaction after the final challenge response is received at the NotificationURL. To prepare the session data for submission, query EncodedSessionData. The encoded string may then be placed in the threeDSSessionData form variable.

Note: The maximum length of the threeDSSessionData form variable, after being encoded, is 1024 bytes.

Example Form

Response Handling

Once the challenge has been completed by the cardholder, the directory server will post a Results Request (RReq) to the ResultsURL specified when calling SendAuthRequest. See CheckResponse and GetResultsResponse for more details.

The ACS will also post the Challenge Response to the NotificationURL specified when calling SendAuthRequest. This post contains data which may be parsed to verify the challenge results. See CheckResponse for more details.

Response Handling

After a challenge is complete, the Directory Server and ACS will POST data back to the web server for additional processing. CheckResponse parses a variety of messages that are sent to the Server as part of the authentication process.

The following messages can be parsed using this method:

• The threeDSMethodData form variables received at the MethodNotificationURL
• The Results Request (RReq) message received at the ResultsURL
• The cres form variables received at the NotificationURL
• The Operation Request Message (OReq) sent from a DS.

When calling the method, pass the message to be parsed as the Response parameter. The properties which are populated after calling this method vary depending on the type of message being parsed. See below for additional information.

Method Data from MethodNotificationURL

After calling GetMethodData, a request is made to the CardRangeMethodURL. After this, the ACS will make a POST to MethodNotificationURL to inform the requestor of completion. Retrieve the threeDSMethodData form variable value that was POSTed and pass it to this method. After calling this method, the following properties are populated:

• ServerTransactionId

The ServerTransactionId may be used to match the response with the request.

Results Request message from ResultsURL

When a challenge is completed for both app-based and browser-based flows, a POST is made to the ResultsURL with a Results Request message.

Prior to checking this RReq message, the ServerTransactionId can be extracted using the ExtractRReqServerTransactionId configuration setting. This value can then be used to look up details on the transaction that were saved prior to starting the challenge process, including the messageVersion which must be set via the ProtocolVersion configuration setting prior to passing the RReq message to the CheckResponse method.

Pass the body of the HTTP request received at ResultsURL to this method. This contains information about the results, and asks for a Results Response to be sent back containing the ResultsStatus.

After calling this method, the following properties are populated:

• AuthenticationECI
• TransactionStatus
• TransactionStatusReason
• ChallengeCancellationIndicator
• AuthenticationType
• AuthenticationValue

To respond to the POST, set ResultsStatus to the appropriate value and call GetResultsResponse to build a response message to be sent back to the directory server. Use the value from GetResultsResponse in your application as the body of the HTTP response. Set the Content-Type header to application/JSON; charset=utf-8

Final Challenge Response from NotificationURL

In a browser-based flow, the challenge takes place directly between the cardholder and the ACS in a separate iframe or window. The ACS will POST the final challenge response to the NotificationURL after the challenge is complete. Retrieve the cres form variable value from the POST data and pass it to CheckResponse. After calling this method the following properties are populated:

• ServerTransactionId
• TransactionStatus

In addition to the cres variable, a threeDSSessionData variable will be present if SessionData was set before calling GetChallengeRequest. The threeDSSessionData value POSTed to NotificationURL may be passed to EncodedSessionData. Query SessionData to get the decoded session data.

Operation Request Message (OReq)

OReq messages are used to communicate operational information from a DS to the 3DS Server. This message is not part of the 3-D Secure authentication flow.

When an OReq message is received, CheckResponse should be called to validate the message. There may be more than one OReq message sent in a sequence, and CheckResponse should be called for each. The current instance of the Server object can be cached for the duration of the OReq sequence until the final OReq is received. The Operation.SequenceNumber should also be set prior to calling CheckResponse. The component will verify the sequence number of the received OReq to ensure it's not out of sequence.

After calling this method, details are made available in Operation.

If any OReq data element fails validation, Operation.MessageStatus will be set to "02". If the OReq is valid, Operation.MessageStatus will be empty.

If the OReq is valid, determine if the final OReq has been received (Operation.SequenceNumber equals Operation.SequenceTotal). If these values match, the final OReq in the sequence has been received, and GetOperationResponse can be used to generate the ORes message.

For valid OReq messages that are not the final OReq in the sequence, the response should be HTTP Status 200 (OK) with an empty HTTP body.

Logging Notes

Logging in the component is handled through the Log event. This will fire anytime a message is built or a response is parsed, including error messages.

When the Log event is fired, the message in question is made available via the Message event parameter. Properties such as EphemeralKey and DeviceParams are also available when they are gathered by the Client. The other event arguments are LogType and LogLevel:

The LogType parameter indicates the type of the log entry. Possible values are:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"
• "AReq"
• "ARes"
• "CReq"
• "CRes"
• "RReq"
• "RRes"
• "PReq"
• "PRes"
• "Erro"
• "EphemeralKey"
• "DeviceParams"

The LogLevel configuration setting can be used to specify the detail of the logs raised through the Log event. The LogLevel parameter in the event indicates the log level to which the current message belongs.

It is recommended to output all messages raised in this event to a file for record keeping purposes, or for later debugging issues that may have come up.

The Server and Client components also have DataPacketIn and DataPacketOut events that fire anytime a data packet is received or sent, respectively. The entire data packet is then accessible in the DataPacket event parameter. For encrypted packets, this would contain the full encrypted data. This parameter may be inspected for advanced troubleshooting.

Property List

---

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

AcceptLanguage	HTTP accept language header value sent from the cardholder's browser.
AccountType	Indicates the type of account.
AcquirerBIN	Acquiring institution identification code.
AcquirerCountryCode	Acquirer Country Code.
AcquirerMerchantId	Acquirer-assigned merchant identifier.
ACSProtocolInfoCount	The number of records in the ACSProtocolInfo arrays.
ACSProtocolInfoIndicator	Additional information on the card range as supplied by the ACS.
ACSProtocolInfoProtocolVersion	The Protocol Version supported by the ACS for the card range.
ACSProtocolInfoSupportedMsgExt	A list of message extensions supported by the ACS that contains the Assigned Extension Group Identifier and the Extension Version Number.
ACSProtocolInfoThreeDSMethodURL	The ACS URL that will be used by the 3DS Method for a particular protocol version.
ACSURL	URL of the ACS to be used for the challenge.
AuthenticationECI	Value to be passed in the authorization message.
AuthenticationIndicator	3DS Requestor Authentication Indicator.
AuthenticationValue	Used to provide proof of authentication.
BillingAddressCity	The city of the address.
BillingAddressCountry	The country of the address.
BillingAddressLine1	The first line of the street address or equivalent local portion of the address.
BillingAddressLine2	The second line of the street address or equivalent local portion of the address.
BillingAddressLine3	The third line of the street address or equivalent local portion of the address.
BillingAddressPostalCode	The ZIP or other postal code of the address.
BillingAddressState	The state or province of the address.
BrowserAcceptHeader	HTTP accept header sent from the cardholder's browser.
BrowserIPAddress	IP address of the cardholder's browser.
BrowserJavaEnabledVal	Ability of the cardholder's browser to execute Java.
BrowserJavaScriptEnabledVal	Ability of the cardholder's browser to execute JavaScript.
BrowserLanguage	The cardholder's browser language.
BrowserScreenColorDepth	The screen color depth of the cardholder's browser.
BrowserScreenHeight	The screen height of the cardholder's browser.
BrowserScreenWidth	The screen width of the cardholder's browser.
BrowserTimeZone	The timezone offset of the cardholder's browser.
BrowserUserAgent	The User-Agent provided by the cardholder's browser.
CardExpDate	Expiration date of the PAN or Token.
CardholderEmail	The cardholder email address.
CardholderHomePhone	The cardholder home phone number.
CardholderMobilePhone	The cardholder mobile phone number.
CardholderName	Name of the cardholder.
CardholderWorkPhone	The cardholder work phone number.
CardNumber	Customer's account number that will be authenticated.
CardRangeCount	The number of records in the CardRange arrays.
CardRangeACSEndProtocolVersion	The most recent active protocol version that is supported by the ACS.
CardRangeACSInformationIndicator	Additional information on the card range as supplied by the ACS.
CardRangeACSStartProtocolVersion	The earliest (i.
CardRangeAction	The action to be taken with the card range specified by the Start and End properties.
CardRangeDSEndProtocolVersion	The most recent active protocol version that is supported by the DS.
CardRangeDSStartProtocolVersion	The earliest (i.
CardRangeEnd	Last number in a range of credit card numbers returned by the Directory Server.
CardRangeMethodURL	The ACS URL that will be used by the 3DS method.
CardRangeStart	First number in a range of credit card numbers returned by the Directory Server.
ChallengeWindowSize	Challenge window size.
ClientAuthRequest	The data received by the control to be sent in the authentication request.
ClientAuthResponse	The authentication response for an app-based flow.
DataPacketOut	Contains the data packet sent to the server.
DeviceChannel	Device channel.
DirectoryServerURL	The address of the Directory Server.
DSSupportedProtocols	Protocol Versions supported by the DS.
DSURLCount	The number of records in the DSURL arrays.
DSURLCountryCode	The country for which the 3DS Server to DS URL can be used.
DSURLThreeDSServerToDsUrl	URL that the 3DS Server uses to communicate with a DS for a particular card range.
ErrorPacket	The error packet.
ExtensionCount	The number of records in the Extension arrays.
ExtensionCritical	Whether the extension is critical.
ExtensionData	The extension data as JSON.
ExtensionId	The id of the specified extension.
ExtensionName	The extension name.
MerchantCategoryCode	Merchant category code.
MerchantCountryCode	Country code of the merchant.
MerchantName	Merchant name.
MessageCategory	The category of the message.
MethodNotificationURL	The URL to which the method notification will be posted.
NotificationURL	The notification URL to which the challenge response is sent.
OperationInfoCategory	Indicates the category/type of information.
OperationInfoDescription	Describes the reason for the operational communication or the response to an action taken by the recipient.
OperationInfoExpirationDate	The date after which the relevance of the operational information expires.
OperationInfoMessageStatus	Indicates the status of the operational request message sequence from the source of the OReq.
OperationInfoPriorTransactionId	The transaction ID of the prior transaction to which the operational information refers.
OperationInfoPriorTransactionIdType	The type of transaction ID of the prior transaction to which the operational information refers.
OperationInfoSequenceId	Uniquely identifies a message sequence and will remain constant in the sequence of messages.
OperationInfoSequenceNumber	The current message in the sequence.
OperationInfoSequenceTotal	The total number of messages in the sequence and will remain constant in the sequence of messages.
OperationInfoSeverity	Indicates the importance/severity level of the operational information.
ProxyAuthScheme	This property is used to tell the control which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the control whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
PurchaseAmount	Purchase amount to be authorized.
PurchaseCurrency	Identifies the type of currency used by the merchant.
PurchaseDate	The date of the transaction.
PurchaseExponent	Minor units of currency.
RangeCount	The number of records in the Range arrays.
RangeEnd	The final card number in the current range.
RangeStart	The first card number in the current range.
RecurringExpDate	Recurring expiration date.
RecurringFrequency	The number of days between recurring payments.
RequestorId	Directory server assigned 3DS Requestor identifier.
RequestorName	Directory server assigned 3DS Requestor name.
RequestorURL	3DS Requestor website or customer care site.
ResultsStatus	The status of the Results Request.
ResultsURL	3DS Server URL.
SDKType	Type of the 3DS SDK used for the app-based flow.
SerialNumber	Serial number indicating the state of the current card range cache.
ServerTransactionId	Server transaction identifier.
ShippingAddressCity	The city of the address.
ShippingAddressCountry	The country of the address.
ShippingAddressLine1	The first line of the street address or equivalent local portion of the address.
ShippingAddressLine2	The second line of the street address or equivalent local portion of the address.
ShippingAddressLine3	The third line of the street address or equivalent local portion of the address.
ShippingAddressPostalCode	The ZIP or other postal code of the address.
ShippingAddressState	The state or province of the address.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
Timeout	A timeout for the control.
TransactionStatus	The transaction status from the last parsed message (ARes, RReq, or CRes).

Method List

---

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

AddExtension	Adds an extension to the collection.
AddRequestField	Adds a field to the data in the request.
CheckResponse	Parses the specified message.
Config	Sets or retrieves a configuration setting.
GetChallengeRequest	Builds the Challenge Request (CReq) for browser-based flow.
GetMethodData	Prepares method data to be sent to the ACS before the authentication request is sent.
GetOperationResponse	Builds and returns the Operation Response Message (ORes) to be sent back to the Directory Server.
GetResultsResponse	Builds and returns the Results Response Message (RRes) to be sent back to the directory server.
Interrupt	Interrupts the current action.
RequestCardRanges	Requests card ranges from the directory server.
Reset	Clears all properties to their default values.
ResetTransactionInfo	Resets transaction specific information.
SendAuthRequest	Sends the authentication request to the directory server.

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

CardRange	Fired when the response to a Preparation Request Message (PReq) is received.
CardRangeData	Fired when the response to a Preparation Request Message (PReq) is received. This event is used for card range data returned when version 2.3.1 of the protocol is used.
DataPacketIn	Fired when receiving a data packet from the server.
DataPacketOut	Fired when sending a data packet to the server.
DSURL	Fired for each DS URL present in the Preparation Response Message (PRes).
Error	Information about errors during data delivery.
Log	Fires once for each log message.
MessageExtension	Fired when a Message Extension is present in a message being parsed.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Config Settings

---

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

AccountAgeIndicator	Cardholder Account Age Indicator.
AccountChangeDate	Cardholder Account Change Date.
AccountChangeIndicator	Cardholder Account Change Indicator.
AccountDate	Date cardholder account opened.
AccountDayTransactions	Number of account transactions in the last day.
AccountId	Cardholder Account Identifier.
AccountPasswordChangeDate	Cardholder Account Password Change Date.
AccountPasswordChangeIndicator	Cardholder Account Password Change Indicator.
AccountProvisioningAttempts	Number of account provisioning attempts in the last day.
AccountPurchaseCount	Cardholder Account Purchase Count.
AccountYearTransactions	Number of account transactions in the last year.
ACSChallengeMandatedIndicator	ACS Challenge Mandated Indicator.
ACSOperatorId	ACS identifier assigned by DS.
ACSReferenceNumber	Unique ACS Reference Number.
ACSRenderingDeviceUserInterfaceMode	User interface mode the ACS will present to cardholder.
ACSRenderingInterface	Challenge interface type presented to cardholder.
ACSRenderingUITemplate	Challenge type presented to cardholder.
ACSSignedContent	String value of the JWS object of the ARes message created by the ACS.
ACSTransactionId	Unique transaction identifier assigned by the ACS.
AddressMatch	Address Match Indicator.
AllowNullMethodURL	Allow null MethodURL when retrieving card ranges.
AppIP	App IP Address.
AppURLIndicator	3DS Requestor App URL Indicator.
AuthenticationInformation	3DS Requestor Prior Transaction Authentication Information.
AuthenticationMethod	A comma separated list of authentication types used by the issuer.
AuthenticationType	Type of authentication method used by the issuer.
BroadInfo	Broadcast Information.
BroadInfoCategory	Broadcast Information Category.
BroadInfoDescription	Broadcast Information Description.
BroadInfoExpiryDate	Broadcast Information Expiry Date.
BroadInfoRecipients	Broadcast Information Recipient(s).
BroadInfoSeverity	Broadcast Information Severity.
BroadInfoSource	Broadcast Information Source.
BrowserUserDeviceId	Browser User Device ID.
BrowserUserId	Browser User ID.
CardholderInformation	Information text presented to Cardholder during the transaction.
CardRangeRecordsReadOrder	Indicates the order in which to process the card range records from the PRes message.
CardRangeTempPath	Temporary path where card range data is written.
CardSecurityCode	Card Security Code.
CardSecurityCodeStatus	Card Security Code Status.
CardSecurityCodeStatusSource	Card Security Code Status Source.
ChallengeCancellationIndicator	Challenge Cancellation Indicator.
ChallengeErrorReportingACSTransID	Challenge Error Reporting ACS Transaction ID.
ChallengeErrorReportingDSTransID	Challenge Error Reporting DS Transaction ID.
ChallengeErrorReportingErrorCode	Challenge Error Reporting Error Code.
ChallengeErrorReportingErrorComponent	Challenge Error Reporting Error Control.
ChallengeErrorReportingErrorDescription	Challenge Error Reporting Error Description.
ChallengeErrorReportingErrorDetail	Challenge Error Reporting Error Detail.
ChallengeErrorReportingErrorMessageType	Challenge Error Reporting Error Message Type.
ChallengeErrorReportingMessageType	Challenge Error Reporting Message Type.
ChallengeErrorReportingMessageVersion	Challenge Error Reporting Message Version.
ChallengeErrorReportingSDKTransID	Challenge Error Reporting SDK Transaction ID.
ChallengeErrorReportingThreeDSServerTransID	Challenge Error Reporting Server Transaction ID.
ChallengeTimeRemaining	Amount of time left to complete challenge.
ClearCustomRequestFields	Clear the custom request fields internal collection.
ContinueParsingCardRangesOnError	Whether or not to continue parsing card ranges when a validation error is encountered.
DecoupledConfirmationIndicator	ACS Decoupled Confirmation Indicator.
DecoupledMaxTimeout	3DS Requestor Decoupled Max Time.
DecoupledRequestIndicator	3DS Requestor Decoupled Request Indicator.
DecoupledTimeRemaining	Time remaining before a RReq should be received during a decoupled authentication.
DeliveryEmailAddress	Merchandise Delivery Email Address.
DeliveryTimeframe	Merchandise Delivery Timeframe.
DeviceBindingStatus	Device Binding Status.
DeviceBindingStatusSource	Device Binding Status Source.
DeviceInfoRecognisedVersion	Device Information Recognized Version.
DSEndProtocolVersion	DS End Protocol Version.
DSReferenceNumber	DS Reference Number.
DSStartProtocolVersion	DS Start Protocol Version.
DSTransactionId	Directory server transaction ID.
EMVPaymentTokenIndicator	EMV Payment Token Indicator.
EMVPaymentTokenSource	EMV Payment Token Source.
EnableDownloadCardRangeDataFile	Card Range Data Download Indicator.
EncodedSessionData	Encoded session data that is sent in the challenge request and returned in the challenge response.
ErrorCode	Code from the last error message.
ErrorDescription	Description from the last error message.
ErrorDetail	Additional details from the last error message.
ExtractRReqServerTransactionId	Extacts the ServerTransactionId from the RReq packet.
GiftCardAmount	Total gift card(s) amount.
GiftCardCount	Total number of gift cards purchased.
GiftCardCurrency	Gift Card Currency.
IncomingExtensionCount	The number of extensions received from the directory server.
IncomingExtensionCritical[Index]	Whether the extension is critical.
IncomingExtensionData[Index]	The extension data as JSON.
IncomingExtensionId[Index]	The id of the specified extension.
IncomingExtensionName[Index]	The extension name.
IncomingRawExtensions	The full JSON formatted extension data received from the directory server.
InstalmentPaymentData	Max authorizations permitted for installment payments.
InteractionCounter	Interaction Counter.
LogLevel	Level of logging enabled.
MaskSensitive	Whether to mask sensitive data in the Log event.
MessageType	Type of message that is passed.
MethodCompletionIndicator	3DS Method Completion Indicator.
MultiTransactionAcquirerMerchantID	Acquirer Merchant ID.
MultiTransactionAVNumberUse	AV Number Use.
MultiTransactionAVValidityTime	AV Validity Time.
MultiTransactionCount	The total number of additional transactions specified.
MultiTransactionMerchantAmount	Merchant Amount.
MultiTransactionMerchantCurrencyCode	Merchant Currency Code.
MultiTransactionMerchantCurrencyExponent	Merchant Currency Exponent.
MultiTransactionMerchantName	Merchant Name.
MultiTransactionSellerID	Seller ID.
OutgoingRawExtensions	The full JSON formatted extension data sent to the directory server.
PaymentAccountAge	Payment Account Age.
PaymentAccountAgeIndicator	Payment Account Age Indicator.
PaymentToken	EMV Payment Token.
PaymentTokenAdditionalData	EMV Payment Token Additional Data.
PaymentTokenCryptogram	EMV Payment Token Cryptogram.
PaymentTokenStatusIndicator	EMV Payment Token Status Indicator.
PersistCustomRequestFields	Whether or not to store custom request fields for subsequent requests.
PreOrderDate	Expected date pre-ordered purchase will be available.
PreOrderPurchaseIndicator	Pre-Order Purchase Indicator.
ProtocolVersion	Protocol version identifier.
RecurringAmount	Recurring Amount.
RecurringAmountIndicator	Recurring Amount Indicator.
RecurringCurrency	Recurring Currency.
RecurringDate	Recurring Date.
RecurringExponent	Recurring Currency Exponent.
RecurringFrequencyIndicator	Recurring Frequency Indicator.
ReorderItemsIndicator	Reorder Items Indicator.
ReportCardRangeError	Report a Card Range Error to the DS.
ReqAuthCount	Count of 3DS Requestor Authentication Data.
ReqAuthData	3DS Requestor Authentication Data.
ReqAuthMethod	3DS Requestor Authentication Method.
ReqAuthTimestamp	3DS Requestor Authentication Timestamp.
RequestorChallengeInd	3DS Requestor Challenge Indicator.
ResendRequestCardRanges	Whether or not to resend the card ranges request.
SDKMaxTimeout	SDK Maximum Timeout.
SDKMaxTimeout	SDK Maximum Timeout.
SDKServerSignedContent	SDK Server Signed Content.
SDKWrapped	Default-SDK Wrapped Indicator.
SellerInfo	Seller Information.
ServerOperatorId	3DS Server identifier.
SessionData	Session data that is sent in the challenge request and returned in the challenge response.
ShipAddressUsageDate	Shipping address first usage date.
ShipAddressUsageIndicator	Shipping address usage indicator.
ShipIndicator	Shipping method indicator.
ShipNameIndicator	Shipping Name Indicator.
SPCIncompletionIndicator	SPC Incompletion Indicator.
SPCTransactionAdditionalData	SPC Transaction Additional Data.
SPCTransactionChallenge	SPC Transaction Challenge.
SPCTransactionChallengeInfoText	SPC Transaction Challenge Information Text.
SPCTransactionCurrency	SPC Transaction Currency.
SPCTransactionDisplayName	SPC Transaction Display Name.
SPCTransactionExtensionIndicator	SPC Transaction WebAuthn SPC Extension Indicator.
SPCTransactionIcon	SPC Transaction Icon.
SPCTransactionIssuerImage	SPC Transaction Issuer Default Image.
SPCTransactionIssuerImageDark	SPC Transaction Issuer Dark Mode Image.
SPCTransactionIssuerImageMonochrome	SPC Transaction Issuer Monochrome Image.
SPCTransactionPayeeName	SPC Transaction Payee Name.
SPCTransactionPayeeOrigin	SPC Transaction Payee Origin.
SPCTransactionPSImage	SPC Transaction Payment System Default Image.
SPCTransactionPSImageDark	SPC Transaction Payment System Dark Mode Image.
SPCTransactionPSImageMonochrome	SPC Transaction Payment System Monochrome Image.
SPCTransactionTimeout	SPC Transaction Transaction Timeout.
SPCTransactionValue	SPC Transaction Value.
SplitSDKLimited	Limited Split-SDK Indicator.
SplitSDKVariant	Split-SDK Variant.
StoreCardRangeData	Whether or not to store the card ranges in the CardRanges collection.
SuspiciousAccountActivity	Suspicious account activity indicator.
TaxId	Tax ID.
ThreeDSMethodId	3DS Method ID.
ThreeDSRequestorSpcSupport	3DS Requestor SPC Support.
ThreeRIIndicator	3RI Indicator.
TransactionChallengeExemption	Transaction Challenge Exemption.
TransactionStatusReason	Reason for value of TransactionStatus.
TransactionStatusReasonInfo	Transaction Status Reason Information.
TransactionType	Transaction Type.
TrustListStatus	Trust List Status.
TrustListStatusSource	Trust List Status Source.
UseAESGCM	Whether or not to use AESGCM as the encryption algorithm.
UseJsonDOM	Whether or not the control should build an internal DOM when parsing card ranges.
WebAuthnCredentialListCount	The total number of WebAuthen Credentials.
WebAuthnCredentialListWebAuthnCredential	WebAuthn Credential List: WebAuthn Credential.
WebAuthnCredListRelyingPartyId	WebAuthn Credential List: Relying Party ID.
WhitelistStatus	Whitelist Status.
WhitelistStatusSource	Whitelist Status Source.
XChildCount	The number of child elements of the current element.
XChildName[i]	The name of the child element.
XChildXText[i]	The inner text of the child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the returned XML or JSON response.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.

AcceptLanguage Property (Server Control)

HTTP accept language header value sent from the cardholder's browser.

Syntax

servercontrol.AcceptLanguage[=string]

Default Value

""

Remarks

Value representing the browser language preference present in the HTTP header, as defined in IETF BCP 47.

This property accepts a comma separated list of language tags. For example: en,fr-FR

Valid for ProtocolVersion 2.3.1 only.

Data Type

String

AccountType Property (Server Control)

Indicates the type of account.

Syntax

servercontrol.AccountType[=string]

Default Value

""

Remarks

This is included in the Authentication Request Message (AReq) sent to the directory server. Required if the 3-D Secure Requestor is asking the cardholder which account type they are using before making the purchase. Required in some markets (for example, for merchants in Brazil). Otherwise, this is optional.

Valid values are as follows:

01	Not applicable
02	Credit
03	Debit

Data Type

String

AcquirerBIN Property (Server Control)

Acquiring institution identification code.

Syntax

servercontrol.AcquirerBIN[=string]

Default Value

""

Remarks

This value correlates to the Acquirer BIN as defined by each payment system or directory server. This field is required to be set for payment authentication.

Data Type

String

AcquirerCountryCode Property (Server Control)

Acquirer Country Code.

Syntax

servercontrol.AcquirerCountryCode[=string]

Default Value

""

Remarks

The code of the country where the acquiring institution is located (in accordance with ISO 3166).

This value should be formatted as a ISO 3166-1 numeric three-digit country code.

Valid for ProtocolVersion 2.3.1 only.

Data Type

String

AcquirerMerchantId Property (Server Control)

Acquirer-assigned merchant identifier.

Syntax

servercontrol.AcquirerMerchantId[=string]

Default Value

""

Remarks

This field contains the merchant identifier assigned by the acquirer. The merchant id is required to be set for payment authentication.

Data Type

String

ACSProtocolInfoCount Property (Server Control)

The number of records in the ACSProtocolInfo arrays.

Syntax

servercontrol.ACSProtocolInfoCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ACSProtocolInfoIndicator
• ACSProtocolInfoProtocolVersion
• ACSProtocolInfoSupportedMsgExt
• ACSProtocolInfoThreeDSMethodURL

The array indices start at 0 and end at ACSProtocolInfoCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ACSProtocolInfoIndicator Property (Server Control)

Additional information on the card range as supplied by the ACS.

Syntax

servercontrol.ACSProtocolInfoIndicator(ACSProtocolInfoIndex)

Default Value

""

Remarks

Additional information on the card range as supplied by the ACS. This field is a comma separated list of values returned from the server; possible values are:

01	Authentication Available at ACS
02	Attempts Supported by ACS or DS
03	Decoupled Authentication Supported
04	Trust List Supported
05	Device Binding Supported
06	WebAuthn Authentication Supported
07	SPC Authentication Supported
08	Transaction Risk Analysis Exemption Supported
09	Trust List Exemption Supported
10	Low Value Exemption Supported
11	Secure Corporate Payments Exemption Supported
12-79	Reserved for EMVCo future use (values invalid until defined by EMVCo)
80-99	Reserved for DS use

The ACSProtocolInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSProtocolInfoCount property.

This property is read-only and not available at design time.

Data Type

String

ACSProtocolInfoProtocolVersion Property (Server Control)

The Protocol Version supported by the ACS for the card range.

Syntax

servercontrol.ACSProtocolInfoProtocolVersion(ACSProtocolInfoIndex)

Default Value

""

Remarks

The Protocol Version supported by the ACS for the card range.

The ACSProtocolInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSProtocolInfoCount property.

This property is read-only and not available at design time.

Data Type

String

ACSProtocolInfoSupportedMsgExt Property (Server Control)

A list of message extensions supported by the ACS that contains the Assigned Extension Group Identifier and the Extension Version Number.

Syntax

servercontrol.ACSProtocolInfoSupportedMsgExt(ACSProtocolInfoIndex)

Default Value

""

Remarks

A list of message extensions supported by the ACS that contains the Assigned Extension Group Identifier and the Extension Version Number.

This field is a comma separate list of values returned from the server in the following format:

id,version;id2,version2;...

The ACSProtocolInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSProtocolInfoCount property.

This property is read-only and not available at design time.

Data Type

String

ACSProtocolInfoThreeDSMethodURL Property (Server Control)

The ACS URL that will be used by the 3DS Method for a particular protocol version.

Syntax

servercontrol.ACSProtocolInfoThreeDSMethodURL(ACSProtocolInfoIndex)

Default Value

""

Remarks

The ACS URL that will be used by the 3DS Method for a particular protocol version.

The ACSProtocolInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSProtocolInfoCount property.

This property is read-only and not available at design time.

Data Type

String

ACSURL Property (Server Control)

URL of the ACS to be used for the challenge.

Syntax

servercontrol.ACSURL[=string]

Default Value

""

Remarks

This field contains the fully qualified URL of the ACS to be used for the challenge. This will be populated after the call to SendAuthRequest method if the Authentication Response Message (ARes) indicates that a challenge is required.

Data Type

String

AuthenticationECI Property (Server Control)

Value to be passed in the authorization message.

Syntax

servercontrol.AuthenticationECI

Default Value

""

Remarks

This property is determined by the Access Control Server (ACS), and is filled after the call to SendAuthRequest (for a frictionless flow), or when the Results Request Message (RReq) is parsed using CheckResponse (for a challenge flow).

This property contains the two digit Electronic Commerce Indicator (ECI) value, which is to be submitted in a credit card authorization message. This value indicates to the processor that the customer data in the authorization message has been authenticated. The data contained within this property is only valid if the TransactionStatus is "Y" or "A".

This property is read-only.

Data Type

String

AuthenticationIndicator Property (Server Control)

3DS Requestor Authentication Indicator.

Syntax

servercontrol.AuthenticationIndicator[=string]

Default Value

"01"

Remarks

Indicates the type of Authentication request. This data element provides additional information to the ACS to determine the best approach for handing an authentication request. Included in the Authorization Request Message (ARes) sent by the SendAuthRequest method. Possible values are:

01	Payment - default
02	Recurring
03	Installment
04	Add Card
05	Maintain Card
06	Verify Cardholder
07	Billing Agreement

Data Type

String

AuthenticationValue Property (Server Control)

Used to provide proof of authentication.

Syntax

servercontrol.AuthenticationValue

Default Value

""

Remarks

This property is determined by the Access Control Server (ACS), and is filled after the call to SendAuthRequest (for a frictionless flow), or when the Results Request Message (RReq) is parsed using CheckResponse (for a challenge flow).

This property will be valid if the TransactionStatus is "Y" or "A". The value may be used to provide proof of authentication.

This property is read-only.

Data Type

String

BillingAddressCity Property (Server Control)

The city of the address.

Syntax

servercontrol.BillingAddressCity[=string]

Default Value

""

Remarks

The city of the address. The maximum length is 50 characters.

Data Type

String

BillingAddressCountry Property (Server Control)

The country of the address.

Syntax

servercontrol.BillingAddressCountry[=string]

Default Value

""

Remarks

The country of the address. The format is a 3 digit country code as defined in ISO 3166-1.

Data Type

String

BillingAddressLine1 Property (Server Control)

The first line of the street address or equivalent local portion of the address.

Syntax

servercontrol.BillingAddressLine1[=string]

Default Value

""

Remarks

The first line of the street address or equivalent local portion of the address. The maximum length is 50 characters.

Data Type

String

BillingAddressLine2 Property (Server Control)

The second line of the street address or equivalent local portion of the address.

Syntax

servercontrol.BillingAddressLine2[=string]

Default Value

""

Remarks

The second line of the street address or equivalent local portion of the address. The maximum length is 50 characters.

Data Type

String

BillingAddressLine3 Property (Server Control)

The third line of the street address or equivalent local portion of the address.

Syntax

servercontrol.BillingAddressLine3[=string]

Default Value

""

Remarks

The third line of the street address or equivalent local portion of the address. The maximum length is 50 characters.

Data Type

String

BillingAddressPostalCode Property (Server Control)

The ZIP or other postal code of the address.

Syntax

servercontrol.BillingAddressPostalCode[=string]

Default Value

""

Remarks

The ZIP or other postal code of the address. The maximum length is 16 characters.

Data Type

String

BillingAddressState Property (Server Control)

The state or province of the address.

Syntax

servercontrol.BillingAddressState[=string]

Default Value

""

Remarks

The state or province of the address. The maximum length is 3 characters and should be the country subdivision code defined in ISO 3166-2.

Data Type

String

BrowserAcceptHeader Property (Server Control)

HTTP accept header sent from the cardholder's browser.

Syntax

servercontrol.BrowserAcceptHeader[=string]

Default Value

""

Remarks

This field contains the exact content of the HTTP accept header as sent to the merchant from the cardholder's user agent. This field is required only if the cardholder's user agent supplied a value.

Data Type

String

BrowserIPAddress Property (Server Control)

IP address of the cardholder's browser.

Syntax

servercontrol.BrowserIPAddress[=string]

Default Value

""

Remarks

This field contains the IP address of the cardholder's browser as returned by the HTTP headers.

Data Type

String

BrowserJavaEnabledVal Property (Server Control)

Ability of the cardholder's browser to execute Java.

Syntax

servercontrol.BrowserJavaEnabledVal[=integer]

Possible Values

jeNotPresent(0), 
jeTrue(1), 
jeFalse(2)

Default Value

0

Remarks

This field contains a value representing the ability of the cardholder's browser to execute Java.

Possible values are as follows:

jeNotPresent (0)	Not Present
jeTrue (1)	True
jeFalse (2)	False

Data Type

Integer

BrowserJavaScriptEnabledVal Property (Server Control)

Ability of the cardholder's browser to execute JavaScript.

Syntax

servercontrol.BrowserJavaScriptEnabledVal[=integer]

Possible Values

bjeNotPresent(0), 
bjeTrue(1), 
bjeFalse(2)

Default Value

0

Remarks

This field contains a value representing the ability of the cardholder's browser to execute JavaScript.

Possible values are as follows:

bjeNotPresent (0)	Not Present
bjeTrue (1)	True
bjeFalse (2)	False

Data Type

Integer

BrowserLanguage Property (Server Control)

The cardholder's browser language.

Syntax

servercontrol.BrowserLanguage[=string]

Default Value

""

Remarks

This field contains the cardholder's browser language as defined in IETF BCP 47.

Data Type

String

BrowserScreenColorDepth Property (Server Control)

The screen color depth of the cardholder's browser.

Syntax

servercontrol.BrowserScreenColorDepth[=string]

Default Value

""

Remarks

This field contains a value representing the bit depth of the color palette, in bits per pixel, for displaying images.

For ProtocolVersion 2.1.0, this field is required. If BrowserJavaEnabledVal is False, a value of 1 can be used. When using ProtocolVersion of 2.2.0 or 2.3.1 and both BrowserJavaEnabledVal and BrowserJavaScriptEnabledVal are False, no value is required.

Data Type

String

BrowserScreenHeight Property (Server Control)

The screen height of the cardholder's browser.

Syntax

servercontrol.BrowserScreenHeight[=string]

Default Value

""

Remarks

This field contains the total height of the cardholder's screen in pixels.

For ProtocolVersion 2.1.0, this field is required. If BrowserJavaEnabledVal is False, a value of 0 can be used. When using ProtocolVersion of 2.2.0 or 2.3.1 and both BrowserJavaEnabledVal and BrowserJavaScriptEnabledVal are False, no value is required.

Data Type

String

BrowserScreenWidth Property (Server Control)

The screen width of the cardholder's browser.

Syntax

servercontrol.BrowserScreenWidth[=string]

Default Value

""

Remarks

This field contains the total width of the cardholder's screen in pixels.

For ProtocolVersion 2.1.0, this field is required. If BrowserJavaEnabledVal is False, a value of 0 can be used. When using ProtocolVersion of 2.2.0 or 2.3.1 and both BrowserJavaEnabledVal and BrowserJavaScriptEnabledVal are False, no value is required.

Data Type

String

BrowserTimeZone Property (Server Control)

The timezone offset of the cardholder's browser.

Syntax

servercontrol.BrowserTimeZone[=string]

Default Value

""

Remarks

This field contains the difference between UTC time and the cardholder's browser local time in minutes.

For ProtocolVersion 2.1.0, this field is required. If BrowserJavaEnabledVal is False, a value of 0 can be used. When using ProtocolVersion of 2.2.0 or 2.3.1 and both BrowserJavaEnabledVal and BrowserJavaScriptEnabledVal are False, no value is required.

Data Type

String

BrowserUserAgent Property (Server Control)

The User-Agent provided by the cardholder's browser.

Syntax

servercontrol.BrowserUserAgent[=string]

Default Value

""

Remarks

This field contains the exact content of the HTTP User-Agent header.

Data Type

String

CardExpDate Property (Server Control)

Expiration date of the PAN or Token.

Syntax

servercontrol.CardExpDate[=string]

Default Value

""

Remarks

This field contains the expiration date of the PAN or Token supplied in the CardNumber property. The format for this field is YYMM.

Data Type

String

CardholderEmail Property (Server Control)

The cardholder email address.

Syntax

servercontrol.CardholderEmail[=string]

Default Value

""

Remarks

This field contains the cardholder email address to be sent to the directory server when calling SendAuthRequest.

Data Type

String

CardholderHomePhone Property (Server Control)

The cardholder home phone number.

Syntax

servercontrol.CardholderHomePhone[=string]

Default Value

""

Remarks

This field contains the home phone number provided by the card holder.

Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899)

The "-" is used to separate the "Country Code" and "Subscriber" sections. The values are then formatted according to the EMVCo specification (a JSON object) in the request like so:

  "homePhone": {
    "cc": "1",
    "subscriber": "1234567899"
  }

Data Type

String

CardholderMobilePhone Property (Server Control)

The cardholder mobile phone number.

Syntax

servercontrol.CardholderMobilePhone[=string]

Default Value

""

Remarks

This field contains the mobile phone number provided by the cardholder.

Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899)

The "-" is used to separate the "Country Code" and "Subscriber" sections. The values are then formatted according to the EMVCo specification (a JSON object) in the request like so:

  "homePhone": {
    "cc": "1",
    "subscriber": "1234567899"
  }

Data Type

String

CardholderName Property (Server Control)

Name of the cardholder.

Syntax

servercontrol.CardholderName[=string]

Default Value

""

Remarks

This property contains the name of the cardholder. Limited to the alphanumeric characters listed in EMV Book 4, Annex B. Required to be set unless market or regional mandates restricts sending this information.

Data Type

String

CardholderWorkPhone Property (Server Control)

The cardholder work phone number.

Syntax

servercontrol.CardholderWorkPhone[=string]

Default Value

""

Remarks

This field contains the work phone number provided by the cardholder.

Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899)

The "-" is used to separate the "Country Code" and "Subscriber" sections. The values are then formatted according to the EMVCo specification (a JSON object) in the request like so:

  "homePhone": {
    "cc": "1",
    "subscriber": "1234567899"
  }

Data Type

String

CardNumber Property (Server Control)

Customer's account number that will be authenticated.

Syntax

servercontrol.CardNumber[=string]

Default Value

""

Remarks

This property contains the customer's credit card number (PAN) or token that will be used in the authorization request for payment transactions. This property is 13-19 characters long.

Data Type

String

CardRangeCount Property (Server Control)

The number of records in the CardRange arrays.

Syntax

servercontrol.CardRangeCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• CardRangeACSEndProtocolVersion
• CardRangeACSInformationIndicator
• CardRangeACSStartProtocolVersion
• CardRangeAction
• CardRangeDSEndProtocolVersion
• CardRangeDSStartProtocolVersion
• CardRangeEnd
• CardRangeMethodURL
• CardRangeStart

The array indices start at 0 and end at CardRangeCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

CardRangeACSEndProtocolVersion Property (Server Control)

The most recent active protocol version that is supported by the ACS.

Syntax

servercontrol.CardRangeACSEndProtocolVersion(CardRangeIndex)

Default Value

""

Remarks

The most recent active protocol version that is supported by the ACS.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeACSInformationIndicator Property (Server Control)

Additional information on the card range as supplied by the ACS.

Syntax

servercontrol.CardRangeACSInformationIndicator(CardRangeIndex)

Default Value

"0"

Remarks

Additional information on the card range as supplied by the ACS. This property is a comma separate list of values returned from the server; possible values are:

• 01 - Authentication Available at ACS
• 02 - Attempts Supported by ACS or DS
• 03 - Decoupled Authentication Supported
• 04 - Whitelisting Supported
• 05 - Device Binding Supported (2.3.1 only)
• 06 - WebAuthn Authentication Supported (2.3.1 only)
• 07 - SPC Authentication Supported (2.3.1 only)
• 08 - Transaction Risk Analysis Exemption Supported (2.3.1 only)
• 09 - Trust List Exemption Supported (2.3.1 only)
• 10 - Low Value Exemption Supported (2.3.1 only)
• 11 - Secure Corporate Payments Exemption Supported (2.3.1 only)
• 80-99 - Reserved for DS Use

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeACSStartProtocolVersion Property (Server Control)

The earliest (i.

Syntax

servercontrol.CardRangeACSStartProtocolVersion(CardRangeIndex)

Default Value

""

Remarks

The earliest (i.e. oldest) active protocol version that is supported by the ACS.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeAction Property (Server Control)

The action to be taken with the card range specified by the Start and End properties.

Syntax

servercontrol.CardRangeAction(CardRangeIndex)

Default Value

""

Remarks

The action to be taken with the card range specified by the CardRangeStart and CardRangeEnd fields. Possible values are:

• A - Add the card range to the cache (default value)
• D - Delete the card range from the cache
• M - Modify the card range data

If the SerialNumber was not included in the Card Range Request, the Action will be A (add) for all ranges returned. If no action is returned for the card range (empty value), it can be assumed that the action for the range is A.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeDSEndProtocolVersion Property (Server Control)

The most recent active protocol version that is supported by the DS.

Syntax

servercontrol.CardRangeDSEndProtocolVersion(CardRangeIndex)

Default Value

""

Remarks

The most recent active protocol version that is supported by the DS.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeDSStartProtocolVersion Property (Server Control)

The earliest (i.

Syntax

servercontrol.CardRangeDSStartProtocolVersion(CardRangeIndex)

Default Value

""

Remarks

The earliest (i.e. oldest) active protocol version that is supported by the DS.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeEnd Property (Server Control)

Last number in a range of credit card numbers returned by the Directory Server.

Syntax

servercontrol.CardRangeEnd(CardRangeIndex)

Default Value

""

Remarks

Last number in a range of credit card numbers returned by the Directory Server.

This property contains the final card number in the current range. The first number in the current range is contained in CardRangeStart, and the action (add or delete) to take on this range is contained in CardRangeAction. Note that the card ranges must be processed in the order returned.

Card ranges returned by a Card Range Request are for credit cards that support 3-D Secure. If the customer's credit card number is not within one of these ranges, you cannot use 3-D Secure for that card. Examples of card numbers that may not be eligible for 3-D Secure are check cards, corporate cards, and gift cards.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeMethodURL Property (Server Control)

The ACS URL that will be used by the 3DS method.

Syntax

servercontrol.CardRangeMethodURL(CardRangeIndex)

Default Value

""

Remarks

The ACS URL that will be used by the 3DS method.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

CardRangeStart Property (Server Control)

First number in a range of credit card numbers returned by the Directory Server.

Syntax

servercontrol.CardRangeStart(CardRangeIndex)

Default Value

""

Remarks

First number in a range of credit card numbers returned by the Directory Server.

This property contains the first card number in the current range. The final number in the current range is contained in CardRangeEnd, and the action (add or delete) to take on this range is contained in CardRangeAction. Note that the card ranges must be processed in the order returned.

Card ranges returned by a Card Range Request are for credit cards that support 3-D Secure. If the customer's credit card number is not within one of these ranges, you cannot use 3-D Secure for that card. Examples of card numbers that may not be eligible for 3-D Secure are check cards, corporate cards, and gift cards.

The CardRangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CardRangeCount property.

This property is read-only and not available at design time.

Data Type

String

ChallengeWindowSize Property (Server Control)

Challenge window size.

Syntax

servercontrol.ChallengeWindowSize[=integer]

Default Value

1

Remarks

This field indicates the dimensions of the challenge window that has been displayed to the cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience.

Preconfigured sizes are width x height in pixels of the window displayed in the cardholder browser. Possible values are:

1	250 x 400
2	390 x 400
3	500 x 600
4	600 x 400
5	Full screen

This value is included in the Challenge Request Message (CReq) generated by the component when the GetChallengeRequest methods are called.

Data Type

Integer

ClientAuthRequest Property (Server Control)

The data received by the control to be sent in the authentication request.

Syntax

servercontrol.ClientAuthRequest[=string]

Default Value

""

Remarks

The 3DS SDK should prepare data to be sent by the 3DS Server control. Set ClientAuthRequest to the data received from the 3DS SDK before calling SendAuthRequest.

See the 3DS SDK documentation for details on preparing this data.

Data Type

String

ClientAuthResponse Property (Server Control)

The authentication response for an app-based flow.

Syntax

servercontrol.ClientAuthResponse

Default Value

""

Remarks

This property is populated after calling SendAuthRequest, and is only applicable for the app-based flow. If a challenge is required, this data should be sent back to the 3DS SDK over the secure channel.

See SendAuthRequest for more details about handling the response.

This property is read-only.

Data Type

String

DataPacketOut Property (Server Control)

Contains the data packet sent to the server.

Syntax

servercontrol.DataPacketOut

Default Value

""

Remarks

After calling either the RequestCardRanges, or SendAuthRequest methods, this property will contain the entire data packet that was sent. Also, after calling the GetChallengeRequest or GetResultsResponse method, this property will contain the constructed messages. The contents of this property should be logged for each transaction.

This property is read-only and not available at design time.

Data Type

String

DeviceChannel Property (Server Control)

Device channel.

Syntax

servercontrol.DeviceChannel[=string]

Default Value

"02"

Remarks

This field indicates the type of channel interface being used to initiate the transaction.

Possible values include:

01	App-based
02 - default	Browser
03	3DS Requestor Initiated (3RI)

Data Type

String

DirectoryServerURL Property (Server Control)

The address of the Directory Server.

Syntax

servercontrol.DirectoryServerURL[=string]

Default Value

""

Remarks

This is the URL to which the RequestCardRanges and SendAuthRequest methods post.

Data Type

String

DSSupportedProtocols Property (Server Control)

Protocol Versions supported by the DS.

Syntax

servercontrol.DSSupportedProtocols[=integer]

Default Value

0

Remarks

The active protocol versions supported by the Directory Server. A bitwise OR of the following values:

2.1.0	0x02
2.2.0	0x04
2.3.1	0x08

Data Type

Integer

DSURLCount Property (Server Control)

The number of records in the DSURL arrays.

Syntax

servercontrol.DSURLCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• DSURLCountryCode
• DSURLThreeDSServerToDsUrl

The array indices start at 0 and end at DSURLCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

DSURLCountryCode Property (Server Control)

The country for which the 3DS Server to DS URL can be used.

Syntax

servercontrol.DSURLCountryCode(DSURLIndex)

Default Value

""

Remarks

The country for which the 3DS Server to DS URL can be used.

The DSURLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DSURLCount property.

This property is read-only and not available at design time.

Data Type

String

DSURLThreeDSServerToDsUrl Property (Server Control)

URL that the 3DS Server uses to communicate with a DS for a particular card range.

Syntax

servercontrol.DSURLThreeDSServerToDsUrl(DSURLIndex)

Default Value

""

Remarks

URL that the 3DS Server uses to communicate with a DS for a particular card range. If the DS Country Code is absent, the 3DS Server can use this URL for all card ranges.

The DSURLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DSURLCount property.

This property is read-only and not available at design time.

Data Type

String

ErrorPacket Property (Server Control)

The error packet.

Syntax

servercontrol.ErrorPacket

Default Value

""

Remarks

If an error is encountered while parsing a received packet using the CheckResponse method, this field will be populated with an error packet to be sent back to the server.

If the message being parsed is an error, this field will be populated with the received error packet itself.

This property is read-only.

Data Type

String

ExtensionCount Property (Server Control)

The number of records in the Extension arrays.

Syntax

servercontrol.ExtensionCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ExtensionCritical
• ExtensionData
• ExtensionId
• ExtensionName

The array indices start at 0 and end at ExtensionCount - 1.

This property is not available at design time.

Data Type

Integer

ExtensionCritical Property (Server Control)

Whether the extension is critical.

Syntax

servercontrol.ExtensionCritical(ExtensionIndex)[=boolean]

Default Value

False

Remarks

Whether the extension is critical.

This setting specifies whether the recipient must understand the contents of the extension to interpret the entire message.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

Boolean

ExtensionData Property (Server Control)

The extension data as JSON.

Syntax

servercontrol.ExtensionData(ExtensionIndex)[=string]

Default Value

""

Remarks

The extension data as JSON.

This setting specifies the JSON formatted extension data.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

String

ExtensionId Property (Server Control)

The id of the specified extension.

Syntax

servercontrol.ExtensionId(ExtensionIndex)[=string]

Default Value

""

Remarks

The id of the specified extension.

This setting specifies a unique identifier for the extension.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

String

ExtensionName Property (Server Control)

The extension name.

Syntax

servercontrol.ExtensionName(ExtensionIndex)[=string]

Default Value

""

Remarks

The extension name.

This setting specifies the name of the extension as defined by the extension owner.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

String

MerchantCategoryCode Property (Server Control)

Merchant category code.

Syntax

servercontrol.MerchantCategoryCode[=string]

Default Value

""

Remarks

DS-specific code describing the Merchant's type of business, product, or service. Required to be set prior to calling SendAuthRequest.

Data Type

String

MerchantCountryCode Property (Server Control)

Country code of the merchant.

Syntax

servercontrol.MerchantCountryCode[=string]

Default Value

""

Remarks

This field contains the country code of the merchant. This value correlates to the Merchant Country Code as defined by each Payment System or DS. Required to be set prior to calling SendAuthRequest.

Data Type

String

MerchantName Property (Server Control)

Merchant name.

Syntax

servercontrol.MerchantName[=string]

Default Value

""

Remarks

The name of the merchant as assigned by the acquirer or payment system. Required to be set prior to calling SendAuthRequest.

Data Type

String

MessageCategory Property (Server Control)

The category of the message.

Syntax

servercontrol.MessageCategory[=string]

Default Value

""

Remarks

This field identifies the category of the message (Payment Authentication or Non-Payment Authentication). This will be sent in the Authentication Request Message (AReq) sent by the component when SendAuthRequest is called, and in the Results Request Message (RReq) received from the directory server (populated after calling CheckResponse.

Possible values include:

01 (default)	PA (Payment Authentication)
02	NPA (Non-Payment Authentication)

Data Type

String

MethodNotificationURL Property (Server Control)

The URL to which the method notification will be posted.

Syntax

servercontrol.MethodNotificationURL[=string]

Default Value

""

Remarks

This property specifies the URL to which the ACS will post when the method execution has completed. This must be set before calling GetMethodData. See GetMethodData for more details.

Data Type

String

NotificationURL Property (Server Control)

The notification URL to which the challenge response is sent.

Syntax

servercontrol.NotificationURL[=string]

Default Value

""

Remarks

This property specifies the URL to which the final challenge response is POSTed in a browser-based flow. This must be set before calling SendAuthRequest.

After the challenge interaction is complete the ACS will post data to the URL specified in this property to notify the application that the challenge is complete. The data received at this URL can be processed by calling CheckResponse. See GetChallengeRequest and CheckResponse for more details.

Data Type

String

OperationInfoCategory Property (Server Control)

Indicates the category/type of information.

Syntax

servercontrol.OperationInfoCategory

Default Value

""

Remarks

Indicates the category/type of information.

01	General
02	Operational alert
03	Public Key Certificate expiry
04	Letter of Approval/Attestation of Compliance expiry
05	Fraud
06	Other
80-99	Reserved for DS use

This property is read-only and not available at design time.

Data Type

String

OperationInfoDescription Property (Server Control)

Describes the reason for the operational communication or the response to an action taken by the recipient.

Syntax

servercontrol.OperationInfoDescription

Default Value

""

Remarks

Describes the reason for the operational communication or the response to an action taken by the recipient.

This property is read-only and not available at design time.

Data Type

String

OperationInfoExpirationDate Property (Server Control)

The date after which the relevance of the operational information expires.

Syntax

servercontrol.OperationInfoExpirationDate

Default Value

""

Remarks

The date after which the relevance of the operational information expires.

This property is read-only and not available at design time.

Data Type

String

OperationInfoMessageStatus Property (Server Control)

Indicates the status of the operational request message sequence from the source of the OReq.

Syntax

servercontrol.OperationInfoMessageStatus[=string]

Default Value

""

Remarks

Indicates the status of the operational request message sequence from the source of the OReq.

01	Successfully received messages
02	Message sequence is broken
03	Requested action is not supported or not executed by the 3DS Server or ACS when OReq message was received
80-99	Reserved for DS use

This property is not available at design time.

Data Type

String

OperationInfoPriorTransactionId Property (Server Control)

The transaction ID of the prior transaction to which the operational information refers.

Syntax

servercontrol.OperationInfoPriorTransactionId

Default Value

""

Remarks

The transaction ID of the prior transaction to which the operational information refers.

This property is read-only and not available at design time.

Data Type

String

OperationInfoPriorTransactionIdType Property (Server Control)

The type of transaction ID of the prior transaction to which the operational information refers.

Syntax

servercontrol.OperationInfoPriorTransactionIdType

Default Value

0

Remarks

The type of transaction ID of the prior transaction to which the operational information refers.

01	3DS Server
02	DS
03	ACS

This property is read-only and not available at design time.

Data Type

Integer

OperationInfoSequenceId Property (Server Control)

Uniquely identifies a message sequence and will remain constant in the sequence of messages.

Syntax

servercontrol.OperationInfoSequenceId

Default Value

""

Remarks

Uniquely identifies a message sequence and will remain constant in the sequence of messages.

This property is read-only and not available at design time.

Data Type

String

OperationInfoSequenceNumber Property (Server Control)

The current message in the sequence.

Syntax

servercontrol.OperationInfoSequenceNumber[=integer]

Default Value

0

Remarks

The current message in the sequence. Set this before calling CheckResponse when an OReq packet is received. The component will verify the sequence number of the received OReq to ensure it's not out of sequence.

This property is not available at design time.

Data Type

Integer

OperationInfoSequenceTotal Property (Server Control)

The total number of messages in the sequence and will remain constant in the sequence of messages.

Syntax

servercontrol.OperationInfoSequenceTotal

Default Value

0

Remarks

The total number of messages in the sequence and will remain constant in the sequence of messages.

This property is read-only and not available at design time.

Data Type

Integer

OperationInfoSeverity Property (Server Control)

Indicates the importance/severity level of the operational information.

Syntax

servercontrol.OperationInfoSeverity

Default Value

""

Remarks

Indicates the importance/severity level of the operational information.

01	Critical
02	Major
03	Minor
04	Informational
80-99	Reserved for DS use

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (Server Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

servercontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (Server Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

servercontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (Server Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

servercontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (Server Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

servercontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (Server Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

servercontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (Server Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

servercontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

psAutomatic (0)	Default setting. If the URL is an https URL, the control will use the psTunnel option. If the URL is an http URL, the control will use the psNever option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (Server Control)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

servercontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

PurchaseAmount Property (Server Control)

Purchase amount to be authorized.

Syntax

servercontrol.PurchaseAmount[=string]

Default Value

""

Remarks

This field contains the purchase amount to be authorized. The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated PurchaseExponent. This field may not contain a negative number.

Data Type

String

PurchaseCurrency Property (Server Control)

Identifies the type of currency used by the merchant.

Syntax

servercontrol.PurchaseCurrency[=string]

Default Value

"840"

Remarks

This field contains the three digit number assigned by the signing member or processor to identify the currency in which PurchaseCurrency is expressed. This property should contain the ISO-4217 numeric code. For example, the ISO code for US Dollars is "840".

Data Type

String

PurchaseDate Property (Server Control)

The date of the transaction.

Syntax

servercontrol.PurchaseDate[=string]

Default Value

""

Remarks

This field contains the date and time of the purchase, expressed in UTC. The format of this field must be: YYYYMMDDHHMMSS

Data Type

String

PurchaseExponent Property (Server Control)

Minor units of currency.

Syntax

servercontrol.PurchaseExponent[=string]

Default Value

"2"

Remarks

This field indicates the minor units, or number of decimal places, of the currency specified in the PurchaseCurrency property. For instance, the Japanese Yen has a value of "0", the US Dollar a value of "2", and the Kuwati Dinar a value of "3".

Data Type

String

RangeCount Property (Server Control)

The number of records in the Range arrays.

Syntax

servercontrol.RangeCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• RangeEnd
• RangeStart

The array indices start at 0 and end at RangeCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

RangeEnd Property (Server Control)

The final card number in the current range.

Syntax

servercontrol.RangeEnd(RangeIndex)

Default Value

""

Remarks

The final card number in the current range.

The RangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.

This property is read-only and not available at design time.

Data Type

String

RangeStart Property (Server Control)

The first card number in the current range.

Syntax

servercontrol.RangeStart(RangeIndex)

Default Value

""

Remarks

The first card number in the current range.

The RangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.

This property is read-only and not available at design time.

Data Type

String

RecurringExpDate Property (Server Control)

Recurring expiration date.

Syntax

servercontrol.RecurringExpDate[=string]

Default Value

""

Remarks

This field contains the date after which no further authorizations shall be performed. The format of this field must be: YYYYMMDD

Required when AuthenticationIndicator is 02 or 03, or when ThreeRIIndicator is 01 or 02.

Data Type

String

RecurringFrequency Property (Server Control)

The number of days between recurring payments.

Syntax

servercontrol.RecurringFrequency[=string]

Default Value

""

Remarks

This field indicates the minimum number of days between authorizations.

Required when AuthenticationIndicator is 02 or 03, or when ThreeRIIndicator is 01 or 02.

Data Type

String

RequestorId Property (Server Control)

Directory server assigned 3DS Requestor identifier.

Syntax

servercontrol.RequestorId[=string]

Default Value

""

Remarks

This field contains the 3DS Requestor identifier as assigned by the directory server. This is sent in the Authentication Request Message (AReq) sent by the component in the SendAuthRequest method.

Data Type

String

RequestorName Property (Server Control)

Directory server assigned 3DS Requestor name.

Syntax

servercontrol.RequestorName[=string]

Default Value

""

Remarks

This field contains the 3DS Requestor name as assigned by the directory server. This is sent in the Authentication Request Message (AReq) sent by the component in the SendAuthRequest method.

Data Type

String

RequestorURL Property (Server Control)

3DS Requestor website or customer care site.

Syntax

servercontrol.RequestorURL[=string]

Default Value

""

Remarks

This field contains the fully qualified URL of the 3DS Requestor website or customer care site. This is sent in the Authentication Request Message (AReq) sent by the component in the SendAuthRequest method.

Data Type

String

ResultsStatus Property (Server Control)

The status of the Results Request.

Syntax

servercontrol.ResultsStatus[=integer]

Default Value

0

Remarks

This field contains the status of the results request and is used when generating the Results Response Message (RRes) via the GetResultsResponse method. This will indicate if the message was successfully received for further processing or provide more detail to the ACS on why the challenge could not be completed.

Possible values include:

01	Results Request Received for further Processing.
02	Challenge Request not sent to ACS by 3DS Requestor (3DS Server or 3DS Requestor opted out of the challenge).
03	ARes challenge data not delivered to the 3DS Requestor due to technical error.

Before calling GetResultsResponse, the Server can use the value of the RequestorChallengeInd to determine whether or not a value of 02 is appropriate. It must use the necessary error handling logic when processing ARes messages to determine whether or not a value of 03 is appropriate.

Data Type

Integer

ResultsURL Property (Server Control)

3DS Server URL.

Syntax

servercontrol.ResultsURL[=string]

Default Value

""

Remarks

Full qualified URL of the 3DS Server to which the directory server will send the Results Request Message (RReq) after the challenge has completed. This is sent to the directory server when calling the SendAuthRequest method.

Data Type

String

SDKType Property (Server Control)

Type of the 3DS SDK used for the app-based flow.

Syntax

servercontrol.SDKType[=string]

Default Value

"01"

Remarks

Indicates the type of 3DS SDK. This provides additional information to the DS and ACS to determine the best approach for handling the transaction.

Valid values are:

01	Default-SDK
02	Split-SDK

When Default-SDK is selected (01), SDKWrapped can be used to indicate if the Default-SDK is embedded as a wrapped component in the 3DS Requestor App.

When Split-SDK is selected (02), SplitSDKVariant will indicate the implementation charactistics of the Split-SDK client, and SplitSDKLimited can be used to indicate if the Split-SDK client has limited capabilities.

This property is valid for ProtocolVersion 2.3.1 only.

Data Type

String

SerialNumber Property (Server Control)

Serial number indicating the state of the current card range cache.

Syntax

servercontrol.SerialNumber[=string]

Default Value

""

Remarks

If this element is present when submitting a Preparation Request Message (PReq) with the RequestCardRanges method, the directory server returns card ranges that have been updated since the time of the response which returned this serial number. If this element is not present, the directory server returns all card ranges. This field is updated with a new serial number after each call to RequestCardRanges.

Data Type

String

ServerTransactionId Property (Server Control)

Server transaction identifier.

Syntax

servercontrol.ServerTransactionId[=string]

Default Value

""

Remarks

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction. This value is generated by the control when GetMethodData or SendAuthRequest is called.

Data Type

String

ShippingAddressCity Property (Server Control)

The city of the address.

Syntax

servercontrol.ShippingAddressCity[=string]

Default Value

""

Remarks

The city of the address. The maximum length is 50 characters.

Data Type

String

ShippingAddressCountry Property (Server Control)

The country of the address.

Syntax

servercontrol.ShippingAddressCountry[=string]

Default Value

""

Remarks

The country of the address. The format is a 3 digit country code as defined in ISO 3166-1.

Data Type

String

ShippingAddressLine1 Property (Server Control)

The first line of the street address or equivalent local portion of the address.

Syntax

servercontrol.ShippingAddressLine1[=string]

Default Value

""

Remarks

The first line of the street address or equivalent local portion of the address. The maximum length is 50 characters.

Data Type

String

ShippingAddressLine2 Property (Server Control)

The second line of the street address or equivalent local portion of the address.

Syntax

servercontrol.ShippingAddressLine2[=string]

Default Value

""

Remarks

The second line of the street address or equivalent local portion of the address. The maximum length is 50 characters.

Data Type

String

ShippingAddressLine3 Property (Server Control)

The third line of the street address or equivalent local portion of the address.

Syntax

servercontrol.ShippingAddressLine3[=string]

Default Value

""

Remarks

The third line of the street address or equivalent local portion of the address. The maximum length is 50 characters.

Data Type

String

ShippingAddressPostalCode Property (Server Control)

The ZIP or other postal code of the address.

Syntax

servercontrol.ShippingAddressPostalCode[=string]

Default Value

""

Remarks

The ZIP or other postal code of the address. The maximum length is 16 characters.

Data Type

String

ShippingAddressState Property (Server Control)

The state or province of the address.

Syntax

servercontrol.ShippingAddressState[=string]

Default Value

""

Remarks

The state or province of the address. The maximum length is 3 characters and should be the country subdivision code defined in ISO 3166-2.

Data Type

String

SSLAcceptServerCertEncoded Property (Server Control)

This is the certificate (PEM/base64 encoded).

Syntax

servercontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (Server Control)

This is the certificate (PEM/base64 encoded).

Syntax

servercontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (Server Control)

This is the name of the certificate store for the client certificate.

Syntax

servercontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (Server Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

servercontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (Server Control)

This is the type of certificate store for this certificate.

Syntax

servercontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used the control will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (Server Control)

This is the subject of the certificate used for client authentication.

Syntax

servercontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLServerCertEncoded Property (Server Control)

This is the certificate (PEM/base64 encoded).

Syntax

servercontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (Server Control)

A timeout for the control.

Syntax

servercontrol.Timeout[=integer]

Default Value

30

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 30 seconds.

Data Type

Integer

TransactionStatus Property (Server Control)

The transaction status from the last parsed message (ARes, RReq, or CRes).

Syntax

servercontrol.TransactionStatus

Default Value

""

Remarks

Indicates whether a transaction qualifies as an authenticated transaction or account verification. Possible values are:

Y	Authentication/account verification successful.
N	Not authenticated/account not verified; transaction denied.
U	Authentication/account verification could not be performed; technical or other problem as indicated in ARes or RReq.
A	Attempts processing performed; not authenticated/verified, but a proof of attempted authentication/verification is provided.
C	Challenge required; additional authentication is required using the CReq/CRes.
R	Authentication/account verification rejected; issuer is rejecting authentication/verification and request that authorization not be attempted.
D	Challenge required; decoupled authentication confirmed.
I	Informational only; 3DS Requestor challenge preference acknowledged.

Note: The CRes message can contain only a value of Y or N. Values of D and I are only applicable for 3DS version 2.2.0.

This property is read-only.

Data Type

String

AddExtension Method (Server Control)

Adds an extension to the collection.

Syntax

servercontrol.AddExtension Id, Name, Critical, Data

Remarks

Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in Message Extensions. AddExtension adds a new extension to the Extensions collection.

Note: The maximum number of extensions is 10.

AddRequestField Method (Server Control)

Adds a field to the data in the request.

Syntax

servercontrol.AddRequestField Name, Value, ValueType

Remarks

This method can be used to extend the requests constructed by the control. When this method is called, the component will add the specified field to the end of the request.

CheckResponse Method (Server Control)

Parses the specified message.

Syntax

servercontrol.CheckResponse response

Remarks

CheckResponse parses a variety of messages that are sent to the Server as part of the authentication process.

The following messages can be parsed using this method:

• The threeDSMethodData form variables received at the MethodNotificationURL
• The Results Request (RReq) message received at the ResultsURL
• The cres form variables received at the NotificationURL
• The Operation Request Message (OReq) sent from a DS.

When calling the method, pass the message to be parsed as the Response parameter. The properties which are populated after calling this method vary depending on the type of message being parsed. See below for additional information.

Method Data from MethodNotificationURL

After calling GetMethodData, a request is made to the CardRangeMethodURL. After this, the ACS will make a POST to MethodNotificationURL to inform the requestor of completion. Retrieve the threeDSMethodData form variable value that was POSTed and pass it to this method. After calling this method, the following properties are populated:

• ServerTransactionId

The ServerTransactionId may be used to match the response with the request.

Results Request message from ResultsURL

When a challenge is completed for both app-based and browser-based flows, a POST is made to the ResultsURL with a Results Request message.

Prior to checking this RReq message, the ServerTransactionId can be extracted using the ExtractRReqServerTransactionId configuration setting. This value can then be used to look up details on the transaction that were saved prior to starting the challenge process, including the messageVersion which must be set via the ProtocolVersion configuration setting prior to passing the RReq message to the CheckResponse method.

Pass the body of the HTTP request received at ResultsURL to this method. This contains information about the results, and asks for a Results Response to be sent back containing the ResultsStatus.

After calling this method, the following properties are populated:

• AuthenticationECI
• TransactionStatus
• TransactionStatusReason
• ChallengeCancellationIndicator
• AuthenticationType
• AuthenticationValue

To respond to the POST, set ResultsStatus to the appropriate value and call GetResultsResponse to build a response message to be sent back to the directory server. Use the value from GetResultsResponse in your application as the body of the HTTP response. Set the Content-Type header to application/JSON; charset=utf-8

Final Challenge Response from NotificationURL

In a browser-based flow, the challenge takes place directly between the cardholder and the ACS in a separate iframe or window. The ACS will POST the final challenge response to the NotificationURL after the challenge is complete. Retrieve the cres form variable value from the POST data and pass it to CheckResponse. After calling this method the following properties are populated:

• ServerTransactionId
• TransactionStatus

In addition to the cres variable, a threeDSSessionData variable will be present if SessionData was set before calling GetChallengeRequest. The threeDSSessionData value POSTed to NotificationURL may be passed to EncodedSessionData. Query SessionData to get the decoded session data.

Operation Request Message (OReq)

OReq messages are used to communicate operational information from a DS to the 3DS Server. This message is not part of the 3-D Secure authentication flow.

When an OReq message is received, CheckResponse should be called to validate the message. There may be more than one OReq message sent in a sequence, and CheckResponse should be called for each. The current instance of the Server object can be cached for the duration of the OReq sequence until the final OReq is received. The Operation.SequenceNumber should also be set prior to calling CheckResponse. The component will verify the sequence number of the received OReq to ensure it's not out of sequence.

After calling this method, details are made available in Operation.

If any OReq data element fails validation, Operation.MessageStatus will be set to "02". If the OReq is valid, Operation.MessageStatus will be empty.

If the OReq is valid, determine if the final OReq has been received (Operation.SequenceNumber equals Operation.SequenceTotal). If these values match, the final OReq in the sequence has been received, and GetOperationResponse can be used to generate the ORes message.

For valid OReq messages that are not the final OReq in the sequence, the response should be HTTP Status 200 (OK) with an empty HTTP body.

Config Method (Server Control)

Sets or retrieves a configuration setting.

Syntax

servercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetChallengeRequest Method (Server Control)

Builds the Challenge Request (CReq) for browser-based flow.

Syntax

servercontrol.GetChallengeRequest 

Remarks

The GetChallengeRequest method is used to build the Challenge Request (CReq) which will be sent in a form post to the ACSURL property via the cardholder browser.

An iframe should be created in the cardholder's browser, which will be used to send the challenge request and allow the cardholder and ACS to interact directly.

The size of the challenge window (iframe) may be any of the sizes listed in ChallengeWindowSize. Before calling this method set ChallengeWindowSize to the appropriate value to let the ACS know the size of the window on the cardholder's browser.

Calling this method will return a string which should be placed in a creq form variable.

The SessionData setting may also be set with any data that may be helpful to continue processing the transaction after the final challenge response is received at the NotificationURL. To prepare the session data for submission, query EncodedSessionData. The encoded string may then be placed in the threeDSSessionData form variable.

Note: The maximum length of the threeDSSessionData form variable, after being encoded, is 1024 bytes.

Example Form

Response Handling

Once the challenge has been completed by the cardholder, the directory server will post a Results Request (RReq) to the ResultsURL specified when calling SendAuthRequest. See CheckResponse and GetResultsResponse for more details.

The ACS will also post the Challenge Response to the NotificationURL specified when calling SendAuthRequest. This post contains data which may be parsed to verify the challenge results. See CheckResponse for more details.

GetMethodData Method (Server Control)

Prepares method data to be sent to the ACS before the authentication request is sent.

Syntax

servercontrol.GetMethodData 

Remarks

The GetMethodData method prepares data to be transmitted to the ACS via the cardholder's browser.

When a transaction begins, the card range cache should be queried to find details about the card range to which the card number belongs. If a CardRangeMethodURL is defined for the card range, this method should be used to prepare data to be sent via the cardholder's browser to the CardRangeMethodURL.

If the CardRangeMethodURL is not set for the specified card range, set MethodCompletionIndicator to U before calling SendAuthRequest.

The following properties are applicable when calling this method:

• MethodNotificationURL (required)

This method returns a string which contains encoded data to be sent to the ACS. This includes ServerTransactionId and MethodNotificationURL. After calling this method, the returned string can be transmitted to the ACS via the cardholder's browser.

As per the EMVCo specification, create a hidden iframe in the browser and send a form with the field name threeDSMethodData containing the return value from this method and post the form to the CardRangeMethodURL.

The ACS will record information about the customer's environment and then POST back to the MethodNotificationURL. The page at this URL should expect a form variable with the name threeDSMethodData which will contain the original ServerTransactionId value in order to match the response with the request. The form variable value will be base64url encoded and may be passed directly to the CheckResponse method. The control will decode and parse the received value and populate ServerTransactionId with the value from the received data.

If the response from the ACS is not received within 10 seconds, set MethodCompletionIndicator to N before calling SendAuthRequest.

GetOperationResponse Method (Server Control)

Builds and returns the Operation Response Message (ORes) to be sent back to the Directory Server.

Syntax

servercontrol.GetOperationResponse 

Remarks

This method builds the Operation Response Message (ORes) to be sent back to the Directory Server in an HTTP reply to the final Operation Request (OReq) message. It returns a JSON object containing the fields required for the ORes.

When an OReq message is received, CheckResponse should be called to validate the message. There may be more than one OReq message sent in a sequence, and CheckResponse should be called for each. While several OReq messages may be received in a sequence (totalling Operation.SequenceTotal), the ORes message is only expected to be generated using GetOperationResponse after the final OReq. For valid intermediate OReq messages the response should be HTTP Status 200 (OK) with an empty HTTP body.

After passing the final received OReq message to the CheckResponse method, all the properties required to be set before building the ORes will have been populated except for Operation.MessageStatus, which indicates whether or not the message was successfully received for further processing, or provides more detail to the DS on why the requested action could not be completed.

Possible values include:

01	Successfully received messages.
02	Message sequence is broken.
03	Requested action is not supported or not executed by the 3DS Server or ACS when OReq message was received.
04	Reserved for DS use

If any OReq data element fails validation from CheckResponse, Operation.MessageStatus will be set to "02". The ErrorPacket can be queried and should be returned to the DS.

For valid OReq messages, Operation.MessageStatus will be empty. Next, determine if the final OReq has been received (Operation.SequenceNumber equals Operation.SequenceTotal). If these values match, the final OReq in the sequence has been received, and GetOperationResponse can be used to generate the ORes message.

Once Operation.MessageStatus has been set, GetOperationResponse can be called and will return a string containing the reply to be sent in the response. In your HTTP server, use the string returned from this method as the body of the reply and set the Content-Type header to application/JSON; charset=utf-8

GetResultsResponse Method (Server Control)

Builds and returns the Results Response Message (RRes) to be sent back to the directory server.

Syntax

servercontrol.GetResultsResponse 

Remarks

This method builds the Results Response Message (RRes) to be sent back to the directory server in the HTTP reply to the Results Request (RReq). It returns a JSON object containing the fields required for the RRes.

After passing the received RReq message to the CheckResponse method, all the properties required to be set before building the RRes will have been populated except for ResultsStatus, which indicates whether or not the message was successfully received for further processing, or provides more detail to the ACS on why the challenge could not be completed.

Possible values include:

01	Results Request Received for further Processing.
02	Challenge Request not sent to ACS by 3DS Requestor (3DS Server or 3DS Requestor opted out of the challenge).
03	ARes challenge data not delivered to the 3DS Requestor due to technical error.

The Server can use the value of the RequestorChallengeInd to determine whether or not a value of 02 is appropriate. It must use the necessary error handling logic when processing ARes messages to determine whether or not a value of 03 is appropriate.

Once ResultsStatus has been set, GetResultsResponse can be called and will return a string containing the reply to be sent in the response. In your HTTP server, use the string returned from this method as the body of the reply and set the Content-Type header to application/JSON; charset=utf-8

Interrupt Method (Server Control)

Interrupts the current action.

Syntax

servercontrol.Interrupt 

Remarks

This method interrupts any processing that the control is currently executing.

RequestCardRanges Method (Server Control)

Requests card ranges from the directory server.

Syntax

servercontrol.RequestCardRanges 

Remarks

RequestCardRanges requests card ranges and additional information from the directory server.

When a transaction is initiated, the first step that should be taken is to find information about the card range to which the card number belongs. This includes the protocol version(s) supported by the ACS and DS, and if one exists, any corresponding Method URL (used in the browser flow).

Results of this method should be cached in order to quickly look up information when processing transactions. It is recommended to call this method once every 24 hours at a minimum, and once per hour as a maximum to refresh the cache. The control will not cache the returned values; it is up to the user to cache these values in an appropriate location.

The first time this method is called, SerialNumber will be empty, indicating that all results should be returned. This is an offset the server will use to return only new updates to the card ranges (if any) since the last request. The SerialNumber will be populated after this method returns, and this value should be saved to be used in subsequent calls.

When a response is received, the card ranges will be made available via the component events and properties.

When ProtocolVersion is set to 2.3.1, the CardRangeData event will fire for each card range data object received, and the Ranges and ACSProtocolInfos properties will be populated to be accessed within the event handler.

When ProtocolVersion is set to 2.2.0 or 2.1.0, the CardRange event will fire for each card range that is returned, and the results will also be held in the CardRanges property.

The following properties are applicable when calling this method:

• DirectoryServerURL (required)
• SerialNumber
• ServerTransactionId
• ServerOperatorId
• EnableDownloadCardRangeDataFile (2.3.1 only)

The following properties are populated after calling this method:

• CardRanges
• DSStartProtocolVersion
• DSEndProtocolVersion
• SerialNumber
• DSTransactionId
• ResendRequestCardRanges

Note that when ProtocolVersion 2.3.1, the card range data is only available using the CardRangeData event.

When using ProtocolVersion 2.2.0 or 2.3.1, the returned ranges may include ACS Information Indicators. These are used to indicate additional functionality supported by the ACS for the card range(s). For 2.2.0, a ACSInformationIndicator field is exposed in both CardRanges collection and CardRange event. In version 2.3.1, this information is availalbe in the ACSProtocolInfos collection via the Indicator field. Possible values are:

• 01 - Authentication Available at ACS
• 02 - Attempts Supported by ACS or DS
• 03 - Decoupled Authentication Supported
• 04 - Whitelisting Supported
• 05 - Device Binding Supported (2.3.1 only)
• 06 - WebAuthn Authentication Supported (2.3.1 only)
• 07 - SPC Authentication Supported (2.3.1 only)
• 08 - Transaction Risk Analysis Exemption Supported (2.3.1 only)
• 09 - Trust List Exemption Supported (2.3.1 only)
• 10 - Low Value Exemption Supported (2.3.1 only)
• 11 - Secure Corporate Payments Exemption Supported (2.3.1 only)
• 80-99 - Reserved for DS Use

If an error is identified with the card range data received from the directory server when calling the RequestCardRanges method, the ResendRequestCardRanges configuration setting will be true, indicating that the request should be resent. When resending, if SerialNumber was specified for the initial request, it should be set to an empty string before calling RequestCardRanges again. Otherwise, the request can be sent without the serial number again, but the server may respond with an error due to multiple requests within an hour.

Note that retrieving card ranges can consume a lot of memory, especially when retrieving the initial set of ranges. The StoreCardRangeData and UseJsonDOM configuration settings can be set to help minimize the amount of memory used. A CardRangeTempPath setting can also be used to specify a temporary path to which the PRes packet will be temporarily written prior to parsing.

When using ProtocolVersion 2.3.1, if UseJsonDOM is false, the card ranges will need to be cached and processed after the RequestCardRanges method returns. The card ranges would then need to be processed in the order indicated by the CardRangeRecordsReadOrder configuration setting. A check will also need to be made for overlap of ranges. If issue(s) are found, the ReportCardRangeError configuration setting should be used to report the error to the directory server.

Reset Method (Server Control)

Clears all properties to their default values.

Syntax

servercontrol.Reset 

Remarks

This method clears all properties to their default values.

ResetTransactionInfo Method (Server Control)

Resets transaction specific information.

Syntax

servercontrol.ResetTransactionInfo 

Remarks

This method must be called between transactions when using the same control instance.

Each transaction that is attempted uses transaction specific values that should not be re-used in subsequent transactions. Call this method to make sure that any transaction specific information is cleared between transactions.

This method resets only the transaction specific information without resetting any other values which have been configured. This allows re-use of the same component instance.

In a Browser-Based flow the following are reset:

• Internal ephemeral encryption keys
• Values added by AddRequestField
• AccountType
• ACSURL
• AppIP
• AppURLIndicator
• AuthenticationECI
• AuthenticationValue
• BillingAddress
• BrowserAcceptHeader
• BrowserIPAddress
• BrowserJavaEnabledVal
• BrowserJavaScriptEnabledVal
• BrowserLanguage
• BrowserScreenColorDepth
• BrowserScreenHeight
• BrowserTimeZone
• BrowserUserAgent
• BrowserUserDeviceId
• BrowserUserId
• CardExpDate
• CardholderEmail
• CardholderHomePhone
• CardholderMobilePhone
• CardholderName
• CardholderWorkPhone
• CardNumber
• ClientAuthRequest
• ClientAuthResponse
• DataPacketOut
• ErrorPacket
• Operation
• PurchaseAmount
• PurchaseDate
• RecurringExpDate
• RecurringFrequency
• ResultsStatus
• ServerTransactionId
• ShippingAddress
• TransactionStatus
• AccountAgeIndicator
• AccountChangeDate
• AccountChangeIndicator
• AccountDate
• AccountDayTransactions
• AccountId
• AccountPasswordChangeDate
• AccountPasswordChangeIndicator
• AccountProvisioningAttempts
• AccountPurchaseCount
• AccountYearTransactions
• ACSChallengeMandatedIndicator
• ACSReferenceNumber
• ACSTransactionId
• AddressMatch
• AuthenticationType
• CardholderInformation
• ChallengeCancellationIndicator
• DecoupledRequestIndicator
• DeliveryEmailAddress
• DeliveryTimeframe
• DSReferenceNumber
• DSTransactionId
• EncodedSessionData
• IncomingRawExtensions
• OutgoingRawExtensions
• Extensions
• IncomingExtensionCount
• IncomingExtensionId
• IncomingExtensionName
• IncomingExtensionCritical
• IncomingExtensionData
• GiftCardAmount
• GiftCardCount
• GiftCardCurrency
• InstalmentPaymentData
• InteractionCounter
• MethodCompletionIndicator
• PaymentAccountAge
• PaymentAccountAge
• PaymentAccountAgeIndicator
• PaymentAccountAgeIndicator
• PreOrderDate
• PreOrderPurchaseIndicator
• AuthenticationInformation
• ReorderItemsIndicator
• ReqAuthData
• ReqAuthMethod
• ReqAuthTimestamp
• SessionData
• ShipAddressUsageDate
• ShipAddressUsageIndicator
• ShipIndicator
• ShipNameIndicator
• SuspiciousAccountActivity
• ThreeRIIndicator
• TransactionStatusReason
• TransactionType
• WhitelistStatus
• WhitelistStatusSource
• EMVPaymentTokenSource

SendAuthRequest Method (Server Control)

Sends the authentication request to the directory server.

Syntax

servercontrol.SendAuthRequest 

Remarks

SendAuthRequest begins the 3-D Secure transaction flow by sending an authentication request to the DirectoryServerURL.

After calling this method, check TransactionStatus to determine if the cardholder is authenticated (frictionless flow) or further cardholder interaction is required to complete the authentication (challenge flow).

Prior to calling SendAuthRequest, data must to be collected to facilitate fraud checks by the ACS. The following properties are applicable for both app-based and browser-based flows:

• AcquirerBIN (required)
• AcquirerMerchantId (required)
• CardholderName (required)
• CardNumber (required)
• DirectoryServerURL (required)
• MerchantCategoryCode (required)
• MerchantCountryCode (required)
• MerchantName (required)
• PurchaseAmount (required)
• PurchaseDate (required)
• RequestorId (required)
• RequestorName (required)
• RequestorURL (required)
• ResultsURL (required)
• AccountType
• AuthenticationIndicator
• BillingAddress*
• CardholderEmail
• CardholderHomePhone
• CardholderMobilePhone
• CardholderWorkPhone
• DecoupledMaxTimeout
• DecoupledRequestIndicator
• DeviceChannel
• MessageCategory
• PurchaseCurrency
• PurchaseExponent
• ServerOperatorId
• ServerTransactionId
• ShippingAddress*
• ThreeRIIndicator

App-Based Flow

In the app-based flow, device specific information is prepared by the 3DS SDK on the customer's device. This is transmitted to the 3DS Server control via a secure channel, the specifics of which are outside the scope of the controls. Set ClientAuthRequest to this data prepared by the 3DS SDK.

Browser-Based Flow

Before calling this method, first check the cached card-range data to determine if a CardRangeMethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.

If no CardRangeMethodURL is present for the given card, set MethodCompletionIndicator to U.

If a CardRangeMethodURL has been specified by the ACS for the card number, the URL must be loaded in the cardholder's browser to allow the ACS to collect additional browser information for risk-based decision making. See the GetMethodData for further details.

Once the method URL invocation is complete, the authentication request may be sent. If the method URL invocation failed, set MethodCompletionIndicator to N before calling SendAuthRequest.

The following additional properties are applicable in browser-based flow:

• NotificationURL (required)
• BrowserAcceptHeader (required)
• BrowserLanguage (required)
• BrowserScreenHeight (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserScreenWidth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserTimeZone (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserUserAgent (required)
• BrowserIPAddress (conditional)
• BrowserJavaEnabledVal (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserJavaScriptEnabledVal (not valid in 2.1.0, required in 2.2.0 and 2.3.1)
• BrowserScreenColorDepth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• AcceptLanguage (2.3.1 only)
• AcquirerCountryCode (2.3.1 only)

Response Handling

After calling this method the TransactionStatus property holds the result. Possible values are:

Transaction Status	Description
Y	Authenticated successfully
C	Cardholder challenge required
N	Not authenticated
A	Not authenticated, but a proof of authentication attempt was generated in AuthenticationValue
U	Not authenticated due to technical or other issue
R	Not authenticated because the issuer is rejecting authentication
D	Challenge required; decoupled authentication confirmed
I	Informational only; 3DS Requestor challenge preference acknowledged
S	Challenge using SPC

If the transaction is authenticated (Y or A), no further steps are required. The flow is considered frictionless and the 3-D Secure processing is complete. If processing a payment, the AuthenticationValue and AuthenticationECI values can be included as proof of 3-D Secure authentication.

If the transaction requires a cardholder challenge (C, D or S), further steps are required.

If the transaction is not authenticated, TransactionStatusReason may contain details about the reason.

The following properties are applicable after calling this method:

• AuthenticationECI
• AuthenticationValue
• TransactionStatus
• TransactionStatusReason
• CardholderInformation
• ACSURL (if challenge required)
• ACSChallengeMandatedIndicator (if challenge required)
• AuthenticationType (if challenge required)
• DecoupledConfirmationIndicator

Response Handling - App-Based Flow

After calling this method, ClientAuthResponse is populated with data to be transmitted back to the 3DS SDK. If a challenge is required, the ClientAuthResponse data is used by the 3DS SDK to start when initiating the challenge process.

The 3DS Server is responsible for indicating to the 3DS SDK the results of the SendAuthRequest process, and whether or not a challenge is required. Exactly how this is done is outside the scope of the controls themselves. The response to the 3DS SDK over the secure channel should include information on what to do next.

Note: The TransactionStatus is also populated in the 3DS Server control and may be inspected prior to transmitting ClientAuthResponse back to the 3DS SDK.

Response Handling - Browser-Based Flow

If TransactionStatus is C, then additional steps are required to complete the authentication. The GetChallengeRequest method should be called next to obtain data to be sent to the ACSURL in an authentication window in the customer's browser. Once authentication is complete, the ACS will post the results to the ResultsURL value that was specified when calling SendAuthRequest.

See the GetChallengeRequest method for more details.

If TransactionStatus is D, then decoupled authentication has been accepted by the ACS. DecoupledConfirmationIndicator will have a value of Y as well. Authentication will happen outside of the 3-D Secure flow and, when complete, the ACS will post the results to the ResultsURL that was specified when calling SendAuthRequest.

The DecoupledTimeRemaining value, which is calculated based on the DecoupledMaxTimeout value sent in the initial authentication request, can be checked to see the amount of time remaining before decoupled authentication must be completed. If the ACS does not post the results before this value runs out, it can be assumed that decoupled authentication was not successful.

SPC-Based Authentication

SPC (Secure Payment Confirmation) provides a method to perform a challenge using preestablished FIDO credentials when using a Browser. The SPC authentication can be initiated by the 3DS Requestor via an extra AReq/ARes message pair or by the ACS via a standard Browser Challenge Flow.

For an SPC authentication to execute correctly, the following prerequisites apply:

1. The ACS has an enrolled FIDO authenticator on the device for this Cardholder.
2. The 3DS Requestor and/or the ACS have detected that the Cardholder Browser supports the related SPC APIs (allow="payment *; publickey-credentialsget *"). For the ACS, this information can be obtained via the Browser User Agent data element or via data obtained via the 3DS Method

SPC-based authentication can be enabled with the following additions:

Prior to sending the initial authentication request packet (AReq) using the SendAuthRequest method, the ThreeDSRequestorSpcSupport configuration setting should be set to Y to indicate that SPC is supported by the 3DS Requestor.

If SPC is accepted by the ACS, the resulting TransactionStatus should be S. The response will also contain a list of enrolled FIDO (WebAuthn) credentials associated with the cardholder, and SPC transaction data. This data is available in the following configuration settings:

• WebAuthnCredentialListCount
• WebAuthnCredentialListWebAuthnCredential
• WebAuthnCredListRelyingPartyId
• SPCTransactionAdditionalData
• SPCTransactionChallenge
• SPCTransactionChallengeInfoText
• SPCTransactionCurrency
• SPCTransactionDisplayName
• SPCTransactionIcon
• SPCTransactionIssuerImage
• SPCTransactionIssuerImageDark
• SPCTransactionIssuerImageMonochrome
• SPCTransactionPayeeName
• SPCTransactionPayeeOrigin
• SPCTransactionPSImage
• SPCTransactionPSImageDark
• SPCTransactionPSImageMonochrome
• SPCTransactionTimeout
• SPCTransactionValue

If a new instance of the Server component will be used after authentication to send the second AReq, the AuthenticationInformation value should be saved to be used later.

This information is relayed to the 3DS Requestor implementation, and the 3DS Requestor invokes the SPC authentication (SPC API) against the WebAuthn Credential list. The cardholder authenticates using the FIDO authenticator on their device, and the 3DS Requestor retrieves the Assertion Data from the SPC API call.

The 3DS Server is then configured to includes this FIDO Assertion Data is then included in a new authentication request by setting the ReqAuthData and a ReqAuthMethod of 09. If the AuthenticationInformation value was saved earlier, it can be set via the same configuration setting. If the 3DS Requestor encounters an error during SPC API invokation, this can be indicated using the SPCIncompletionIndicator.

The SendAuthRequest method should then be called again to transmit this data to the ACS (by way of the DS) in a second AReq.

When SendAuthRequest returns, the 3DS Server proceed the same as the regular browser-based flow when the ARes is returned.

Note that SPC-based authentication is only available when a ProtocolVersion of 2.3.1 is used.

CardRange Event (Server Control)

Fired when the response to a Preparation Request Message (PReq) is received.

Syntax

Sub servercontrol_CardRange(RangeStart As String, RangeEnd As String, RangeAction As String, ACSStartProtocolVersion As String, ACSEndProtocolVersion As String, DSStartProtocolVersion As String, DSEndProtocolVersion As String, ThreeDSMethodURL As String, ACSInformationIndicator As String, Valid As Boolean)

Remarks

The CardRange event fires for each range of card numbers to be added or removed from the cache. The RangeAction parameter indicates whether the range specified by the RangeStart and RangeEnd arguments is to be added or deleted from the current cache.

RangeStart	13-19 digit account number from the Directory indicating the first number in a range of account numbers to be added or deleted from the current cache.
RangeEnd	13-19 digit account number from the Directory indicating the last number in a range of account numbers to be added or deleted from the current cache. This End number must be the same length as the Start number.
RangeAction	Indicates the action to be taken with the card range specified by the RangeStart and RangeEnd parameters. Possible values are: A - Add the card range to the cache (default value) D - Delete the card range from the cache M - Modify the card range data If the SerialNumber was not included in the Card Range Request, the Action will be A (add) for all ranges returned. If no action is returned for the card range (empty value), it can be assumed that the action for the range is A.
ACSStartProtocolVersion	The earliest (i.e. oldest) active protocol version that is supported by the ACS.
ACSEndProtocolVersion	The most recent active protocol version that is supported by the ACS URL.
DSStartProtocolVersion	The earliest (i.e. oldest) active protocol version that is supported by the DS.
DSEndProtocolVersion	The most recent active protocol version that is supported by the DS.
ThreeDSMethodURL	The fully qualified ACS URL that will be used by the 3DS method.
ACSInformationIndicator	Additional information on the card range as supplied by the ACS. This field is a comma separate list of values returned from the server; possible values are: 01 - Authentication Available at ACS 02 - Attempts Supported by ACS or DS 03 - Decoupled Authentication Supported 04 - Whitelisting Supported 05 - Device Binding Supported (2.3.1 only) 06 - WebAuthn Authentication Supported (2.3.1 only) 07 - SPC Authentication Supported (2.3.1 only) 08 - Transaction Risk Analysis Exemption Supported (2.3.1 only) 09 - Trust List Exemption Supported (2.3.1 only) 10 - Low Value Exemption Supported (2.3.1 only) 11 - Secure Corporate Payments Exemption Supported (2.3.1 only) 80-99 - Reserved for DS Use
Valid	Whether or not the card range data is valid. If an issue is found with the card range data, this can be set to false to cause a 203 error to be returned to the directory server.

Note that the card ranges must be processed in the order returned.

These card ranges are also returned outside this event in the CardRangeStart, CardRangeEnd, CardRangeAction, CardRangeACSStartProtocolVersion, CardRangeACSEndProtocolVersion, and CardRangeMethodURL properties.

CardRangeData Event (Server Control)

Fired when the response to a Preparation Request Message (PReq) is received. This event is used for card range data returned when version 2.3.1 of the protocol is used.

Syntax

Sub servercontrol_CardRangeData(RangeAction As String, IssuerCountryCode As String, DSProtocolVersions As Integer, Status As Integer)

Remarks

When card ranges are requested using using ProtocolVersion 2.3.1, the CardRangeData event will fire for each card range data object received in the Preparation Response Message (PRes) returned from the directory server.

This data indicates the most recent protocol versions supported by the ACS and, optionally, the DS that hosts that range. If configured, the ACS URL for the 3DS Method will be included as well, along with the 3DS features supported by the ACS, such as Trust List or Decoupled Authentication.

The RangeAction parameter indicates whether the ranges defined in the Ranges property are to be added, deleted, or modified in the current cache.

RangeAction	Indicates the action to be taken with the card range specified by the RangeStart and RangeEnd parameters. Possible values are: A - Add the card range to the cache (default value) D - Delete the card range from the cache M - Modify the card range data If the SerialNumber was not included in the Card Range Request, the Action will be A (add) for all ranges returned. If no action is returned for the card range (empty value), it can be assumed that the action for the range is A.
IssuerCountryCode	The Issuer country for the ranges. An ISO 3166-1 numeric three-digit country code.
DSProtocolVersions	The active protocol versions supported by the Directory Server. A bitwise OR of the following values: 2.1.0 0x02 2.2.0 0x04 2.3.1 0x08 Note that the protocol versions may also be returned outside of the individual card ranges. These versions will be present in the DSSupportedProtocols property.
Status	If an issue is found with the card range, it can be reported by setting the Status parameter. Possible values are: 0: Valid (default) 1: Overlap in the card ranges provided by the DS in the PRes message. 2: Action is not possible for the card range. When set to a non-zero value, the control will automatically report the appropriate error to the DS.

Within the event, a few properties will also be populated, both with details for the current ranges in question. The Ranges collection will hold the card ranges for which the rest of the data applies. The ACSProtocolInfos collection will hold protocol versions and other associated information supported by the ACS for the card ranges.

DataPacketIn Event (Server Control)

Fired when receiving a data packet from the server.

Syntax

Sub servercontrol_DataPacketIn(DataPacket As String)

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the DataPacket parameter. This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this component.

DataPacketOut Event (Server Control)

Fired when sending a data packet to the server.

Syntax

Sub servercontrol_DataPacketOut(DataPacket As String)

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the DataPacket parameter. This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this component.

DSURL Event (Server Control)

Fired for each DS URL present in the Preparation Response Message (PRes).

Syntax

Sub servercontrol_DSURL(ThreeDSServerToDsUrl As String, DSCountryCode As String)

Remarks

The DSURL event fires for each DS URL returned from the directory server when requesting card ranges via the RequestCardRanges method.

Each DSURL object contains a ThreeDSServerToDsUrl and, optionally, a CountryCode. For a given card range, if the Issuer Country Code matches the DS CountryCode, the 3DS Server uses this ThreeDSServerToDsUrl to communicate with the DS. If there is no match, the 3DS Server uses the default 3DS Server to DS URL.

Error Event (Server Control)

Information about errors during data delivery.

Syntax

Sub servercontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (Server Control)

Fires once for each log message.

Syntax

Sub servercontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

Logging in the component is handled through the Log event. This will fire anytime a message is built or a response is parsed, including error messages.

When the Log event is fired, the message in question is made available via the Message event parameter. Properties such as EphemeralKey and DeviceParams are also available when they are gathered by the Client. The other event arguments are LogType and LogLevel:

The LogType parameter indicates the type of the log entry. Possible values are:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"
• "AReq"
• "ARes"
• "CReq"
• "CRes"
• "RReq"
• "RRes"
• "PReq"
• "PRes"
• "Erro"
• "EphemeralKey"
• "DeviceParams"

The LogLevel configuration setting can be used to specify the detail of the logs raised through the Log event. The LogLevel parameter in the event indicates the log level to which the current message belongs.

It is recommended to output all messages raised in this event to a file for record keeping purposes, or for later debugging issues that may have come up.

The Server and Client components also have DataPacketIn and DataPacketOut events that fire anytime a data packet is received or sent, respectively. The entire data packet is then accessible in the DataPacket event parameter. For encrypted packets, this would contain the full encrypted data. This parameter may be inspected for advanced troubleshooting.

MessageExtension Event (Server Control)

Fired when a Message Extension is present in a message being parsed.

Syntax

Sub servercontrol_MessageExtension(Name As String, Id As String, Data As String, Critical As Boolean, Recognized As Boolean)

Remarks

Enables the parsing of Message Extension data by firing when extensions have been included in a ARes, CRes, RReq or PRes message that is being parsed. Message Extensions carry additional data not defined in the 3DS Protocol. This event fires once for each such extension. Event arguments correspond to the four elements comprising the extension, as well as an indication of whether or not the extension is recognized:

Name	'name' element - extension name
Id	'id' element - assigned extension group identifier
Data	'data' element - message extension data
Critical	'criticalityIndicator' element - criticality indicator
Recognized	set by component to indicate whether or not the extension is recognized

If a 3-D Secure application receives a message containing a critical extension that it does not recognize, it must treat it as invalid and return Error Code = 202. This event will fire before the exception is thrown.

SSLServerAuthentication Event (Server Control)

Fired after the server presents its certificate to the client.

Syntax

Sub servercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Server Control)

Shows the progress of the secure connection.

Syntax

Sub servercontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (Server Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

Server Config Settings

AccountAgeIndicator:   Cardholder Account Age Indicator. Length of time that the cardholder has had the account with the 3DS Requestor. Possible values are: 01 No account (guest check-out) 02 Created during this transaction 03 Less than 30 days 04 30-60 days 05 More than 60 days An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. The complete list of elements (all available as config settings) comprising Cardholder Account Information is: AccountAgeIndicator AccountChangeDate AccountChangeIndicator AccountDate AccountPasswordChangeDate AccountPasswordChangeIndicator AccountPurchaseCount AccountProvisioningAttempts AccountDayTransactions AccountYearTransactions PaymentAccountAge PaymentAccountAgeIndicator ShipAddressUsageDate ShipAddressUsageIndicator ShipNameIndicator SuspiciousAccountActivity

AccountChangeDate:   Cardholder Account Change Date. Date that the cardholder's account with the 3DS Requestor was last changed. Accepted date format is YYYYMMDD. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountChangeIndicator:   Cardholder Account Change Indicator. Length of time since the cardholder's account information with the 3DS Requestor was last changed. Possible values are: 01 Changed during this transaction 02 Less than 30 days 03 30-60 days 04 More than 60 days An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountDate:   Date cardholder account opened. Date that the cardholder opened the account with the 3DS Requestor. Accepted date format is YYYYMMDD. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountDayTransactions:   Number of account transactions in the last day. Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountId:   Cardholder Account Identifier. Additional information about the account optionally provided by the 3DS Requestor in AReq messages.

AccountPasswordChangeDate:   Cardholder Account Password Change Date. Date that cardholder's account with the 3DS Requestor had a password change or account reset. Accepted date format is YYYYMMDD. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountPasswordChangeIndicator:   Cardholder Account Password Change Indicator. Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset. Possible values are: 01 No change 02 Changed during this transaction 03 Less than 30 days 04 30-60 days 05 More than 60 days An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountProvisioningAttempts:   Number of account provisioning attempts in the last day. Number of Add Card attempts for the account in the last 24 hours. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountPurchaseCount:   Cardholder Account Purchase Count. Number of purchases with this cardholder account during the previous six months. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

AccountYearTransactions:   Number of account transactions in the last year. Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

ACSChallengeMandatedIndicator:   ACS Challenge Mandated Indicator. Indication of whether a challenge is required for the transaction to be authorized due to local/regional mandates or other variable. Required in ARes messages if TransactionStatus = C.

ACSOperatorId:   ACS identifier assigned by DS. Each DS can provide a unique ID to each ACS on an individual basis. Requirements for the presence of this field in ARes messages are DS specific. Any individual DS may impose special formatting and character requirements on the contents of this field.

ACSReferenceNumber:   Unique ACS Reference Number. Returned from the directory server in the Authentication Response Message (ARes), this field contains a unique identifier for the ACS. Used by the DS to identify the ACS and passed along to the Server in the ARes. This field will be set after a successful call to SendAuthRequest.

ACSRenderingDeviceUserInterfaceMode:   User interface mode the ACS will present to cardholder. Indicates the user interface mode the ACS will present to the cardholder for a challenge. Possible values are: 01 Portrait 02 Landscape 03 Voice 04 Other

ACSRenderingInterface:   Challenge interface type presented to cardholder. This setting specifies the ACS interface that must be used to present the challenge to the cardholder in an app-based flow. This setting is populated after calling SendAuthRequest in the 3DS Server. This is also populated after calling CheckResponse and passing the Results Request Message. Possible values are: 01 Native UI 02 HTML UI

ACSRenderingUITemplate:   Challenge type presented to cardholder. This setting holds the type of challenge that will be presented to the cardholder in an app-based flow. This setting is populated after calling SendAuthRequest in the 3DS Server. This is also populated after calling CheckResponse and passing the Results Request Message. Possible values are: 01 Text 02 Single Select 03 Multi Select 04 OOB 05 HTML Other (valid only for HTML UI) 06 HTML OOB (valid only for 2.3.1) 07 Information (valid only for 2.3.1)

ACSSignedContent:   String value of the JWS object of the ARes message created by the ACS. Contains the JWS object created by the ACS for the ARes message. The JWS object body contains the ACSURL, the ACS Ephemeral Public Key, and the SDK Ephemeral Public Key (available in the SDKEphemeralPublicKey configuration setting). This setting is only applicable to the app-based flow and is informational. It does not need to be queried or set in most cases.

ACSTransactionId:   Unique transaction identifier assigned by the ACS. This field contains a universally unique transaction identifier assigned by the ACS to identify a single transaction.

AddressMatch:   Address Match Indicator. This field is used to indicate to the ACS whether the cardholder shipping address and billing address are the same. Y Shipping address matches billing address. N Shipping address does not match billing address.

AllowNullMethodURL:   Allow null MethodURL when retrieving card ranges. According to the EMVCo specification, if no MethodURL is available, the field should be omitted from the card ranges response. In some cases, however, the directory server has returned a "null" string instead. This is false by default, and this invalid data will result in an error raised by the RequestCardRanges method. Setting this configuration setting to true will allow a null MethodURL in the card range data.

AppIP:   App IP Address. External IP address (i.e., the device public IP address) used by the 3DS Requestor App when it connects to the 3DS Requestor environment.

AppURLIndicator:   3DS Requestor App URL Indicator. Indicates whether the OOB Authentication App used by the ACS during a challenge supports the 3DS Requestor App URL. This is returned by the ACS in the authentication response (ARes) packet. Possible values are: Y 3DS Requestor App URL is supported by the OOB Authentication App N 3DS Requestor App URL is NOT supported by the OOB Authentication App

AuthenticationInformation:   3DS Requestor Prior Transaction Authentication Information. Information about how th 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction. This is specified as a JSON array of objects containing the following fields: threeDSReqPriorAuthDsTransId The prior DS Transaction ID threeDSReqPriorAuthData Data that documents and supports a specific authentication process threeDSReqPriorAuthMethod Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor threeDSReqPriorAuthTimestamp Data and time converted into UTC of the prior Cardholder authentication threeDSReqPriorAuthRef Additional information

AuthenticationMethod:   A comma separated list of authentication types used by the issuer. After SendAuthRequest, this will be set if the TransactionStatus is C or D and indicates the authentication type(s) the issuer will use to challenge the cardholder. When a Results Reuqest Message (RReq) is parse,d this will be set if the TransactionStatus is Y or N and indicates the authentication method(s) that were used during the challenge. Possible values include: 01 Static Passcode 02 SMS OTP 03 Key fob or EMV card reader OTP 04 App OTP 05 OTP Other 06 KBA 07 OOB Biometrics 08 OOB Login 09 OOB Other 10 Other 11 Push Confirmation 12 Decoupled 13 WebAuthn 14 SPC 15 Behavioral biometrics 16-79 Reserved for future EMVCo use 80-99 Reserved for DS use For 3RI, only present for Decoupled Authentication.

AuthenticationType:   Type of authentication method used by the issuer. After SendAuthRequest, this will be set if TransactionStatus is C or D and indicates the type of authentication method that will be used to challenge the cardholder. When a Results Request Message (RReq) is parsed, this will be set if the TransactionStatus is Y or N and indicates the authentication method that was used during the challenge. Possible values include: 01 Static 02 Dynamic 03 OOB 04 Decoupled

BroadInfo:   Broadcast Information. Structured information sent between the 3DS server, the DS, and the ACS.

BroadInfoCategory:   Broadcast Information Category. Indicates the category/type of information. Possible values are: 01 General 02 Certificate expiry 03 Fraud alert 04 Operational alert 05 Transactional data 06 Other 07-79 Reserved for EMVCo future use 80-99 Reserved for DS use

BroadInfoDescription:   Broadcast Information Description. Information to be broadcasted to recipients.

BroadInfoExpiryDate:   Broadcast Information Expiry Date. The date after which the relevance of the broadcasted information (e.g., certificate expiration dates) expires, in YYYYMMDD format.

BroadInfoRecipients:   Broadcast Information Recipient(s). Indicates the intended recipient(s) of the broadcasted information. Multiple recipients can be configured by OR-ing one or more of the following values: 1 3DS SDK 2 3DS Server 4 DS 8 ACS

BroadInfoSeverity:   Broadcast Information Severity. Indicates the importance/severity level of the broadcasted information. Possible values are: 01 Critical 02 Major 03 Minor 04 Informational

BroadInfoSource:   Broadcast Information Source. Indicates the source of the broadcasted information. Possible values are: 01 3DS Server 02 DS 03 ACS

BrowserUserDeviceId:   Browser User Device ID. Unique and immutable identifier linked to a device that is consistent across 3DS transactions for the specific user device. Examples include a Hardware Device ID or a Platform-calculated device fingerprint.

BrowserUserId:   Browser User ID. Identifier of the transacting user's Browser Account ID. This identifier is a unique and immutable hash of the user's account identifier for the given Browser provided as a string.

CardholderInformation:   Information text presented to Cardholder during the transaction. Text provided in ARes by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction. The Issuer can provide information to Cardholder. If populated, this information is required to be conveyed to the cardholder. Required if DecoupledConfirmationIndicator is Y.

CardRangeRecordsReadOrder:   Indicates the order in which to process the card range records from the PRes message. Possible values are: 01 Direct order/FIFO (First In First Out) 02 Reverse order/LIFO (Last In First Out) When UseJsonDOM is false, the cardrange in CardRangeData is in the sequence of received data. If the value of this field is 02, indicating a Last In First Out approach, it would be necessary to cache the cardranges first and then reverse the order of which they are processed. This config may not be available (empty value) in the CardRangeData. This config will always be empty when UseJsonDOM is true.

CardRangeTempPath:   Temporary path where card range data is written. When RequestCardRanges is called, this configuration setting can be used to specify the path to which the component will temporarily save the card range data. This data is saved in a file that is deleted when parsing of the ranges is complete. This can be useful in limiting memory usage of the component, especially when large amounts of ranges are returned. For the most benefit, this should be used in conjunction with StoreCardRangeData set to False.

CardSecurityCode:   Card Security Code. Three or four digit security code printed on the card.

CardSecurityCodeStatus:   Card Security Code Status. Enables the communication of Card Security Code Status between the ACS, the DS, and the 3DS Requestor. Possible values are: Y Validated N Failed validation U Status unknown, unavailable, or does not apply

CardSecurityCodeStatusSource:   Card Security Code Status Source. Possible values are: 01 DS 02 ACS 03-79 Reserved for EMVCo future use 80-99 Reserved for DS use

ChallengeCancellationIndicator:   Challenge Cancellation Indicator. Indicator informing the ACS and the DS that the authentication has been canceled. Required in CReq for app-based if the authentication transaction was canceled for any of the reasons available as values. Required in the RReq if the ACS identifies that the authentication transaction was canceled for reasons indicated. Possible values are: 01 Cardholder selected "Cancel" by interaction with the cancellation button in the UI 02 3DS Requestor canceled Authentication 03 Transaction Abandoned 04 Transaction Timed out at ACS - other timeouts 05 Transaction Timed out at ACS - First CReq not received by ACS 06 Transaction Error 07 Unknown 08-79 Reserved for future EMV/Co use (values invalid until defined by EMVCo) 80-99 Reserved for future DS use

ChallengeErrorReportingACSTransID:   Challenge Error Reporting ACS Transaction ID. The ACS Transaction ID field from the error message (Erro) reported during the challenge process. When an error is encountered during the CReq/CRes process, a copy of the error message (Erro) may be included in the RReq sent to the server. This is required when the ChallengeCancellationIndicator is 09 or 10. The following configuration settings will be populated with data from this error message: ChallengeErrorReportingACSTransID ChallengeErrorReportingDSTransID ChallengeErrorReportingErrorCode ChallengeErrorReportingErrorComponent ChallengeErrorReportingErrorDescription ChallengeErrorReportingErrorDetail ChallengeErrorReportingErrorMessageType ChallengeErrorReportingMessageType ChallengeErrorReportingMessageVersion ChallengeErrorReportingSDKTransID ChallengeErrorReportingThreeDSServerTransID

ChallengeErrorReportingDSTransID:   Challenge Error Reporting DS Transaction ID. The Directory Server Transaction ID field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingErrorCode:   Challenge Error Reporting Error Code. The Error Code field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingErrorComponent:   Challenge Error Reporting Error Component. The Error Component field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingErrorDescription:   Challenge Error Reporting Error Description. The Error Description field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingErrorDetail:   Challenge Error Reporting Error Detail. The Error Detail field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingErrorMessageType:   Challenge Error Reporting Error Message Type. The Error Message Type field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingMessageType:   Challenge Error Reporting Message Type. The Message Type field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingMessageVersion:   Challenge Error Reporting Message Version. The Message Version field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingSDKTransID:   Challenge Error Reporting SDK Transaction ID. The SDK Transaction ID field from the error message (Erro) reported during the challenge process.

ChallengeErrorReportingThreeDSServerTransID:   Challenge Error Reporting Server Transaction ID. The 3DS Server Transaction ID field from the error message (Erro) reported during the challenge process.

ChallengeTimeRemaining:   Amount of time left to complete challenge. This field contains the time remaining to complete the challenge. This is based on the SDKMaxTimeout set when issuing the initial Authorization Request Message.

ClearCustomRequestFields:   Clear the custom request fields internal collection. When PersistCustomRequestFields is true, the component will store request fields specified via the AddRequestField method to use for future generated requests. This configuration setting can be used to clear this internal collection.

ContinueParsingCardRangesOnError:   Whether or not to continue parsing card ranges when a validation error is encountered. When RequestCardRanges is called, the control will parse the card ranges returned in the PRes response packet. By default, if an error is encountered, the component will stop parsing, send an Erro packet to the Directory Server, and throw an exception. This setting can be used to instruct the component to continue parsing the card ranges, and adding the ranges that do not fail validation to the CardRanges collection prior to raising the error. The default value is False.

DecoupledConfirmationIndicator:   ACS Decoupled Confirmation Indicator. Returned in the authentication response, and indicates whether the ACS confirms utilization of Decoupled Authentication and agrees to utilize Decoupled Authentication to authenticate the Cardholder. Possible values are: Y Confirms decoupled authentication will be utilized. N Decoupled authentication will not be utilized. Note that if the 3DS Requestor decoupled request indicator = N, a value of Y cannot be returned. If the TransactionStatus is D, a value of N is not valid.

DecoupledMaxTimeout:   3DS Requestor Decoupled Max Time. Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS to provide the results of a Decoupled Authentication transaction (in minutes). Set prior to calling SendAuthRequest if allowing decoupled authentication.

DecoupledRequestIndicator:   3DS Requestor Decoupled Request Indicator. Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use. Possible values are: Y Decoupled authentication is supported and preferred if challenge is necessary. N Do not use decoupled authentication. Note that if the element is not provided (default), the ACS would interpret this equivalent to a value of N.

DecoupledTimeRemaining:   Time remaining before a RReq should be received during a decoupled authentication. When performing decoupled authentication, the 3DS Server will wait DecoupledMaxTimeout seconds for a Results Request (RReq) packet from the Directory Server indicating the results of the authentication. Generally, the ACS should send the RReq before the specified max time expires, even if authentication has not succeeded. If not successful, this would be indicated in the RReq. This config can be used to help track the time remaining before this RReq should be received, and is based on DecoupledMaxTimeout + 30 seconds.

DeliveryEmailAddress:   Merchandise Delivery Email Address. The email address to which the merchandise was delivered for Electronic delivery. An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. The data elements making up the Indicator will be formatted into a JSON object prior to being placed into the Device Merchant Risk Indicator field of the message. The Indicator is the Merchant's assessment of the level of fraud risk for the specific authentication for both the cardholder and the authentication being conducted. The complete list of elements (all available as config settings) comprising the Merchant Risk Indicator is: DeliveryEmailAddress DeliveryTimeframe GiftCardAmount GiftCardCount GiftCardCurrency PreOrderDate PreOrderPurchaseIndicator ReorderItemsIndicator ShipIndicator

DeliveryTimeframe:   Merchandise Delivery Timeframe. Indicates the merchandise delivery timeframe. Possible values are: 01 Electronic Delivery 02 Same day shipping 03 Overnight shipping 04 Two-day or more shipping An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

DeviceBindingStatus:   Device Binding Status. Enables the communication of Device Binding Status between the ACS, DS, and the 3DS Requestor. For bound devices (value = 11-14), this convest the type of binding that was performed. 01 Device is not bound by Cardholder 02 Not eligible as determined by issuer 03 Pending confirmation by Cardholder 04 Cardholder rejected 05 Device Binding Status unknown, unavailable, or does not apply 06-10 Reserved for EMVCo future use 11 Device is bound by Cardholder (device is bound using hardware/SIM internal to the consumer device. For instance, keys stored in a secure element on the device) 12 Device is bound by Cardholder (device is bound using hardware external to the consumers device. For example, an external FIDO authenticator) 13 Device is bound by Cardholder (device is bound using data that includes dynamically generated data and could include a unique device ID) 14 Device is bound by Cardholder (device is bound using static device data that has been obtained from the consumer's device) 15 Device is bound by Cardholder (other method) 16-79 Reserved for EMVCo future use 80-99 Reserved for DS use

DeviceBindingStatusSource:   Device Binding Status Source. Populated by the system setting Device Binding Status. Possible values are: 01 3DS Server 02 DS 03 ACS 04-79 Reserved for EMVCo future use 80-99 Reserverd for DS use

DeviceInfoRecognisedVersion:   Device Information Recognized Version. Indicates the highest Data Version of the Device Information supported by the ACS.

DSEndProtocolVersion:   DS End Protocol Version. The most recent active protocol version that is supported for the directory server. This is the default value included in the PRes packet returned from the server during a call to RequestCardRanges. If the DSEndProtocolVersion is not specified (i.e. empty) at the CardRanges level, this should be utilized.

DSReferenceNumber:   DS Reference Number. EMVCo-assigned unique identifier to track approved DS. The DS will populate the AReq with this element prior to passing to the ACS, and it will be returned in the ARes.

DSStartProtocolVersion:   DS Start Protocol Version. The earliest (i.e. oldest) active protocol version that is supported for the directory server. This is the default value included in the PRes packet returned from the server during a call to RequestCardRanges. If the DSStartProtocolVersion is not specified (i.e. empty) at the CardRanges level, this should be utilized.

DSTransactionId:   Directory server transaction ID. Universally unique transaction identifier assigned by the directory server to identify a single transaction.

EMVPaymentTokenIndicator:   EMV Payment Token Indicator. A value of true indicates that the transaction was de-tokenised prior to being received by the ACS. This data element will be populated by the system residing in the 3-D Secure domain where the de-tokenization occurs (i.e., the 3DS Server or the DS). The Boolean value of true is the only valid response for this field when it is present. Required in CReq if there is a de-tokenization of an Account Number.

EMVPaymentTokenSource:   EMV Payment Token Source. Indicates where the payment token was detokenized. Valid values are: 01 3DS Server 02 DS This is required to be set if EMVPaymentTokenIndicator is true.

EnableDownloadCardRangeDataFile:   Card Range Data Download Indicator. Indicates if the 3DS Server supports Card Range Data from a file. This can be set to Yprior to calling RequestCardRanges to indicate that downloading a card range data file is supported. If the DS supports this functinoality, the response packet (PRes) will include a URL from which the card range data maybe downloaded. The component will automatically download the data from this location and process the card ranges. Available when ProtocolVersion is 2.3.1 only.

EncodedSessionData:   Encoded session data that is sent in the challenge request and returned in the challenge response. This setting holds the encoded version of SessionData after GetChallengeRequest is called. This may be set in the threeDSSessionData form variable in the post made in the challenge window. When the ACS POSTs the final challenge response to the NotificationURL this setting may be set to the threeDSSessionData form variable value, and SessionData setting may then be queried to return the decoded session data.

ErrorCode:   Code from the last error message. Code indicating the type of problem identified in the error message.

ErrorDescription:   Description from the last error message. Text describing the problem identified in the error message.

ErrorDetail:   Additional details from the last error message. Additional detail regarding the problem identified in the error message.

ExtractRReqServerTransactionId:   Extacts the ServerTransactionId from the RReq packet. This setting can be used to extract the ServerTransactionId from the RReq packet. This field can then be used to look up details on the transaction prior to parsing the RReq packet using the CheckResponse method. Set this to the received RReq packet data and the ServerTransactionId will be returned from the Config method.

GiftCardAmount:   Total gift card(s) amount. For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123). An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

GiftCardCount:   Total number of gift cards purchased. For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

GiftCardCurrency:   Gift Card Currency. For prepaid or gift card purchase, the currency code of the card. An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

IncomingExtensionCount:   The number of extensions received from the directory server. This setting holds the number of extensions received in the last message from the directory server. The individual extension data can be accessed via the IncomingExtensionId, $rcfgIncomingExtensionName;, IncomingExtensionCritical, and IncomingExtensionData settings.

IncomingExtensionCritical[Index]:   Whether the extension is critical. This setting specifies whether the recipient must understand the contents of the extension to interpret the entire message.

IncomingExtensionData[Index]:   The extension data as JSON. This setting specifies the JSON formatted extension data.

IncomingExtensionId[Index]:   The id of the specified extension. This setting specifies a unique identifier for the extension.

IncomingExtensionName[Index]:   The extension name. This setting specifies the name of the extension as defined by the extension owner.

IncomingRawExtensions:   The full JSON formatted extension data received from the directory server. This setting holds the full JSON formatted extension data that was received in the last message from the directory server. This corresponds to the value for the messageExtension JSON object defined in the specification.

InstalmentPaymentData:   Max authorizations permitted for installment payments. Indicates maximum number of authorizations permitted for installment payments. Required in AReq messages if the Merchant and Cardholder have agree to installment payments (AuthenticationIndicator = 03). Value must be greater than 1.

InteractionCounter:   Interaction Counter. Indicates the number of authentication cycles attempted by the cardholder. Value to be tracked by the ACS and present in the Results Response Message (RRes).

LogLevel:   Level of logging enabled. This config specifies the level of logging enabled in the component. Possible values include: 0 (None) No events are logged. 1 (Info - default) Informational events are logged. 2 (Verbose) Detailed data is logged. 3 (Debug) Debug data is logged. This is set to 1 (Info) by default.

MaskSensitive:   Whether to mask sensitive data in the Log event. This setting controls whether sensitive data is masked in the Log event. When set to True (default) the CardNumber value will be replaced with the value *************. Note: DataPacketOut will always contain the raw unmasked value regardless of this setting. This setting only applies to the Log event. The default value is True.

MessageType:   Type of message that is passed. This field identifies the type of the message being transmitted. Possible values include: AReq Authentication Request Message ARes Authentication Response Message CReq Challenge Request Message CRes Challenge Response Message PReq Preparation Request Message PRes Preparation Response Message RReq Results Request Message RRes Results Response Message Erro Error Message This setting is read-only.

MethodCompletionIndicator:   3DS Method Completion Indicator. Indicates whether the 3DS Method was successfully completed or not. This is included in the Authorization Request Message (AReq) sent by the SendAuthRequest method. Possible values are: Y (default) Successfully completed. N Did not successfully complete. U Unavailable. 3DS Method URL was not present in the PRes message data for the card range associated with the Cardholder Account Number.

MultiTransactionAcquirerMerchantID:   Acquirer Merchant ID. Acquirer-assigned Merchant Listed Identifier. Represented in ISO 8583-1 formatting requirements.

MultiTransactionAVNumberUse:   AV Number Use. Number of times that the AV (Authentication Value) is valid.

MultiTransactionAVValidityTime:   AV Validity Time. Number of days that the AV (Authentication Value) is valid.

MultiTransactionCount:   The total number of additional transactions specified. The MultiTransaction configuration settings can be used to specify additional transaction information in case of multiple transactions or merchants. MultiTransactionCount indicates the number of additional transactions specified. Details on these transactions can be set using the following indexed configuration settings: MultiTransactionAcquirerMerchantID MultiTransactionAVNumberUse MultiTransactionAVValidityTime MultiTransactionMerchantAmount MultiTransactionMerchantCurrencyCode MultiTransactionMerchantCurrencyExponent MultiTransactionMerchantName MultiTransactionSellerID

MultiTransactionMerchantAmount:   Merchant Amount. Purchase amount for the merchant in minor units of currency with all punctuation removed.

MultiTransactionMerchantCurrencyCode:   Merchant Currency Code. Currency Code in which purchase Merchant Amount is expressed.

MultiTransactionMerchantCurrencyExponent:   Merchant Currency Exponent. Minor units of Merchant Currency as specified in the ISO 4217 currency exponent.

MultiTransactionMerchantName:   Merchant Name. Name of the listed merchant.

MultiTransactionSellerID:   Seller ID. Merchant-assigned Seller Identifier that links additinal Seller Information outlined in the SellerInfo config.

OutgoingRawExtensions:   The full JSON formatted extension data sent to the directory server. This setting holds the full JSON formatted extension data that will be included in the next outgoing packet. This corresponds to the value for the messageExtension JSON object defined in the specification. Note: When sending extension data it is generally recommended to use Extensions instead of this setting.

PaymentAccountAge:   Payment Account Age. Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. Accepted date format is YYYYMMDD. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

PaymentAccountAgeIndicator:   Payment Account Age Indicator. Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor. Possible values are: 01 No account (guest check-out) 02 Created during this transaction 03 Less than 30 days 04 30-60 days 05 More than 60 days An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

PaymentToken:   EMV Payment Token. Payment token used to initiate the EMV 3DS transaction.

PaymentTokenAdditionalData:   EMV Payment Token Additional Data. Additional information about the Payment Token from the Token Service Provider.

PaymentTokenCryptogram:   EMV Payment Token Cryptogram. A cryptogram, containing a transaction-unique value, typically generated using the Payment Token, Payment Token related data, and transaction data. Cryptogram derivation methods may vary by scenario and may be Payment System-specific.

PaymentTokenStatusIndicator:   EMV Payment Token Status Indicator. Identifies the current status of the Payment token.

PersistCustomRequestFields:   Whether or not to store custom request fields for subsequent requests. By default, fields added using the AddRequestField method are used once in the next generated requests and disposed of. When this configuration setting is set to true (false by default), the component will store these fields for use in subsequent requests. The ClearCustomRequestFields can then be used to clear the internal collection.

PreOrderDate:   Expected date pre-ordered purchase will be available. For a pre-ordered purchase, the expected date that the merchandise will be available. Accepted date format is YYYYMMDD. An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

PreOrderPurchaseIndicator:   Pre-Order Purchase Indicator. Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. Possible values are: 01 Merchandise available 02 Future availability An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

ProtocolVersion:   Protocol version identifier. This field indicates the protocol version. This should be the protocol version number of the specification utilized by the system creating this message. Possible values are: 2.1.0 (Default) 2.2.0 2.3.1

RecurringAmount:   Recurring Amount. Recurring amount in minor units of currency with all punctuation removed.

RecurringAmountIndicator:   Recurring Amount Indicator. Indicates whether the recurring or installment payment has a fixed or variable amount. Possible values are: 01 Fixed Purchase Amount 02 Variable Purchase Amount 03-79 Reserved for EMVCo future use 80-99 Reserved for DS use

RecurringCurrency:   Recurring Currency. Currency in which the RecurringAmount is expressed.

RecurringDate:   Recurring Date. Effective date of the new authorized amount following the first/promotional payment in a recurring or installment transaction.

RecurringExponent:   Recurring Currency Exponent. Minor units of currency as specified in the ISO 4217 currency exponent.

RecurringFrequencyIndicator:   Recurring Frequency Indicator. Indicates whether the recurring or installment payment has a fixed or variable frequency. 01 Fixed Frequency 02 Variable or Unknown Frequency 03-79 Reserved for EMVCo future use 80-99 Reserved for DS use

ReorderItemsIndicator:   Reorder Items Indicator. Indicates whether the cardholder is reordering previously purchased merchandise. Possible values are: 01 First time ordered 02 Reordered An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

ReportCardRangeError:   Report a Card Range Error to the DS. This configuration setting can be used to actively report a card range error to the directory server. When set, the component will send an appropriate error packet (Erro) to the DirectoryServerURL. When ProtocolVersion is 2.3.1, a reason can be provided. Possible values are: 1 Overlap in the card ranges provided by the DS in the PRes message. 2 Action is not possible for the card range. When ProtocolVersion is not 2.3.1, this can be set to any integer value and a generic card range error will be transmitted.

ReqAuthCount:   Count of 3DS Requestor Authentication Data. The ReqAuth configuration settings can be used to specify information about how the 3DS Requestor authenticated the Cardholder before or during the transaction. ReqAuthCount indicates the number of pieces of 3DS Requestor Authentication Information are specified, details of which can be set using the following indexed configuration settings: ReqAuthData ReqAuthMethod ReqAuthTimestamp

ReqAuthData:   3DS Requestor Authentication Data. Data that documents and supports a specific authentication process. In the current version of the specification, this data element is not defined in detail, however the intention is that for each 3DS Requestor Authentication Method, this field carry data that the ACS can use to verify the authentication process. Part of the 3DS Requestor Authentication Information which contains optional information about how the cardholder authenticated during login to their 3DS Requestor account.

ReqAuthMethod:   3DS Requestor Authentication Method. Method used by the Cardholder to authenticate to the 3DS Requestor. Part of the 3DS Requestor Authentication Information which contains optional information about how the cardholder authenticated during login to their 3DS Requestor account. Possible values are: 01 No 3DS Requestor authentication occurred (i.e. cardholder "logged in" as guest) 02 Login to the cardholder account at the 3DS Requestor system using 3DS Requestor's own credentials 03 Login to the cardholder account at the 3DS Requestor system using federated ID 04 Login to the cardholder account at the 3DS Requestor system using issuer credentials 05 Login to the cardholder account at the 3DS Requestor system using third-party authentication 06 Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator 07 Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator (FIDO Assertion or Attestation data signed) 08 SRC Assurance Data 09 SPC Authentication 10-79 Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 Reserved for future DS use

ReqAuthTimestamp:   3DS Requestor Authentication Timestamp. Date and time in UTC of the cardholder authentication. Accepted date format is YYYYMMDDHHMM. Part of the 3DS Requestor Authentication Information which contains optional information about how the cardholder authenticated during login to their 3DS Requestor account.

RequestorChallengeInd:   3DS Requestor Challenge Indicator. Indicates whether a challenge is requested for this transaction. For example: For MessageCategory 01 (PA), a 3DS Requestor may have concerns about the transaction, and request a challenge. For 02 (NPA), a challenge may be necessary when adding a new card to a wallet. Allows 3DS Requestor to request a challenge such as to follow local/regional mandates or other variables. Possible values are: 01 No preference 02 No challenge requested 03 Challenge requested: 3DS Requestor Preference 04 Challenge requested: Mandate 05 No challenge requested (transactional risk analysis is already performed). Valid for ProtocolVersion 2.2.0 and 2.3.1 only 06 No challenge requested (data share only). Valid for ProtocolVersion 2.2.0 and 2.3.1 only 07 No challenge requested (strong consumer authentication is already performed). Valid for ProtocolVersion 2.2.0 and 2.3.1 only 08 No challenge requested (utilize Trust List exemption if no challenge required). Valid for ProtocolVersion 2.2.0 and 2.3.1 only 09 Challenge requested (Trust List prompt requested if challenge required). Valid for ProtocolVersion 2.2.0 and 2.3.1 only 10 No challenge requested (utilize low value exemption). Valid for ProtocolVersion 2.3.1 only 11 No challenge requested (Secure corporate payment exemption). Valid for ProtocolVersion 2.3.1 only 12 Challenge requested (Device Binding prompt requested if challegnge required). Valid for ProtocolVersion 2.3.1 only 13 Challenge requested (Issuer requested). Valid for ProtocolVersion 2.3.1 only 14 Challenge requested (Merchant initiated transactions). Valid for ProtocolVersion 2.3.1 only 15-79 Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 Reserved for DS use If not provided, the ACS action would be identical to 01 (no preference).

ResendRequestCardRanges:   Whether or not to resend the card ranges request. If an error is identified with the card range data received from the directory server when calling the RequestCardRanges method, this configuration setting will be true, indicating that the request should be resent. When resending, if SerialNumber was specified for the initial request, it should be set to an empty string before calling RequestCardRanges again. Otherwise, the request can be sent without the serial number again, but the server may respond with an error due to multiple requests within an hour.

SDKMaxTimeout:   SDK Maximum Timeout. Indicates the maximum amount of time (in minutes) for all exchanges. Included in the Authorization Request Message (AReq) sent to the directory server via the SendAuthRequest method. A value of 5 minutes is used by default. SDK Maximum Timeout. Indicates the maximum amount of time (in minutes) for all exchanges. Included in the Authorization Request Message (AReq) sent to the directory server via the SendAuthRequest method. A value of 5 minutes is used by default.

SDKMaxTimeout:   SDK Maximum Timeout. Indicates the maximum amount of time (in minutes) for all exchanges. Included in the Authorization Request Message (AReq) sent to the directory server via the SendAuthRequest method. A value of 5 minutes is used by default. SDK Maximum Timeout. Indicates the maximum amount of time (in minutes) for all exchanges. Included in the Authorization Request Message (AReq) sent to the directory server via the SendAuthRequest method. A value of 5 minutes is used by default.

SDKServerSignedContent:   SDK Server Signed Content. Contains the JWS object (represented as a string) created by the Split-SDK Server for the AReq message.

SDKWrapped:   Default-SDK Wrapped Indicator. Set to Y to indicate if the Default-SDK is embedded as a wrapped component in the 3DS Requestor App.

SellerInfo:   Seller Information. Contains details of each seller involved in the transaction. This is specified as a JSON array of objects containing the following fields: sellerName Name of the Seller sellerId Merchant-assigned Seller identifier sellerBusinessName Business Name of the Seller sellerAccDate Date converted into UTC that the Seller started using the Merchant's services. sellerAddrLine1 First line of the business or contact street address of the Seller seerAddrLine2 Second line of the business or contact street address of the Seller sellerAddrLine3 Third line of the business or contact street address of the Seller sellerAddrCity Business or contact city of the Seller sellerAddrState Business or contact state or province of the Seller sellerAddrPostCode Business or contact ZIP or other postal code of the seller sellerAddrCountry Business or contact country of the Seller sellerEmail Business or contact email address of the Seller sellerPhone Business or contact phone number of the Seller

ServerOperatorId:   3DS Server identifier. Directory server assigned 3DS Server identifier. This may be assigned by a directory server. If this is assigned it should be set here.

SessionData:   Session data that is sent in the challenge request and returned in the challenge response. This setting specifies session information that may be used to associate the notification of challenge completion with the original transaction. This may be set before calling GetChallengeRequest. When the ACS POSTs the final challenge response to the NotificationURL the EncodedSessionData may be set to the threeDSSessionData form variable value, and this setting may then be queried to return the decoded session data.

ShipAddressUsageDate:   Shipping address first usage date. Date when the shipping address used for this transaction was first used with the 3DS Requestor. Accepted date format is YYYYMMDD. An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

ShipAddressUsageIndicator:   Shipping address usage indicator. Indicates the length of time since the shipping address used for this transaction was first used with the 3DS Requestor. Possible values are: 01 This transaction 02 Less than 30 days 03 30-60 days 04 More than 60 days An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

ShipIndicator:   Shipping method indicator. Indicates shipping method chosen for the transaction. Merchants must choose the Shipping Indicator code that most accurately describes the cardholder's specific transaction, not their general business. If one or more items are included in the sale, the Shipping Indicator code for the physical goods is used, or if all digital goods, the Shipping Indicator code that describes the most expensive item. Possible values are: 01 Ship to cardholder's billing address 02 Ship to another verified address on file with merchant 03 Ship to address that is different than the cardholder's billing address 04 "Ship to Store" / Pick-up at local store (Store address shall be populated in shipping address fields) 05 Digital goods (includes online services, electronic gift cards and redemption codes) 06 Travel and Event tickets, not shipped 07 Other (for example, Gaming, digital services not shipped, emedia subscriptions, etc.) 08 Pick-up and go delivery 09 Locker delivery (or other automated pick-up) An element of the Merchant Risk Indicator applicable in AReq messages, which is optional but strongly recommended to include. See the DeliveryEmailAddress configuration setting for the complete list of elements (all available as config settings) comprising the Merchant Risk Indicator.

ShipNameIndicator:   Shipping Name Indicator. Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Possible values are: 01 Account Name identical to shipping Name 02 Account Name different than shipping Name An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

SPCIncompletionIndicator:   SPC Incompletion Indicator. Reason that the SPC authentication was not completed. Possible values are: 01 SPC did not run or did not successfully complete 02 Cardholder cancelled the SPC authentication 03 SPC timed out 04-99 Reserved for EMVCo future use

SPCTransactionAdditionalData:   SPC Transaction Additional Data. For SPC API enhancement, to be defined in a future 3DS specification release.

SPCTransactionChallenge:   SPC Transaction Challenge. Random string generated by the ACS to prevent replay attacks.

SPCTransactionChallengeInfoText:   SPC Transaction Challenge Information Text. Text provided by the ACS to be displayed during the SPC authentication.

SPCTransactionCurrency:   SPC Transaction Currency. Transaction amount currency to be displayed during the SPC authentication.

SPCTransactionDisplayName:   SPC Transaction Display Name. Card or product name (Payment Instrument) to be displayed during the SPC authentication.

SPCTransactionExtensionIndicator:   SPC Transaction WebAuthn SPC Extension Indicator. For SPC and WebAuthn API enhancement.

SPCTransactionIcon:   SPC Transaction Icon. Card image (Payment Instrument) URL or Data URL to be displayed during the SPC authentication.

SPCTransactionIssuerImage:   SPC Transaction Issuer Default Image. Default Issuer logo or image URL or Data URL to be displayed during the SPC authentication.

SPCTransactionIssuerImageDark:   SPC Transaction Issuer Dark Mode Image. Dark mode Issuer logo or image URL or Data URL to be displayed during the SPC authentication.

SPCTransactionIssuerImageMonochrome:   SPC Transaction Issuer Monochrome Image. Monochrome Issuer logo or image URL or Data URL to be displayed during the SPC authentication.

SPCTransactionPayeeName:   SPC Transaction Payee Name. The display name of the payee that this SPC call is for (e.g. the merchant). Matches the Merchant Name from the AReq message.

SPCTransactionPayeeOrigin:   SPC Transaction Payee Origin. The origin of the payee that this SPC call is for (e.g. the merchant).

SPCTransactionPSImage:   SPC Transaction Payment System Default Image. Default Default Payment System logo or image URL to be displayed during the SPC authentication.

SPCTransactionPSImageDark:   SPC Transaction Payment System Dark Mode Image. Dark mode Payment System logo or image URL to be displayed during the SPC authentication.

SPCTransactionPSImageMonochrome:   SPC Transaction Payment System Monochrome Image. Monochrome Payment System logo or image URL to be displayed during the SPC authentication.

SPCTransactionTimeout:   SPC Transaction Transaction Timeout. The number of milliseconds before the request to sign the transaction details times out.

SPCTransactionValue:   SPC Transaction Value. Transaction amount as a decimal value to be displayed during the SPC authentication.

SplitSDKLimited:   Limited Split-SDK Indicator. Set to Y to indicate if the Split-SDK client has limited capabilities.

SplitSDKVariant:   Split-SDK Variant. Indicates the implementation characteristics of the Split-SDK client. Possible values are: 01 Native Client 02 Browser 03 Shell

StoreCardRangeData:   Whether or not to store the card ranges in the CardRanges collection. Indicates whether or not the component should store card ranges in the internal CardRanges collection after the RequestCardRanges method completes. When False, the card range data will only be available via the CardRange event. This can be useful in limiting memory usage of the component, especially when large amounts of ranges are returned. The default value is True.

SuspiciousAccountActivity:   Suspicious account activity indicator. Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Possible values are: 01 No suspicious activity has been observed 02 Suspicious activity has been observed An element of the Cardholder Account Information provided by the 3DS Requestor in AReq messages, which is optional but strongly recommended to include. See the AccountAgeIndicator configuration setting for the complete list of elements (all available as config settings) comprising Cardholder Account Information.

TaxId:   Tax ID. Cardholder's tax identification.

ThreeDSMethodId:   3DS Method ID. Contains the 3DS Server Transaction ID used during the previous execution of the 3DS method. Required is the 3DS Requestor reuses previous 3DS Method execution.

ThreeDSRequestorSpcSupport:   3DS Requestor SPC Support. Set to Y to indicate that the 3DS Requestor supports SPC authentication.

ThreeRIIndicator:   3RI Indicator. Indicates the type of 3RI request. This data element provides additional information to the ACS to determine the best approach for handing a 3RI request. Included in the Authorization Request Message (ARes) sent by the SendAuthRequest. Valid when DeviceChannel is set to "03," indicating 3RI. Possible values are: 01 Recurring transaction 02 Installment transaction 03 Add card 04 Maintain card information 05 Account verification 06 Split/delayed shipment 07 Top-up 08 Mail Order 09 Telephone Order 10 Whitelist status check 11 Other payment 12 Billing Agreement 13 Device Binding status check 14 Card Security Code status check 15-79 Reserved for EMVCo future use 80-99 Reserved for DS use Values of 06-11 are only applicable when ProtocolVersion is > 2.2.0. Values of 12-14 are only applicable when ProtocolVersion is 2.3.1.

TransactionChallengeExemption:   Transaction Challenge Exemption. Exemption applied by the ACS to authenticate the transaction without requesting a challenge. 05 Transaction Risk Analysis exemption 08 Trust List exemption 10 Low Value exemption 11 Secure Corporate Payments exemption 79 No exemption applied 01-04, 06, 07, 09, and 12-78 Reserved for EMVCo future use 80-99 Reserved for DS use

TransactionStatusReason:   Reason for value of TransactionStatus. Provides information on why the Transaction Status field has the specified value. For MessageCategory 01 (PA), always included when TransactionStatus = N, U, or R. For MessageCategory 02 (NPA), as defined by the DS. Possible values are: 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 non supported 21 3RI transaction not supported 22 ACS technical issue 23 Decoupled Authentication required by ACS but not requested by 3DS Requestor 24 3DS Requestor Decoupled Max Expiry Time exceeded 25 Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt 26 Authentication attempted but not performed by the cardholder 27 Preferred Authentication Method not supported 28 Validation of content security policy failed 29-79 Reserved for future EMVCo use (values invalid until defined by EMVCo) 80-99 Reserved for DS use

TransactionStatusReasonInfo:   Transaction Status Reason Information. Provides additional information on the TransactionStatusReason.

TransactionType:   Transaction Type. Identifies the type of transaction being authenticated. This field is required in AReq messages in some markets (e.g. for Merchants in Brazil). Otherwise, optional. Possible values (derived from ISO Standard) are: 01 Goods/ Service Purchase 03 Check Acceptance 10 Account Funding 11 Quasi-Cash Transaction 28 Prepaid Activation and Load

TrustListStatus:   Trust List Status. Enables the communication of trust list status between the ACS, the DS and the 3DS Requestor. Y 3DS Requestor is trust listed by cardholder N 3DS Requestor is not trust listed by cardholder E Not eligible as determined by issuer P Pending confirmation by cardholder R Cardholder rejected U Trust list status unknown, unavailable, or does not apply This may be set prior to calling the SendAuthRequest method. In this case, only values of Y or N are valid. This may also be set when the Authentication Response message or Results Request messages are received, and will be set to the values received from the Directory Server.

TrustListStatusSource:   Trust List Status Source. This data element will be populated by the system setting Trust List Status. When setting TrustListStatus prior to calling the SendAuthRequest method, this should be set to 01. Possible values are: 01 3DS Server 02 DS 03 ACS 04-79 Reserved for EMVCo future use 08-99 Reserved for DS use

UseAESGCM:   Whether or not to use AESGCM as the encryption algorithm. By default, the component will use JWS_ENC_ALG_ID_A128CBC_HS256AES when encrypting packets to send to the ACS. Setting this to true will instruct the component to use JWE_ENC_ALG_ID_A128GCM instead.

UseJsonDOM:   Whether or not the component should build an internal DOM when parsing card ranges. When the RequestCardRanges method is called, by default the component will construct an internal DOM (Document Object Model) when parsing the returned data. When set to False, this will instruct the component not to build this model, which can be useful in limiting memory usage of the component, especially when large amounts of ranges are returned. The default value is True. Note that when False, the XPath settings will not be available.

WebAuthnCredentialListCount:   The total number of WebAuthen Credentials. The WebAuthnCredentialList configuration settings can be used to access a list of enrolled FIDO credentials (WebAuthn Credentials) associated with the Cardholder Account Number as returned from the ACS in the ARes packet. WebAuthnCredentialListCount indicates the number of credentials specified. The Relying Party ID and Credential for each can be set using the following indexed configuration settings: WebAuthnCredListRelyingPartyId WebAuthnCredentialListWebAuthnCredential This data is only available when ProtocolVersion is 2.3.1, and only when the TransactionStatus is S.

WebAuthnCredentialListWebAuthnCredential:   WebAuthn Credential List: WebAuthn Credential. WebAuthn Credential.

WebAuthnCredListRelyingPartyId:   WebAuthn Credential List: Relying Party ID. The Relying Party ID for the WebAuthn credential.

WhitelistStatus:   Whitelist Status. Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Y 3DS Requestor is whitelisted by cardholder N 3DS Requestor is not whitelisted by cardholder E Not eligible as determined by issuer P Pending confirmation by cardholder R Cardholder rejected U Whitelist status unknown, unavailable, or does not apply This may be set prior to calling the SendAuthRequest method. In this case, only values of Y or N are valid. This may also be set when the Authentication Response message or Results Request messages are received, and will be set to the values received from the Directory Server.

WhitelistStatusSource:   Whitelist Status Source. The system setting the Whitelist Status. When setting WhitelistStatus prior to calling the SendAuthRequest method, this should be set to 01. Possible values are: 01 3DS Server 02 DS 03 ACS 04-79 Reserved for EMVCo future use 08-99 Reserved for DS use

XChildCount:   The number of child elements of the current element. The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1). The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XChildName[i]:   The name of the child element. Provides the name of the i'th child element of the current element. The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XChildXText[i]:   The inner text of the child element. Provides the inner text of the i'th child element of the current element. The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XElement:   The name of the current element. Provides the name of the current element. The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XParent:   The parent of the current element. Provides the parent of the current element. The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XPath:   Provides a way to point to a specific element in the returned XML or JSON response. The XPath setting allows you to point to specific elements in the XML or JSON response. When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element. XPath Syntax XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string: Accessor Description name The first element with a particular name. Can be *. [i] The i-th element. name[i] The i-th element with a particular name. [last()] The last element. [last()-i] The element i before the last element. name[@attrname="attrvalue"] The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) . The current element. .. The parent element. Note: XPath indices are 1-based. XPath Examples Assuming the following XML response: <firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel> Or, alternatively, the following JSON response: { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } Here are some examples of valid XPaths: Description XML XPath JSON XPath Document root / /json Specific element /firstlevel/one /json/firstlevel/one i-th child /firstlevel/two/item[2] /json/firstlevel/two/[2] This is not an exhaustive list by any means, but should provide a general idea of the possibilities.

XSubTree:   A snapshot of the current element in the document. Provides the entirety of the current element (including its sub-elements). The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XText:   The text of the current element. Provides the inner text of the current element. The current element is specified in the XPath configuration setting. This configuration setting is read-only.

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API. When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes. When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates. This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application. This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL. This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG). This functionality is available only when the provider is OpenSSL. By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused. If set to true, the control will reuse the context if and only if the following criteria are met: The target host name is the same. The system cache entry has not expired (default timeout is 10 hours). The application process that calls the function is the same. The logon session is the same. The instance of the control is the same.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication. This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate. This setting specifies whether the control will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the control will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The control will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the control fails with an error. When set to 0 (default) the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate. This setting specifies whether the control will use OCSP to check the validity of the server certificate. If set to 1 or 2, the control will first obtain the OCSP URL from the server certificate's OCSP extension. The control will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the control fails with an error. When set to 0 (default) the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption. This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation. The enabled cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include: CALG_3DES CALG_3DES_112 CALG_AES CALG_AES_128 CALG_AES_192 CALG_AES_256 CALG_AGREEDKEY_ANY CALG_CYLINK_MEK CALG_DES CALG_DESX CALG_DH_EPHEM CALG_DH_SF CALG_DSS_SIGN CALG_ECDH CALG_ECDH_EPHEM CALG_ECDSA CALG_ECMQV CALG_HASH_REPLACE_OWF CALG_HUGHES_MD5 CALG_HMAC CALG_KEA_KEYX CALG_MAC CALG_MD2 CALG_MD4 CALG_MD5 CALG_NO_SIGN CALG_OID_INFO_CNG_ONLY CALG_OID_INFO_PARAMETERS CALG_PCT1_MASTER CALG_RC2 CALG_RC4 CALG_RC5 CALG_RSA_KEYX CALG_RSA_SIGN CALG_SCHANNEL_ENC_KEY CALG_SCHANNEL_MAC_KEY CALG_SCHANNEL_MASTER_HASH CALG_SEAL CALG_SHA CALG_SHA1 CALG_SHA_256 CALG_SHA_384 CALG_SHA_512 CALG_SKIPJACK CALG_SSL2_MASTER CALG_SSL3_MASTER CALG_SSL3_SHAMD5 CALG_TEK CALG_TLS1_MASTER CALG_TLS1PRF Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA TLS_DHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_RSA_WITH_AES_256_CBC_SHA TLS_DHE_DSS_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_DSS_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_DES_CBC_SHA TLS_DHE_RSA_WITH_DES_CBC_SHA TLS_DHE_DSS_WITH_DES_CBC_SHA TLS_RSA_WITH_RC4_128_MD5 TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols. Used to enable/disable the supported security protocols. Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values: TLS1.3 12288 (Hex 3000) TLS1.2 3072 (Hex C00) (Default) TLS1.1 768 (Hex 300) (Default) TLS1 192 (Hex C0) (Default) SSL3 48 (Hex 30) SSL2 12 (Hex 0C) SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes: The platform provider is only available on Windows 11 / Windows Server 2022 and up. SSLEnabledCipherSuites and other similar SSL configuration settings are not supported. If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported. This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is by default, but can be set to to disable the extension. This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event. This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event. If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes. This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the control will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the control will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength. Returns the strength of the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake represented as a single string. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm. Returns the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength. Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version. Returns the protocol version negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions: 0x00000001 Ignore time validity status of certificate. 0x00000002 Ignore time validity status of CTL. 0x00000004 Ignore non-nested certificate times. 0x00000010 Allow unknown Certificate Authority. 0x00000020 Ignore wrong certificate usage. 0x00000100 Ignore unknown certificate revocation status. 0x00000200 Ignore unknown CTL signer revocation status. 0x00000400 Ignore unknown Certificate Authority revocation status. 0x00000800 Ignore unknown Root revocation status. 0x00008000 Allow test Root certificate. 0x00004000 Trust test Root certificate. 0x80000000 Ignore non-matching CN (certificate CN not-matching server name). This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation. This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2. When specified the control will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the control fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa. In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC. This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC. The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported: "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" "ffdhe_6144" "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms. This setting holds a comma separated list of allowed signature algorithms. Possible values are: "ed25519" (default) "ed448" (default) "ecdsa_secp256r1_sha256" (default) "ecdsa_secp384r1_sha384" (default) "ecdsa_secp521r1_sha512" (default) "rsa_pkcs1_sha256" (default) "rsa_pkcs1_sha384" (default) "rsa_pkcs1_sha512" (default) "rsa_pss_sha256" (default) "rsa_pss_sha384" (default) "rsa_pss_sha512" (default) The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" (default) "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default) "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" (default) "ffdhe_6144" (default) "ffdhe_8192" (default)

Trappable Errors (Server Control)

Server Errors

	20602    Could not create ephemeral key.
	20603    Invalid certificate.
	20604    Invalid operation.
	20605    Invalid ClientAuth data.
	20606    The errorCode element in Erro message is invalid.
	20607    Invalid index.
	21102    Protocol error. Received invalid message.
	21103    Protocol error. Invalid message version.
	21202    Protocol error. Missing data element.
	21203    Protocol error. Unrecognized critical extension.
	21302    Protocol error. Unrecognized transaction Id.
	21303    Decryption failed.

HTTP Errors

	20119    Firewall Error. Error description contains detailed message.
	20144    Busy executing current method.
	20152    HTTP protocol error. The error message has the server response.
	20153    No server specified in URL
	20154    Specified URLScheme is invalid.
	20156    Range operation is not supported by server.
	20157    Invalid cookie index (out of range).
	20302    Interrupted.
	20303    Can't open AttachedFile.

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

	20101    You cannot change the RemotePort at this time. A connection is in progress.
	20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103    The RemoteHost address is invalid (0.0.0.0).
	20105    Already connected. If you want to reconnect, close the current connection first.
	20107    You cannot change the LocalPort at this time. A connection is in progress.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20113    You cannot change MaxLineLength at this time. A connection is in progress.
	20117    RemotePort cannot be zero. Please specify a valid service port number.
	20118    You cannot change the UseConnection option while the control is active.
	20136    Operation would block.
	20202    Timeout.
	20212    Action impossible in control's present state.
	20213    Action impossible while not connected.
	20214    Action impossible while listening.
	20302    Timeout.
	20303    Could not open file.
	20435    Unable to convert string to selected CodePage.
	21106    Already connecting. If you want to reconnect, close the current connection first.
	21118    You need to connect first.
	21120    You cannot change the LocalHost at this time. A connection is in progress.
	21121    Connection dropped by remote host.

SSL Errors

	20271    Cannot load specified security library.
	20272    Cannot open certificate store.
	20273    Cannot find specified certificate.
	20274    Cannot acquire security credentials.
	20275    Cannot find certificate chain.
	20276    Cannot verify certificate chain.
	20277    Error during handshake.
	20281    Error verifying certificate.
	20282    Could not find client certificate.
	20283    Could not find server certificate.
	20284    Error encrypting data.
	20285    Error decrypting data.

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).