Client Class

Properties   Methods   Events   Config Settings   Errors  

The Client class is designed for use on mobile devices and facilitates EMV® 3-D Secure authentication.

Syntax

Client

Remarks

The Client class is a counterpart to the 3DS Server class. It is designed for use on mobile devices and supports operations that facilitate EMV® 3-D Secure authentication in both frictionless and challenge flows.

Preparing the Authentication Request

To begin, device specific information must be collected and prepared for transmission to the directory server. This can be done by calling the AddDeviceParam method. Consult the EMV® 3-D Secure Specifications for more details about applicable device parameters for each particular operating system.

The GetAuthRequest method is used to obtain the request message to be send to the directory server. GetAuthRequest encrypts the device info and prepares all the data necessary to be sent by the 3DS Server class in the SendAuthRequest method.

After calling this method, the returned data must be transmitted via a separate secure channel to the server where 3DS Server is being used.

The following properties are required before calling the method:

Calling this method returns required information used by 3DS Server to send the authentication request. Transmit the value returned by this method to the system where 3DS Server is used. The method used to transmit this value is outside the scope of the class.

See SendAuthRequest for details on sending the authentication request after transmitting the data to the 3DS Server.

Calling this method also populates SDKTransactionId which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as SendChallengeRequest.

Interaction With the 3DS Server Class

As mentioned above, the request to the Directory Server must be made by the 3DS Server class which resides on a server under control of the merchant. A web server is required even for app-based authentication both to send the authentication request and to be notified of authentication results later in the flow.

It is expected that a secure channel can be established between the app using the Client class and the server where the 3DS Server class resides in order to transfer information freely.

Sending the Authentication Request

The act of sending the authentication request takes place with the 3DS Server class.

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)
• MessageVersion (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 class via a secure channel, the specifics of which are outside the scope of the classs. 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 MethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.

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

If a MethodURL 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:

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 classs 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 class 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 True 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
• WebAuthnCredentialListRelyingPartyId
• SPCTransactionAdditionalData
• SPCTransactionChallenge
• SPCTransactionChallengeInfoText
• SPCTransactionCurrency
• SPCTransactionDisplayName
• SPCTransactionIcon
• SPCTransactionIssuerImage
• SPCTransactionIssuerImageDark
• SPCTransactionIssuerImageMonochrome
• SPCTransactionPayeeName
• SPCTransactionPayeeOrigin
• SPCTransactionPSImage
• SPCTransactionPSImageDark
• SPCTransactionPSImageMonochrome
• SPCTransactionTimeout
• SPCTransactionValue

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[Index] and a ReqAuthMethod[Index] 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.

When SPC authentication is to be performed, the authenticaton must be completed within 9 minutes. The component will automatically start an internal timer that can be checked using the CheckSPCTimeout configuration setting. This will return the number of seconds left for SPC authentication to complete. If the time has expired before receiving the Assertion Data from the 3DS Requestor, checking this configuration setting will cause the component to automatically send the second AReq message with an SPCIncompletionIndicator value of 03, indicating that SPC authentication timed out.

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

Processing the Authentication Response

After the response to the authentication request is received from the 3DS Server class, call CheckAuthResponse to verify and parse the response. See the 3DS Server's SendAuthRequest method for details about obtaining the response.

Before calling this method, ACSRootCerts must be populated with the root certificates used by the ACS to sign the response. This method will validate the signature of the signed content if present.

After calling this method, inspect TransactionStatus to determine if the transaction requires a challenge. If TransactionStatus is C, a challenge is required and SendChallengeRequest should be called to proceed with the challenge flow. If TransactionStatus is D, decoupled authentication will take place outside of the 3-D Secure flow and the results will be posted to the 3DS Server.

If TransactionStatus is Y or A, the transaction is complete.

Challenge Interaction

If TransactionStatus is C, a challenge is required. The challenge takes place between the cardholder and the ACS. During this interaction the class will communicate directly with the ACS from the app where it is used to exchange information.

SendChallengeRequest begins the challenge flow. SendChallengeRequest sends the Challenge Request to the ACS when a challenge is required.

When the TransactionStatus is C after calling CheckAuthResponse, a challenge to the cardholder is required. This method sends the challenge request and parses the response. The ACS may provide multiple challenges to the cardholder during this process. As a result this method may need to be called multiple times throughout the authentication process.

After this method is called, check ChallengeComplete to determine if the challenge process is complete. If it is complete (True), check TransactionStatus to determine the outcome. If ChallengeComplete is False, additional challenge interaction is required.

First Request

The first time this method is called, information about the required challenge is obtained from the ACS. The ACS connection information is automatically set when CheckAuthResponse is called; there is no need to specify any ACS connection information.

All required properties for the first call to this method are automatically set after CheckAuthResponse is called. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS.

After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The ACSUIType property indicates the way the ACS will interact with the cardholder. The ChallengeComplete property will be False after the first call to this method since the challenge interaction is not yet complete.

The following properties are applicable when ACSUIType is Text (01), Single-Select (02), or Multi-Select (03):

• ChallengeSelectInfo
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• SubmitAuthenticationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is Out-of-Band (04):

• ChallengeAdditionalInformation
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• OOBContinueLabel
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is HTML (05):

• ACSHTML
• ACSHTMLRefresh

In the case of an HTML interaction, the app should create a webview and populate this with the HTML in ACSHTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

Second Request

The second time this method is called, the purpose is to provide a response to the ACS. At this point the customer should have responded to the challenge provided by the ACS in the response to the first call. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS. The following properties are applicable when calling this method the second time:

• ChallengeDataEntry
• OOBContinuationIndicator

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

When ACSUIType is OOB (04), set OOBContinuationIndicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.

Completing the Challenge

After calling SendChallengeRequest a second time with the cardholder's responses, the ACS may require additional challenges. Check the ChallengeComplete property to determine if the challenge is complete. If False, more challenges are required by the ACS and the same process of displaying the challenge info, collecting the response, and submitting it to the ACS should be performed again.

If ChallengeComplete is True, the challenge interaction is complete and TransactionStatus can be inspected to determine whether the transaction was successful.

Note: As part of the challenge completion the ACS also notifies the 3DS Server of the results. This is done by posting the results to the URL defined by the ResultsURL property of the 3DS Server class.

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"

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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ACSHTML Property (Client Class)

HTML provided by the ACS.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetACSHTML();

Unicode (Windows)
LPWSTR GetACSHTML();

char* ipworks3ds_client_getacshtml(void* lpObj);

QString GetACSHTML();

Default Value

""

Remarks

This field contains HTML provided by the ACS in the Challenge Response Message (CRes). This will be populated when the ACSUIType is HTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

This property is read-only.

Data Type

String

ACSHTMLRefresh Property (Client Class)

ACS HTML refresh.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetACSHTMLRefresh();

Unicode (Windows)
LPWSTR GetACSHTMLRefresh();

char* ipworks3ds_client_getacshtmlrefresh(void* lpObj);

QString GetACSHTMLRefresh();

Default Value

""

Remarks

Optional HTML provided by the ACS in response to SendChallengeRequest when ACSUIType is HTML (05).

If the ACS HTML Refresh is present in the CRes message, the app should display this in the web view when the app is moved to the foreground.

This property is read-only.

Data Type

String

ACSRootCerts Property (Client Class)

A collection of trusted CA certificates.

Syntax

• C++
• C
• Qt

IPWorks3DSList<IPWorks3DSCertificate>* GetACSRootCerts();
int SetACSRootCerts(IPWorks3DSList<IPWorks3DSCertificate>* val);

int ipworks3ds_client_getacsrootcertcount(void* lpObj);
int ipworks3ds_client_setacsrootcertcount(void* lpObj, int iACSRootCertCount);

int ipworks3ds_client_getacsrootcertstore(void* lpObj, int acsrootcertindex, char** lpACSRootCertStore, int* lenACSRootCertStore);
int ipworks3ds_client_setacsrootcertstore(void* lpObj, int acsrootcertindex, const char* lpACSRootCertStore, int lenACSRootCertStore);

char* ipworks3ds_client_getacsrootcertstorepassword(void* lpObj, int acsrootcertindex);
int ipworks3ds_client_setacsrootcertstorepassword(void* lpObj, int acsrootcertindex, const char* lpszACSRootCertStorePassword);

int ipworks3ds_client_getacsrootcertstoretype(void* lpObj, int acsrootcertindex);
int ipworks3ds_client_setacsrootcertstoretype(void* lpObj, int acsrootcertindex, int iACSRootCertStoreType);

char* ipworks3ds_client_getacsrootcertsubject(void* lpObj, int acsrootcertindex);
int ipworks3ds_client_setacsrootcertsubject(void* lpObj, int acsrootcertindex, const char* lpszACSRootCertSubject);

int ipworks3ds_client_getacsrootcertencoded(void* lpObj, int acsrootcertindex, char** lpACSRootCertEncoded, int* lenACSRootCertEncoded);
int ipworks3ds_client_setacsrootcertencoded(void* lpObj, int acsrootcertindex, const char* lpACSRootCertEncoded, int lenACSRootCertEncoded);

int GetACSRootCertCount();
int SetACSRootCertCount(int iACSRootCertCount);

QByteArray GetACSRootCertStore(int iACSRootCertIndex);
int SetACSRootCertStore(int iACSRootCertIndex, QByteArray qbaACSRootCertStore);

QString GetACSRootCertStorePassword(int iACSRootCertIndex);
int SetACSRootCertStorePassword(int iACSRootCertIndex, QString qsACSRootCertStorePassword);

int GetACSRootCertStoreType(int iACSRootCertIndex);
int SetACSRootCertStoreType(int iACSRootCertIndex, int iACSRootCertStoreType);

QString GetACSRootCertSubject(int iACSRootCertIndex);
int SetACSRootCertSubject(int iACSRootCertIndex, QString qsACSRootCertSubject);

QByteArray GetACSRootCertEncoded(int iACSRootCertIndex);
int SetACSRootCertEncoded(int iACSRootCertIndex, QByteArray qbaACSRootCertEncoded);

Remarks

This setting holds a collection of Certificates used to verify data sent by the ACS.

Set this property to one or more Root certificates from the ACS before calling CheckAuthResponse.

This property is not available at design time.

Data Type

IPWorks3DSCertificate

ACSUIType Property (Client Class)

UI type rendered by the 3DS SDK.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetACSUIType();

Unicode (Windows)
INT GetACSUIType();

int ipworks3ds_client_getacsuitype(void* lpObj);

int GetACSUIType();

Default Value

0

Remarks

This field is returned in the Challenge Response Message (CRes) from the ACS and contains the User Interface type that the 3DS SDK will render. 1 = Text 2 = Single Select 3 = Multi Select 4 = OOB 5 = HTML 6 = HTML OOB 7 = Information

This property is read-only.

Data Type

Integer

ChallengeAdditionalInformation Property (Client Class)

Challenge additional information text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeAdditionalInformation();

Unicode (Windows)
LPWSTR GetChallengeAdditionalInformation();

char* ipworks3ds_client_getchallengeadditionalinformation(void* lpObj);

QString GetChallengeAdditionalInformation();

Default Value

""

Remarks

Text provided by the ACS/Issuer to the cardholder during OOB authentication to replace challenge information text and challenge information text indicator in the OOB template.

This property is read-only.

Data Type

String

ChallengeAdditionalLabel Property (Client Class)

Challenge Additional Label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeAdditionalLabel();

Unicode (Windows)
LPWSTR GetChallengeAdditionalLabel();

char* ipworks3ds_client_getchallengeadditionallabel(void* lpObj);

QString GetChallengeAdditionalLabel();

Default Value

""

Remarks

UI label for the additional choice button provided by the ACS.

This property is read-only.

Data Type

String

ChallengeCancellationIndicator Property (Client Class)

Challenge Cancellation Indicator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeCancellationIndicator();
int SetChallengeCancellationIndicator(const char* lpszChallengeCancellationIndicator);

Unicode (Windows)
LPWSTR GetChallengeCancellationIndicator();
INT SetChallengeCancellationIndicator(LPCWSTR lpszChallengeCancellationIndicator);

char* ipworks3ds_client_getchallengecancellationindicator(void* lpObj);
int ipworks3ds_client_setchallengecancellationindicator(void* lpObj, const char* lpszChallengeCancellationIndicator);

QString GetChallengeCancellationIndicator();
int SetChallengeCancellationIndicator(QString qsChallengeCancellationIndicator);

Default Value

""

Remarks

This field is an indicator informing the ACS and the DS that the authentication has been canceled. This is required to be set if the authentication transaction was canceled by the user. This may also be received in the Results Request from the directory server if the ACS identifies that the authentication transaction was canceled for reasons as indicated.

Possible values include:

Data Type

String

ChallengeComplete Property (Client Class)

Whether or not the challenge cycle is complete.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChallengeComplete();

Unicode (Windows)
BOOL GetChallengeComplete();

int ipworks3ds_client_getchallengecomplete(void* lpObj);

bool GetChallengeComplete();

Default Value

FALSE

Remarks

Present in the Challenge Response Message (CRes) and indicates whether the challenge cycle is complete or will require additional messages. If true, the TransactionStatus will be populated as well.

This property is read-only.

Data Type

Boolean

ChallengeDataEntry Property (Client Class)

Cardholder entered data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeDataEntry();
int SetChallengeDataEntry(const char* lpszChallengeDataEntry);

Unicode (Windows)
LPWSTR GetChallengeDataEntry();
INT SetChallengeDataEntry(LPCWSTR lpszChallengeDataEntry);

char* ipworks3ds_client_getchallengedataentry(void* lpObj);
int ipworks3ds_client_setchallengedataentry(void* lpObj, const char* lpszChallengeDataEntry);

QString GetChallengeDataEntry();
int SetChallengeDataEntry(QString qsChallengeDataEntry);

Default Value

""

Remarks

This field contains the data that the cardholder entered into the UI.

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

Data Type

String

ChallengeDataEntryTwo Property (Client Class)

Cardholder entered data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeDataEntryTwo();
int SetChallengeDataEntryTwo(const char* lpszChallengeDataEntryTwo);

Unicode (Windows)
LPWSTR GetChallengeDataEntryTwo();
INT SetChallengeDataEntryTwo(LPCWSTR lpszChallengeDataEntryTwo);

char* ipworks3ds_client_getchallengedataentrytwo(void* lpObj);
int ipworks3ds_client_setchallengedataentrytwo(void* lpObj, const char* lpszChallengeDataEntryTwo);

QString GetChallengeDataEntryTwo();
int SetChallengeDataEntryTwo(QString qsChallengeDataEntryTwo);

Default Value

""

Remarks

This field contains the data that the cardholder entered into the UI.

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

Data Type

String

ChallengeEntryBox Property (Client Class)

First entry box settings.

Syntax

• C++
• C
• Qt

IPWorks3DSChallengeTextBox* GetChallengeEntryBox();

int ipworks3ds_client_getchallengeentryboxautofill(void* lpObj);

int ipworks3ds_client_getchallengeentryboxautofilltype(void* lpObj);

int ipworks3ds_client_getchallengeentryboxkeyboardtype(void* lpObj);

char* ipworks3ds_client_getchallengeentryboxlabel(void* lpObj);

int ipworks3ds_client_getchallengeentryboxlengthmax(void* lpObj);

int ipworks3ds_client_getchallengeentryboxmasking(void* lpObj);

int ipworks3ds_client_getchallengeentryboxmaskingtoggle(void* lpObj);

bool GetChallengeEntryBoxAutofill();

int GetChallengeEntryBoxAutofillType();

int GetChallengeEntryBoxKeyboardType();

QString GetChallengeEntryBoxLabel();

int GetChallengeEntryBoxLengthMax();

bool GetChallengeEntryBoxMasking();

bool GetChallengeEntryBoxMaskingToggle();

Remarks

Defines the settings for the first entry box in the Native UI OTP/Text Template.

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

Data Type

IPWorks3DSChallengeTextBox

ChallengeEntryBoxTwo Property (Client Class)

Second entry box settings.

Syntax

• C++
• C
• Qt

IPWorks3DSChallengeTextBox* GetChallengeEntryBoxTwo();

int ipworks3ds_client_getchallengeentryboxtwoautofill(void* lpObj);

int ipworks3ds_client_getchallengeentryboxtwoautofilltype(void* lpObj);

int ipworks3ds_client_getchallengeentryboxtwokeyboardtype(void* lpObj);

char* ipworks3ds_client_getchallengeentryboxtwolabel(void* lpObj);

int ipworks3ds_client_getchallengeentryboxtwolengthmax(void* lpObj);

int ipworks3ds_client_getchallengeentryboxtwomasking(void* lpObj);

int ipworks3ds_client_getchallengeentryboxtwomaskingtoggle(void* lpObj);

bool GetChallengeEntryBoxTwoAutofill();

int GetChallengeEntryBoxTwoAutofillType();

int GetChallengeEntryBoxTwoKeyboardType();

QString GetChallengeEntryBoxTwoLabel();

int GetChallengeEntryBoxTwoLengthMax();

bool GetChallengeEntryBoxTwoMasking();

bool GetChallengeEntryBoxTwoMaskingToggle();

Remarks

Defines the settings for the second entry box in the Native UI OTP/Text Template.

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

Data Type

IPWorks3DSChallengeTextBox

ChallengeInfoHeader Property (Client Class)

Challenge information screen header.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeInfoHeader();

Unicode (Windows)
LPWSTR GetChallengeInfoHeader();

char* ipworks3ds_client_getchallengeinfoheader(void* lpObj);

QString GetChallengeInfoHeader();

Default Value

""

Remarks

This field contains the header text for the challenge information screen that is being presented.

This property is read-only.

Data Type

String

ChallengeInfoLabel Property (Client Class)

Challenge information label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeInfoLabel();

Unicode (Windows)
LPWSTR GetChallengeInfoLabel();

char* ipworks3ds_client_getchallengeinfolabel(void* lpObj);

QString GetChallengeInfoLabel();

Default Value

""

Remarks

This field contains the label to modify the challenge data entry field provided by the issuer. If this field is populated, it should be displayed to the cardholder.

This property is read-only.

Data Type

String

ChallengeInfoText Property (Client Class)

Challenge information text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChallengeInfoText();

Unicode (Windows)
LPWSTR GetChallengeInfoText();

char* ipworks3ds_client_getchallengeinfotext(void* lpObj);

QString GetChallengeInfoText();

Default Value

""

Remarks

This field contains text provided by the ACS/Issuer to the cardholder during the challenge message exchange. If this field is populated, it should be displayed to the cardholder.

This property is read-only.

Data Type

String

ChallengeSelectInfo Property (Client Class)

Challenge selection information.

Syntax

• C++
• C
• Qt

IPWorks3DSList<IPWorks3DSChallengeSelectInfo>* GetChallengeSelectInfo();

int ipworks3ds_client_getchallengeselectinfocount(void* lpObj);

char* ipworks3ds_client_getchallengeselectinfoname(void* lpObj, int challengeselectinfoindex);

char* ipworks3ds_client_getchallengeselectinfovalue(void* lpObj, int challengeselectinfoindex);

int GetChallengeSelectInfoCount();

QString GetChallengeSelectInfoName(int iChallengeSelectInfoIndex);

QString GetChallengeSelectInfoValue(int iChallengeSelectInfoIndex);

Remarks

This property holds a collection of name/value pairs to be displayed to the cardholder as selectable options when ACSUIType is Single-Select (02) or Multi-Select (03).

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

Data Type

IPWorks3DSChallengeSelectInfo

DataPacketOut Property (Client Class)

Contains the data packet sent to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataPacketOut();

Unicode (Windows)
LPWSTR GetDataPacketOut();

char* ipworks3ds_client_getdatapacketout(void* lpObj);

QString GetDataPacketOut();

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

DeviceBindingDataEntry Property (Client Class)

Device Binding Data Entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDeviceBindingDataEntry();
int SetDeviceBindingDataEntry(int bDeviceBindingDataEntry);

Unicode (Windows)
BOOL GetDeviceBindingDataEntry();
INT SetDeviceBindingDataEntry(BOOL bDeviceBindingDataEntry);

int ipworks3ds_client_getdevicebindingdataentry(void* lpObj);
int ipworks3ds_client_setdevicebindingdataentry(void* lpObj, int bDeviceBindingDataEntry);

bool GetDeviceBindingDataEntry();
int SetDeviceBindingDataEntry(bool bDeviceBindingDataEntry);

Default Value

FALSE

Remarks

Indicator provided by the 3DS SDK to the ACS to confirm whether the Cardholder gives consent to bind the device.

Data Type

Boolean

DeviceBindingInformationText Property (Client Class)

Device binding information text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDeviceBindingInformationText();

Unicode (Windows)
LPWSTR GetDeviceBindingInformationText();

char* ipworks3ds_client_getdevicebindinginformationtext(void* lpObj);

QString GetDeviceBindingInformationText();

Default Value

""

Remarks

Text provided by the ACS to the Cardholder during the Device Binding process.

This property is read-only.

Data Type

String

DeviceParams Property (Client Class)

Device information parameters.

Syntax

• C++
• C
• Qt

IPWorks3DSList<IPWorks3DSDeviceParam>* GetDeviceParams();
int SetDeviceParams(IPWorks3DSList<IPWorks3DSDeviceParam>* val);

int ipworks3ds_client_getdeviceparamcount(void* lpObj);
int ipworks3ds_client_setdeviceparamcount(void* lpObj, int iDeviceParamCount);

int ipworks3ds_client_getdeviceparamcategory(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamcategory(void* lpObj, int deviceparamindex, int iDeviceParamCategory);

char* ipworks3ds_client_getdeviceparamfieldname(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamfieldname(void* lpObj, int deviceparamindex, const char* lpszDeviceParamFieldName);

char* ipworks3ds_client_getdeviceparamvalue(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamvalue(void* lpObj, int deviceparamindex, const char* lpszDeviceParamValue);

int ipworks3ds_client_getdeviceparamvaluetype(void* lpObj, int deviceparamindex);
int ipworks3ds_client_setdeviceparamvaluetype(void* lpObj, int deviceparamindex, int iDeviceParamValueType);

int GetDeviceParamCount();
int SetDeviceParamCount(int iDeviceParamCount);

int GetDeviceParamCategory(int iDeviceParamIndex);
int SetDeviceParamCategory(int iDeviceParamIndex, int iDeviceParamCategory);

QString GetDeviceParamFieldName(int iDeviceParamIndex);
int SetDeviceParamFieldName(int iDeviceParamIndex, QString qsDeviceParamFieldName);

QString GetDeviceParamValue(int iDeviceParamIndex);
int SetDeviceParamValue(int iDeviceParamIndex, QString qsDeviceParamValue);

int GetDeviceParamValueType(int iDeviceParamIndex);
int SetDeviceParamValueType(int iDeviceParamIndex, int iDeviceParamValueType);

Remarks

This collection contains device information parameters that are used in the app flow to provide device information to the directory server. Parameters can be added manually or using the AddDeviceParam method. More information can be found in the documentation for the AddDeviceParam method.

Data Type

IPWorks3DSDeviceParam

DirectoryServerCert Property (Client Class)

Directory Server public key certificate.

Syntax

• C++
• C
• Qt

IPWorks3DSCertificate* GetDirectoryServerCert();
int SetDirectoryServerCert(IPWorks3DSCertificate* val);

int ipworks3ds_client_getdirectoryservercertstore(void* lpObj, char** lpDirectoryServerCertStore, int* lenDirectoryServerCertStore);
int ipworks3ds_client_setdirectoryservercertstore(void* lpObj, const char* lpDirectoryServerCertStore, int lenDirectoryServerCertStore);

char* ipworks3ds_client_getdirectoryservercertstorepassword(void* lpObj);
int ipworks3ds_client_setdirectoryservercertstorepassword(void* lpObj, const char* lpszDirectoryServerCertStorePassword);

int ipworks3ds_client_getdirectoryservercertstoretype(void* lpObj);
int ipworks3ds_client_setdirectoryservercertstoretype(void* lpObj, int iDirectoryServerCertStoreType);

char* ipworks3ds_client_getdirectoryservercertsubject(void* lpObj);
int ipworks3ds_client_setdirectoryservercertsubject(void* lpObj, const char* lpszDirectoryServerCertSubject);

int ipworks3ds_client_getdirectoryservercertencoded(void* lpObj, char** lpDirectoryServerCertEncoded, int* lenDirectoryServerCertEncoded);
int ipworks3ds_client_setdirectoryservercertencoded(void* lpObj, const char* lpDirectoryServerCertEncoded, int lenDirectoryServerCertEncoded);

QByteArray GetDirectoryServerCertStore();
int SetDirectoryServerCertStore(QByteArray qbaDirectoryServerCertStore);

QString GetDirectoryServerCertStorePassword();
int SetDirectoryServerCertStorePassword(QString qsDirectoryServerCertStorePassword);

int GetDirectoryServerCertStoreType();
int SetDirectoryServerCertStoreType(int iDirectoryServerCertStoreType);

QString GetDirectoryServerCertSubject();
int SetDirectoryServerCertSubject(QString qsDirectoryServerCertSubject);

QByteArray GetDirectoryServerCertEncoded();
int SetDirectoryServerCertEncoded(QByteArray qbaDirectoryServerCertEncoded);

Remarks

Public key generated by the DS Certificate Authority, which is typically operated by the Payment System responsible for a specific DS. The key is identified based on the DirectoryServerId. Required to encrypt DeviceParams when building AReq.

Data Type

IPWorks3DSCertificate

DirectoryServerId Property (Client Class)

Value of the Registered Application Provider Identifier (RID) unique to the payment system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirectoryServerId();
int SetDirectoryServerId(const char* lpszDirectoryServerId);

Unicode (Windows)
LPWSTR GetDirectoryServerId();
INT SetDirectoryServerId(LPCWSTR lpszDirectoryServerId);

char* ipworks3ds_client_getdirectoryserverid(void* lpObj);
int ipworks3ds_client_setdirectoryserverid(void* lpObj, const char* lpszDirectoryServerId);

QString GetDirectoryServerId();
int SetDirectoryServerId(QString qsDirectoryServerId);

Default Value

""

Remarks

Registered Application Provider Identifier (RID) value defined by the ISO 7816-5 standard for uniquely registering such providers. This value is unique to the Payment System involved and must be known by the 3DS Requestor App so that it may be passed to the SDK on when it invokes the createTransaction method within the SDK. Used to identify the DirectoryServerCert for the given DS which is used by the SDK to encrypt the Device Information. Required when DirectoryServerCert is an EC key.

Data Type

String

DirectoryServerKeyId Property (Client Class)

Directory Server Key Identifier (kid).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirectoryServerKeyId();
int SetDirectoryServerKeyId(const char* lpszDirectoryServerKeyId);

Unicode (Windows)
LPWSTR GetDirectoryServerKeyId();
INT SetDirectoryServerKeyId(LPCWSTR lpszDirectoryServerKeyId);

char* ipworks3ds_client_getdirectoryserverkeyid(void* lpObj);
int ipworks3ds_client_setdirectoryserverkeyid(void* lpObj, const char* lpszDirectoryServerKeyId);

QString GetDirectoryServerKeyId();
int SetDirectoryServerKeyId(QString qsDirectoryServerKeyId);

Default Value

""

Remarks

Used to specify the Directory Server Key Identifier. There may be multiple keys for each DS, with each key having a unique identifier.

Data Type

String

EnableChallengeInfoTextIndicator Property (Client Class)

Challenge information text indicator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEnableChallengeInfoTextIndicator();

Unicode (Windows)
BOOL GetEnableChallengeInfoTextIndicator();

int ipworks3ds_client_getenablechallengeinfotextindicator(void* lpObj);

bool GetEnableChallengeInfoTextIndicator();

Default Value

FALSE

Remarks

This field indicates when the ACS/Issuer would like a warning icon or similar visual indicator to draw attention to the ChallengeInfoText that is being displayed. If this field is populated, it should affect the information being displayed to the cardholder.

This property is read-only.

Data Type

Boolean

ErrorPacket Property (Client Class)

The error packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorPacket();

Unicode (Windows)
LPWSTR GetErrorPacket();

char* ipworks3ds_client_geterrorpacket(void* lpObj);

QString GetErrorPacket();

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

ExpandableInformationLabel Property (Client Class)

Expandable information label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpandableInformationLabel();

Unicode (Windows)
LPWSTR GetExpandableInformationLabel();

char* ipworks3ds_client_getexpandableinformationlabel(void* lpObj);

QString GetExpandableInformationLabel();

Default Value

""

Remarks

Label displayed to the cardholder for the content in ExpandableInformationText.

This property is read-only.

Data Type

String

ExpandableInformationText Property (Client Class)

Expandable information text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpandableInformationText();

Unicode (Windows)
LPWSTR GetExpandableInformationText();

char* ipworks3ds_client_getexpandableinformationtext(void* lpObj);

QString GetExpandableInformationText();

Default Value

""

Remarks

This field contains text provided by the Issuer from the ACS to be displayed to the cardholder for additional information. The format should be an expandable text field.

This property is read-only.

Data Type

String

Extensions Property (Client Class)

Extensions to be included in the next outgoing packet.

Syntax

• C++
• C
• Qt

IPWorks3DSList<IPWorks3DSExtension>* GetExtensions();
int SetExtensions(IPWorks3DSList<IPWorks3DSExtension>* val);

int ipworks3ds_client_getextensioncount(void* lpObj);
int ipworks3ds_client_setextensioncount(void* lpObj, int iExtensionCount);

int ipworks3ds_client_getextensioncritical(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensioncritical(void* lpObj, int extensionindex, int bExtensionCritical);

char* ipworks3ds_client_getextensiondata(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensiondata(void* lpObj, int extensionindex, const char* lpszExtensionData);

char* ipworks3ds_client_getextensionid(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensionid(void* lpObj, int extensionindex, const char* lpszExtensionId);

char* ipworks3ds_client_getextensionname(void* lpObj, int extensionindex);
int ipworks3ds_client_setextensionname(void* lpObj, int extensionindex, const char* lpszExtensionName);

int GetExtensionCount();
int SetExtensionCount(int iExtensionCount);

bool GetExtensionCritical(int iExtensionIndex);
int SetExtensionCritical(int iExtensionIndex, bool bExtensionCritical);

QString GetExtensionData(int iExtensionIndex);
int SetExtensionData(int iExtensionIndex, QString qsExtensionData);

QString GetExtensionId(int iExtensionIndex);
int SetExtensionId(int iExtensionIndex, QString qsExtensionId);

QString GetExtensionName(int iExtensionIndex);
int SetExtensionName(int iExtensionIndex, QString qsExtensionName);

Remarks

Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in Message Extensions. This collection contains extension data to be included in the next outgoing request. Extensions can be added manually or using the AddExtension method.

Note: The maximum number of extensions is 10.

Data Type

IPWorks3DSExtension

IssuerImage1 Property (Client Class)

Issuer image URL 1.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIssuerImage1();

Unicode (Windows)
LPWSTR GetIssuerImage1();

char* ipworks3ds_client_getissuerimage1(void* lpObj);

QString GetIssuerImage1();

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: Medium Density Image in 2.3.1: Default Image

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

Data Type

String

IssuerImage2 Property (Client Class)

Issuer image URL 2.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIssuerImage2();

Unicode (Windows)
LPWSTR GetIssuerImage2();

char* ipworks3ds_client_getissuerimage2(void* lpObj);

QString GetIssuerImage2();

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: High Density Image in 2.3.1: Dark Mode Image

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

Data Type

String

IssuerImage3 Property (Client Class)

Issuer image URL 3.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIssuerImage3();

Unicode (Windows)
LPWSTR GetIssuerImage3();

char* ipworks3ds_client_getissuerimage3(void* lpObj);

QString GetIssuerImage3();

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: Extra High-Density Image in 2.3.1: Monochrome Image

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

Data Type

String

MessageVersion Property (Client Class)

Message version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageVersion();
int SetMessageVersion(const char* lpszMessageVersion);

Unicode (Windows)
LPWSTR GetMessageVersion();
INT SetMessageVersion(LPCWSTR lpszMessageVersion);

char* ipworks3ds_client_getmessageversion(void* lpObj);
int ipworks3ds_client_setmessageversion(void* lpObj, const char* lpszMessageVersion);

QString GetMessageVersion();
int SetMessageVersion(QString qsMessageVersion);

Default Value

"2.1.0"

Remarks

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:

Data Type

String

OOBAppLabel Property (Client Class)

OOB App label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOBAppLabel();

Unicode (Windows)
LPWSTR GetOOBAppLabel();

char* ipworks3ds_client_getoobapplabel(void* lpObj);

QString GetOOBAppLabel();

Default Value

""

Remarks

Label to be displayed for the link to the OOB App URL. For example: "Click here to open Your Bank App."

This property is read-only.

Data Type

String

OOBAppStatus Property (Client Class)

OOB App status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOOBAppStatus();
int SetOOBAppStatus(int iOOBAppStatus);

Unicode (Windows)
INT GetOOBAppStatus();
INT SetOOBAppStatus(INT iOOBAppStatus);

int ipworks3ds_client_getoobappstatus(void* lpObj);
int ipworks3ds_client_setoobappstatus(void* lpObj, int iOOBAppStatus);

int GetOOBAppStatus();
int SetOOBAppStatus(int iOOBAppStatus);

Default Value

0

Remarks

Status code indicating the problem type encountered when using the OOB App URL. 1 = Open OOB App URL failed

Data Type

Integer

OOBAppURL Property (Client Class)

OOB App label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOBAppURL();

Unicode (Windows)
LPWSTR GetOOBAppURL();

char* ipworks3ds_client_getoobappurl(void* lpObj);

QString GetOOBAppURL();

Default Value

""

Remarks

Universal App Link to an authentication app used in the OOB authentication. The OOB App URL will open the appropriate location within the OOB Authentication App.

This property is read-only.

Data Type

String

OOBAppURLIndicator Property (Client Class)

OOB App URL Indicator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOOBAppURLIndicator();
int SetOOBAppURLIndicator(int iOOBAppURLIndicator);

Unicode (Windows)
INT GetOOBAppURLIndicator();
INT SetOOBAppURLIndicator(INT iOOBAppURLIndicator);

int ipworks3ds_client_getoobappurlindicator(void* lpObj);
int ipworks3ds_client_setoobappurlindicator(void* lpObj, int iOOBAppURLIndicator);

int GetOOBAppURLIndicator();
int SetOOBAppURLIndicator(int iOOBAppURLIndicator);

Default Value

1

Remarks

Indicates if the 3DS SDK supports the OOB App URL. 01 = Supported 02 = Not supported by the device 03 = Not supported by the 3DS Requestor

Data Type

Integer

OOBContinuationIndicator Property (Client Class)

OOB continuation indicator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOOBContinuationIndicator();
int SetOOBContinuationIndicator(int iOOBContinuationIndicator);

Unicode (Windows)
INT GetOOBContinuationIndicator();
INT SetOOBContinuationIndicator(INT iOOBContinuationIndicator);

int ipworks3ds_client_getoobcontinuationindicator(void* lpObj);
int ipworks3ds_client_setoobcontinuationindicator(void* lpObj, int iOOBContinuationIndicator);

int GetOOBContinuationIndicator();
int SetOOBContinuationIndicator(int iOOBContinuationIndicator);

Default Value

0

Remarks

An indicator notifying the ACS that the cardholder has completed the authentication as requested by selecting the continue button in an out-of-band (OOB) authentication method. This is exclusive to the app flow and required when the ACSUIType is set to OOB when the user has selected the continue option on the device.

Data Type

Integer

OOBContinueLabel Property (Client Class)

OOB continuation label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOBContinueLabel();

Unicode (Windows)
LPWSTR GetOOBContinueLabel();

char* ipworks3ds_client_getoobcontinuelabel(void* lpObj);

QString GetOOBContinueLabel();

Default Value

""

Remarks

Label to be used in the UI for the button that the user selects when they have completed the OOB authentication.

This property is read-only.

Data Type

String

PaymentSystemImage1 Property (Client Class)

Payment system image URL 1.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentSystemImage1();

Unicode (Windows)
LPWSTR GetPaymentSystemImage1();

char* ipworks3ds_client_getpaymentsystemimage1(void* lpObj);

QString GetPaymentSystemImage1();

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: Medium Density Image in 2.3.1: Default Image

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

Data Type

String

PaymentSystemImage2 Property (Client Class)

Payment system image URL 2.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentSystemImage2();

Unicode (Windows)
LPWSTR GetPaymentSystemImage2();

char* ipworks3ds_client_getpaymentsystemimage2(void* lpObj);

QString GetPaymentSystemImage2();

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: High Density Image in 2.3.1: Dark Mode Image

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

Data Type

String

PaymentSystemImage3 Property (Client Class)

Payment system image URL 3.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentSystemImage3();

Unicode (Windows)
LPWSTR GetPaymentSystemImage3();

char* ipworks3ds_client_getpaymentsystemimage3(void* lpObj);

QString GetPaymentSystemImage3();

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: Extra High-Density Image in 2.3.1: Monochrome Image

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

Data Type

String

Proxy Property (Client Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorks3DSProxy* GetProxy();
int SetProxy(IPWorks3DSProxy* val);

int ipworks3ds_client_getproxyauthscheme(void* lpObj);
int ipworks3ds_client_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworks3ds_client_getproxyautodetect(void* lpObj);
int ipworks3ds_client_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworks3ds_client_getproxypassword(void* lpObj);
int ipworks3ds_client_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworks3ds_client_getproxyport(void* lpObj);
int ipworks3ds_client_setproxyport(void* lpObj, int iProxyPort);

char* ipworks3ds_client_getproxyserver(void* lpObj);
int ipworks3ds_client_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworks3ds_client_getproxyssl(void* lpObj);
int ipworks3ds_client_setproxyssl(void* lpObj, int iProxySSL);

char* ipworks3ds_client_getproxyuser(void* lpObj);
int ipworks3ds_client_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

IPWorks3DSProxy

RequestorAppURL Property (Client Class)

3DS Requestor App URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRequestorAppURL();
int SetRequestorAppURL(const char* lpszRequestorAppURL);

Unicode (Windows)
LPWSTR GetRequestorAppURL();
INT SetRequestorAppURL(LPCWSTR lpszRequestorAppURL);

char* ipworks3ds_client_getrequestorappurl(void* lpObj);
int ipworks3ds_client_setrequestorappurl(void* lpObj, const char* lpszRequestorAppURL);

QString GetRequestorAppURL();
int SetRequestorAppURL(QString qsRequestorAppURL);

Default Value

""

Remarks

3DS Requestor App declaring its URL within the CReq message so that the Authentication app can call the 3DS Requestor App after OOB authentication has occurred. Note: When providing the 3DS Requestor App URL, the 3DS Requestor needs to properly register the URL with the Operating System.

Data Type

String

ResendInformationLabel Property (Client Class)

Label for UI button allowing users to request that authentication information be resent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResendInformationLabel();

Unicode (Windows)
LPWSTR GetResendInformationLabel();

char* ipworks3ds_client_getresendinformationlabel(void* lpObj);

QString GetResendInformationLabel();

Default Value

""

Remarks

Value of text to be displayed on the UI label on the button users click for authentication information to be resent. Sent in CRes if the ACS allows the Cardholder to request such information to be resent. App-based only.

This property is read-only.

Data Type

String

SDKAppId Property (Client Class)

The unique SDK App Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSDKAppId();
int SetSDKAppId(const char* lpszSDKAppId);

Unicode (Windows)
LPWSTR GetSDKAppId();
INT SetSDKAppId(LPCWSTR lpszSDKAppId);

char* ipworks3ds_client_getsdkappid(void* lpObj);
int ipworks3ds_client_setsdkappid(void* lpObj, const char* lpszSDKAppId);

QString GetSDKAppId();
int SetSDKAppId(QString qsSDKAppId);

Default Value

""

Remarks

This property must be set to a universally unique Id created for a specific installation of the app on a consumer device. The app is responsible for generating and storing the SDKAppId for each installation or update. This property must be set before calling GetAuthRequest.

The value assigned here must be 36 characters and be in the format defined in IETF RFC 4122. For example: 8a880dc0-d2d2-4067-bcb1-b08d1690b26e.

Data Type

String

SDKTransactionId Property (Client Class)

SDK Transaction ID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSDKTransactionId();
int SetSDKTransactionId(const char* lpszSDKTransactionId);

Unicode (Windows)
LPWSTR GetSDKTransactionId();
INT SetSDKTransactionId(LPCWSTR lpszSDKTransactionId);

char* ipworks3ds_client_getsdktransactionid(void* lpObj);
int ipworks3ds_client_setsdktransactionid(void* lpObj, const char* lpszSDKTransactionId);

QString GetSDKTransactionId();
int SetSDKTransactionId(QString qsSDKTransactionId);

Default Value

""

Remarks

This field contains the universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction. This is generated by the class when calling the GetAuthRequest method. Shall be provided to the 3DS Server for the purpose of uniquely identifying this transaction within all messages of the authentication process, beginning with the AReq sent by the Server.

Data Type

String

SSLAcceptServerCert Property (Client Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorks3DSCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorks3DSCertificate* val);

char* ipworks3ds_client_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertissuer(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertprivatekey(void* lpObj);

int ipworks3ds_client_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertpublickey(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks3ds_client_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks3ds_client_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks3ds_client_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks3ds_client_getsslacceptservercertstorepassword(void* lpObj);
int ipworks3ds_client_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks3ds_client_getsslacceptservercertstoretype(void* lpObj);
int ipworks3ds_client_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks3ds_client_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertusage(void* lpObj);

int ipworks3ds_client_getsslacceptservercertusageflags(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertversion(void* lpObj);

char* ipworks3ds_client_getsslacceptservercertsubject(void* lpObj);
int ipworks3ds_client_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks3ds_client_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks3ds_client_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorks3DSCertificate

SSLCert Property (Client Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorks3DSCertificate* GetSSLCert();
int SetSSLCert(IPWorks3DSCertificate* val);

char* ipworks3ds_client_getsslcerteffectivedate(void* lpObj);

char* ipworks3ds_client_getsslcertexpirationdate(void* lpObj);

char* ipworks3ds_client_getsslcertextendedkeyusage(void* lpObj);

char* ipworks3ds_client_getsslcertfingerprint(void* lpObj);

char* ipworks3ds_client_getsslcertfingerprintsha1(void* lpObj);

char* ipworks3ds_client_getsslcertfingerprintsha256(void* lpObj);

char* ipworks3ds_client_getsslcertissuer(void* lpObj);

char* ipworks3ds_client_getsslcertprivatekey(void* lpObj);

int ipworks3ds_client_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks3ds_client_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks3ds_client_getsslcertpublickey(void* lpObj);

char* ipworks3ds_client_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks3ds_client_getsslcertpublickeylength(void* lpObj);

char* ipworks3ds_client_getsslcertserialnumber(void* lpObj);

char* ipworks3ds_client_getsslcertsignaturealgorithm(void* lpObj);

int ipworks3ds_client_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks3ds_client_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks3ds_client_getsslcertstorepassword(void* lpObj);
int ipworks3ds_client_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks3ds_client_getsslcertstoretype(void* lpObj);
int ipworks3ds_client_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks3ds_client_getsslcertsubjectaltnames(void* lpObj);

char* ipworks3ds_client_getsslcertthumbprintmd5(void* lpObj);

char* ipworks3ds_client_getsslcertthumbprintsha1(void* lpObj);

char* ipworks3ds_client_getsslcertthumbprintsha256(void* lpObj);

char* ipworks3ds_client_getsslcertusage(void* lpObj);

int ipworks3ds_client_getsslcertusageflags(void* lpObj);

char* ipworks3ds_client_getsslcertversion(void* lpObj);

char* ipworks3ds_client_getsslcertsubject(void* lpObj);
int ipworks3ds_client_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks3ds_client_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks3ds_client_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorks3DSCertificate

SSLServerCert Property (Client Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorks3DSCertificate* GetSSLServerCert();

char* ipworks3ds_client_getsslservercerteffectivedate(void* lpObj);

char* ipworks3ds_client_getsslservercertexpirationdate(void* lpObj);

char* ipworks3ds_client_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks3ds_client_getsslservercertfingerprint(void* lpObj);

char* ipworks3ds_client_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks3ds_client_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks3ds_client_getsslservercertissuer(void* lpObj);

char* ipworks3ds_client_getsslservercertprivatekey(void* lpObj);

int ipworks3ds_client_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks3ds_client_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks3ds_client_getsslservercertpublickey(void* lpObj);

char* ipworks3ds_client_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks3ds_client_getsslservercertpublickeylength(void* lpObj);

char* ipworks3ds_client_getsslservercertserialnumber(void* lpObj);

char* ipworks3ds_client_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks3ds_client_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks3ds_client_getsslservercertstorepassword(void* lpObj);

int ipworks3ds_client_getsslservercertstoretype(void* lpObj);

char* ipworks3ds_client_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks3ds_client_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks3ds_client_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks3ds_client_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks3ds_client_getsslservercertusage(void* lpObj);

int ipworks3ds_client_getsslservercertusageflags(void* lpObj);

char* ipworks3ds_client_getsslservercertversion(void* lpObj);

char* ipworks3ds_client_getsslservercertsubject(void* lpObj);

int ipworks3ds_client_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorks3DSCertificate

SubmitAuthenticationLabel Property (Client Class)

Label for UI button users select to submit authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubmitAuthenticationLabel();

Unicode (Windows)
LPWSTR GetSubmitAuthenticationLabel();

char* ipworks3ds_client_getsubmitauthenticationlabel(void* lpObj);

QString GetSubmitAuthenticationLabel();

Default Value

""

Remarks

Value of text to be displayed on the UI label on the button users click to submit the authentication information they have entered. Sent in CRes if ACSUIType is 01 (Text), 02 (Single Select) or 02 (Multi Select). App-based only.

This property is read-only.

Data Type

String

Timeout Property (Client Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks3ds_client_gettimeout(void* lpObj);
int ipworks3ds_client_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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

TogglePositionIndicator Property (Client Class)

Toggle Position Indicator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTogglePositionIndicator();

Unicode (Windows)
INT GetTogglePositionIndicator();

int ipworks3ds_client_gettogglepositionindicator(void* lpObj);

int GetTogglePositionIndicator();

Default Value

0

Remarks

Indicates if the Trust List and/or Device Binding prompt should be presented below or above the action buttons.

This property is read-only.

Data Type

Integer

TransactionStatus Property (Client Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionStatus();

Unicode (Windows)
LPWSTR GetTransactionStatus();

char* ipworks3ds_client_gettransactionstatus(void* lpObj);

QString GetTransactionStatus();

Default Value

""

Remarks

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

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

UseAdditionalChallenge Property (Client Class)

Whether or not the additional choice button is selected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseAdditionalChallenge();
int SetUseAdditionalChallenge(int bUseAdditionalChallenge);

Unicode (Windows)
BOOL GetUseAdditionalChallenge();
INT SetUseAdditionalChallenge(BOOL bUseAdditionalChallenge);

int ipworks3ds_client_getuseadditionalchallenge(void* lpObj);
int ipworks3ds_client_setuseadditionalchallenge(void* lpObj, int bUseAdditionalChallenge);

bool GetUseAdditionalChallenge();
int SetUseAdditionalChallenge(bool bUseAdditionalChallenge);

Default Value

FALSE

Remarks

Indicates to the ACS that the Cardholder selected the additional choice.

Data Type

Boolean

UseInformationContinuation Property (Client Class)

Whether or not the Information Continue button is selected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseInformationContinuation();
int SetUseInformationContinuation(int bUseInformationContinuation);

Unicode (Windows)
BOOL GetUseInformationContinuation();
INT SetUseInformationContinuation(BOOL bUseInformationContinuation);

int ipworks3ds_client_getuseinformationcontinuation(void* lpObj);
int ipworks3ds_client_setuseinformationcontinuation(void* lpObj, int bUseInformationContinuation);

bool GetUseInformationContinuation();
int SetUseInformationContinuation(bool bUseInformationContinuation);

Default Value

FALSE

Remarks

Indicator notifying the ACS that the Cardholder selected the Information Continue button in the Information UI template.

Data Type

Boolean

WhitelistingDataEntry Property (Client Class)

Whitelisting Data Entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWhitelistingDataEntry();
int SetWhitelistingDataEntry(int bWhitelistingDataEntry);

Unicode (Windows)
BOOL GetWhitelistingDataEntry();
INT SetWhitelistingDataEntry(BOOL bWhitelistingDataEntry);

int ipworks3ds_client_getwhitelistingdataentry(void* lpObj);
int ipworks3ds_client_setwhitelistingdataentry(void* lpObj, int bWhitelistingDataEntry);

bool GetWhitelistingDataEntry();
int SetWhitelistingDataEntry(bool bWhitelistingDataEntry);

Default Value

FALSE

Remarks

An indicator provided by the SDK to the ACS to confirm whether whitelisting was opted by the cardholder (true or false). This is required to be sent after a challenge response is received containing WhitelistingInformationText.

Data Type

Boolean

WhitelistingInformationText Property (Client Class)

Whitelisting information text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWhitelistingInformationText();

Unicode (Windows)
LPWSTR GetWhitelistingInformationText();

char* ipworks3ds_client_getwhitelistinginformationtext(void* lpObj);

QString GetWhitelistingInformationText();

Default Value

""

Remarks

Text provided by the ACS/Issuer to Cardholder during a Whitelisting transaction. For example: "Would you like to add this Merchant to your whitelist?"

If present in the challenge response, this must be displayed by the SDK.

This property is read-only.

Data Type

String

WhyInformationLabel Property (Client Class)

Label for why information section.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWhyInformationLabel();

Unicode (Windows)
LPWSTR GetWhyInformationLabel();

char* ipworks3ds_client_getwhyinformationlabel(void* lpObj);

QString GetWhyInformationLabel();

Default Value

""

Remarks

Label provided by the Issuer for the UI "why" information section. Can be sent in CRes. App-based only.

This property is read-only.

Data Type

String

WhyInformationText Property (Client Class)

Text to explain the authentication task to the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWhyInformationText();

Unicode (Windows)
LPWSTR GetWhyInformationText();

char* ipworks3ds_client_getwhyinformationtext(void* lpObj);

QString GetWhyInformationText();

Default Value

""

Remarks

Text provided by the Issuer for UI to explain the authentication task to the user in the "why" information section. Can be sent in CRes. App-based only.

This property is read-only.

Data Type

String

AddDeviceParam Method (Client Class)

Adds a device parameter to the collection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddDeviceParam(const char* lpszfield, const char* lpszvalue, int ivalueType, int icategory);

Unicode (Windows)
INT AddDeviceParam(LPCWSTR lpszfield, LPCWSTR lpszvalue, INT ivalueType, INT icategory);

int ipworks3ds_client_adddeviceparam(void* lpObj, const char* lpszfield, const char* lpszvalue, int ivalueType, int icategory);

int AddDeviceParam(const QString& qsfield, const QString& qsvalue, int ivalueType, int icategory);

Remarks

AddDeviceParam adds a new device parameter to the DeviceParams collection. These parameters should be obtained from the consumer device and a full list of available parameters can be found in the EMV® 3-D Secure SDK-Device Information document provided by EMVCo.

The ValueType parameter specifies the type of the value. Possible values are:

• 1 (Array)
• 2 (String)

Most parameters will have a value type of 2 (String), which will contain a single, string value. Some parameters, however, may require an array of strings. For example, the A040 parameter is defined as containing a set of paired Bluetooth devices. All of these devices can be specified via an array like so: client.addDeviceParam("A040", "[\"firstDevice\", \"secondDevice\", \"thirdDevice\"]", 1, 1);

There are four categories of device information parameters:

DV - Data Version

This is the version of the data being specified. This is 1.0 by default, but can be set to a different value as shown below. When setting the data version, only the value of the parameter needs to be specified. client1.AddDeviceParam("", "1.1", 2, 0);

DD - Device Data

This category is used to specify the device parameters collected from the mobile platform. // the device platform is Android client1.AddDeviceParam("C001", "Android", 2, 1); // the device model is an HTC One (M8) client1.AddDeviceParam("C002", "HTCOne_M8", 2, 1);

DPNA - Device Parameter Not Available

This category is used to specify reasons for unavailable device parameters. // IP Address couldn't be specified because of a "market or regional restriction on the parameter." client1.AddDeviceParam("C010", "RE01", 2, 2);

SW - Security Warning

This category of parameter is used to specify security warnings. These are used to let the directory server know of the result of checks made by the application upon initialization. When setting security warning parameters, only the name of the parameter needs to be specified. // the device is jailbroken client1.AddDeviceParam("SW01", "", 2, 3); // A debugger is attached to the app client1.AddDeviceParam("SW04", "", 2, 3);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddExtension Method (Client Class)

Adds an extension to the collection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddExtension(const char* lpszId, const char* lpszName, int bCritical, const char* lpszData);

Unicode (Windows)
INT AddExtension(LPCWSTR lpszId, LPCWSTR lpszName, BOOL bCritical, LPCWSTR lpszData);

int ipworks3ds_client_addextension(void* lpObj, const char* lpszId, const char* lpszName, int bCritical, const char* lpszData);

int AddExtension(const QString& qsId, const QString& qsName, bool bCritical, const QString& qsData);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddRequestField Method (Client Class)

Adds a field to the data in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRequestField(const char* lpszName, const char* lpszValue, int iValueType);

Unicode (Windows)
INT AddRequestField(LPCWSTR lpszName, LPCWSTR lpszValue, INT iValueType);

int ipworks3ds_client_addrequestfield(void* lpObj, const char* lpszName, const char* lpszValue, int iValueType);

int AddRequestField(const QString& qsName, const QString& qsValue, int iValueType);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckAuthResponse Method (Client Class)

Checks the received packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckAuthResponse(const char* lpszauthResponse);

Unicode (Windows)
INT CheckAuthResponse(LPCWSTR lpszauthResponse);

int ipworks3ds_client_checkauthresponse(void* lpObj, const char* lpszauthResponse);

int CheckAuthResponse(const QString& qsauthResponse);

Remarks

After the response to the authentication request is received from the 3DS Server class, call CheckAuthResponse to verify and parse the response. See the 3DS Server's SendAuthRequest method for details about obtaining the response.

Before calling this method, ACSRootCerts must be populated with the root certificates used by the ACS to sign the response. This method will validate the signature of the signed content if present.

After calling this method, inspect TransactionStatus to determine if the transaction requires a challenge. If TransactionStatus is C, a challenge is required and SendChallengeRequest should be called to proceed with the challenge flow. If TransactionStatus is D, decoupled authentication will take place outside of the 3-D Secure flow and the results will be posted to the 3DS Server.

If TransactionStatus is Y or A, the transaction is complete.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Client Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks3ds_client_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetAuthRequest Method (Client Class)

Prepares data to be sent by the 3DS Server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthRequest();

Unicode (Windows)
LPWSTR GetAuthRequest();

char* ipworks3ds_client_getauthrequest(void* lpObj);

QString GetAuthRequest();

Remarks

GetAuthRequest encrypts the device info and prepares all the data necessary to be sent by the 3DS Server class in the SendAuthRequest method.

After calling this method, the returned data must be transmitted via a separate secure channel to the server where 3DS Server is being used.

The following properties are required before calling the method:

Calling this method returns required information used by 3DS Server to send the authentication request. Transmit the value returned by this method to the system where 3DS Server is used. The method used to transmit this value is outside the scope of the class.

See SendAuthRequest for details on sending the authentication request after transmitting the data to the 3DS Server.

Calling this method also populates SDKTransactionId which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as SendChallengeRequest.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (Client Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks3ds_client_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Client Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks3ds_client_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResetTransactionInfo Method (Client Class)

Resets transaction specific information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetTransactionInfo();

Unicode (Windows)
INT ResetTransactionInfo();

int ipworks3ds_client_resettransactioninfo(void* lpObj);

int ResetTransactionInfo();

Remarks

This method must be called between transactions when using the same class 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 an App-Based flow the following are reset:

• Internal ephemeral encryption keys
• Values added by AddRequestField
• ACSHTML
• ACSHTMLRefresh
• ACSUIType
• ChallengeAdditionalInformation
• ChallengeComplete
• ChallengeDataEntry
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ChallengeSelectInfo
• DataPacketOut
• DeviceParams
• ErrorPacket
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• OOBContinuationIndicator
• OOBContinueLabel
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• SDKTransactionId
• SubmitAuthenticationLabel
• TransactionStatus
• WhyInformationLabel
• WhyInformationText
• WhitelistingDataEntry
• WhitelistingInformationText
• ACSSignedContent
• ACSTransactionId
• ACSURL
• ChallengeCancellationIndicator
• DSTransactionId
• DecoupledRequestIndicator
• IncomingRawExtensions
• OutgoingRawExtensions
• Extensions
• IncomingExtensionCount
• IncomingExtensionId
• IncomingExtensionName
• IncomingExtensionCritical
• IncomingExtensionData
• OOBAppLabel
• OOBAppURL
• ResendChallengeInfo
• TransactionStatusReason
• MerchantAppURL

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendChallengeRequest Method (Client Class)

Builds and sends the Challenge Request in an app-based challenge flow.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendChallengeRequest();

Unicode (Windows)
INT SendChallengeRequest();

int ipworks3ds_client_sendchallengerequest(void* lpObj);

int SendChallengeRequest();

Remarks

SendChallengeRequest sends the Challenge Request to the ACS when a challenge is required.

When the TransactionStatus is C after calling CheckAuthResponse, a challenge to the cardholder is required. This method sends the challenge request and parses the response. The ACS may provide multiple challenges to the cardholder during this process. As a result this method may need to be called multiple times throughout the authentication process.

After this method is called, check ChallengeComplete to determine if the challenge process is complete. If it is complete (True), check TransactionStatus to determine the outcome. If ChallengeComplete is False, additional challenge interaction is required.

First Request

The first time this method is called, information about the required challenge is obtained from the ACS. The ACS connection information is automatically set when CheckAuthResponse is called; there is no need to specify any ACS connection information.

All required properties for the first call to this method are automatically set after CheckAuthResponse is called. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS.

After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The ACSUIType property indicates the way the ACS will interact with the cardholder. The ChallengeComplete property will be False after the first call to this method since the challenge interaction is not yet complete.

The following properties are applicable when ACSUIType is Text (01), Single-Select (02), or Multi-Select (03):

• ChallengeSelectInfo
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• SubmitAuthenticationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is Out-of-Band (04):

• ChallengeAdditionalInformation
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• OOBContinueLabel
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is HTML (05):

• ACSHTML
• ACSHTMLRefresh

In the case of an HTML interaction, the app should create a webview and populate this with the HTML in ACSHTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

Second Request

The second time this method is called, the purpose is to provide a response to the ACS. At this point the customer should have responded to the challenge provided by the ACS in the response to the first call. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS. The following properties are applicable when calling this method the second time:

• ChallengeDataEntry
• OOBContinuationIndicator

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

When ACSUIType is OOB (04), set OOBContinuationIndicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.

Completing the Challenge

After calling SendChallengeRequest a second time with the cardholder's responses, the ACS may require additional challenges. Check the ChallengeComplete property to determine if the challenge is complete. If False, more challenges are required by the ACS and the same process of displaying the challenge info, collecting the response, and submitting it to the ACS should be performed again.

If ChallengeComplete is True, the challenge interaction is complete and TransactionStatus can be inspected to determine whether the transaction was successful.

Note: As part of the challenge completion the ACS also notifies the 3DS Server of the results. This is done by posting the results to the URL defined by the ResultsURL property of the 3DS Server class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DataPacketIn Event (Client Class)

Fired when receiving a data packet from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketIn(ClientDataPacketInEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} ClientDataPacketInEventParams;


Unicode (Windows)
virtual INT FireDataPacketIn(ClientDataPacketInEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} ClientDataPacketInEventParams;

#define EID_CLIENT_DATAPACKETIN 1

virtual INT IPWORKS3DS_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);

class ClientDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketIn(ClientDataPacketInEventParams *e);

// Or, subclass Client and override this emitter function.
virtual int FireDataPacketIn(ClientDataPacketInEventParams *e) {...}

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 (Client Class)

Fired when sending a data packet to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataPacketOut(ClientDataPacketOutEventParams *e);

typedef struct {
  const char *DataPacket;
  int lenDataPacket;
  int reserved;
} ClientDataPacketOutEventParams;


Unicode (Windows)
virtual INT FireDataPacketOut(ClientDataPacketOutEventParams *e);

typedef struct {
  LPCSTR DataPacket;
  INT lenDataPacket;
  INT reserved;
} ClientDataPacketOutEventParams;

#define EID_CLIENT_DATAPACKETOUT 2

virtual INT IPWORKS3DS_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);

class ClientDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataPacketOut(ClientDataPacketOutEventParams *e);

// Or, subclass Client and override this emitter function.
virtual int FireDataPacketOut(ClientDataPacketOutEventParams *e) {...}

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.

Error Event (Client Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(ClientErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} ClientErrorEventParams;


Unicode (Windows)
virtual INT FireError(ClientErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} ClientErrorEventParams;

#define EID_CLIENT_ERROR 3

virtual INT IPWORKS3DS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class ClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ClientErrorEventParams *e);

// Or, subclass Client and override this emitter function.
virtual int FireError(ClientErrorEventParams *e) {...}

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 (Client Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(ClientLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} ClientLogEventParams;


Unicode (Windows)
virtual INT FireLog(ClientLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} ClientLogEventParams;

#define EID_CLIENT_LOG 4

virtual INT IPWORKS3DS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class ClientLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(ClientLogEventParams *e);

// Or, subclass Client and override this emitter function.
virtual int FireLog(ClientLogEventParams *e) {...}

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"

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.

SSLServerAuthentication Event (Client Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} ClientSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} ClientSSLServerAuthenticationEventParams;

#define EID_CLIENT_SSLSERVERAUTHENTICATION 5

virtual INT IPWORKS3DS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class ClientSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e);

// Or, subclass Client and override this emitter function.
virtual int FireSSLServerAuthentication(ClientSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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 (Client Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(ClientSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} ClientSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(ClientSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} ClientSSLStatusEventParams;

#define EID_CLIENT_SSLSTATUS 6

virtual INT IPWORKS3DS_CALL FireSSLStatus(LPSTR &lpszMessage);

class ClientSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(ClientSSLStatusEventParams *e);

// Or, subclass Client and override this emitter function.
virtual int FireSSLStatus(ClientSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorks3DSCertificate (declared in ipworks3ds.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

ChallengeSelectInfo Type

Challenge Selection Information.

Syntax

IPWorks3DSChallengeSelectInfo (declared in ipworks3ds.h)

Remarks

Selection information that will be presented to the cardholder if the option is single or multi select. Name will contain the name of the field and Value will contain the corresponding value.

Fields

Constructors

ChallengeSelectInfo()

ChallengeTextBox Type

Entry box settings.

Syntax

IPWorks3DSChallengeTextBox (declared in ipworks3ds.h)

Remarks

Defines the settings related to an entry box in the Native UI OTP/Text Template.

Fields

Constructors

ChallengeTextBox()

DeviceParam Type

Device information parameter.

Syntax

IPWorks3DSDeviceParam (declared in ipworks3ds.h)

Remarks

Device information parameter used in the app flow to provide device information to the directory server.

Fields

Constructors

DeviceParam()

DeviceParam(const char* lpszFieldName, const char* lpszValue, int iValueType, int iCategory)

Extension Type

This type contains extension details.

Syntax

IPWorks3DSExtension (declared in ipworks3ds.h)

Remarks

Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in Message Extensions. This type is used to define extensions to be sent in the next outgoing request.

Fields

Constructors

Extension()

Extension(const char* lpszId, const char* lpszName, int bCritical, const char* lpszData)

Proxy Type

The proxy the component will connect to.

Syntax

IPWorks3DSProxy (declared in ipworks3ds.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

IPWorks3DSList Type

Syntax

IPWorks3DSList<T> (declared in ipworks3ds.h)

Remarks

IPWorks3DSList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the Client class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (Client Class)

Client Config Settings