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.

Class Name

IPWorks3DS_Client

Procedural Interface

 ipworks3ds_client_open();
 ipworks3ds_client_close($res);
 ipworks3ds_client_register_callback($res, $id, $function);
 ipworks3ds_client_get_last_error($res);
 ipworks3ds_client_get_last_error_code($res);
 ipworks3ds_client_set($res, $id, $index, $value);
 ipworks3ds_client_get($res, $id, $index);
 ipworks3ds_client_do_adddeviceparam($res, $field, $value, $valuetype, $category);
 ipworks3ds_client_do_addextension($res, $id, $name, $critical, $data);
 ipworks3ds_client_do_addrequestfield($res, $name, $value, $valuetype);
 ipworks3ds_client_do_checkauthresponse($res, $authresponse);
 ipworks3ds_client_do_config($res, $configurationstring);
 ipworks3ds_client_do_getauthrequest($res);
 ipworks3ds_client_do_interrupt($res);
 ipworks3ds_client_do_reset($res);
 ipworks3ds_client_do_resettransactioninfo($res);
 ipworks3ds_client_do_sendchallengerequest($res);

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)
• 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 CardRangeMethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.

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

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

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

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

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

Response Handling

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

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 Y to indicate that SPC is supported by the 3DS Requestor.

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

• WebAuthnCredentialListCount
• WebAuthnCredentialListWebAuthnCredential
• 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 and a ReqAuthMethod of 09. If the AuthenticationInformation value was saved earlier, it can be set via the same configuration setting. If the 3DS Requestor encounters an error during SPC API invokation, this can be indicated using the SPCIncompletionIndicator.

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

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

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 ProtocolVersion 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 (IPWorks3DS_Client Class)

HTML provided by the ACS.

Object Oriented Interface

public function getACSHTML();

Procedural Interface

ipworks3ds_client_get($res, 1 );

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

ACS HTML refresh.

Object Oriented Interface

public function getACSHTMLRefresh();

Procedural Interface

ipworks3ds_client_get($res, 2 );

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

ACSRootCertCount Property (IPWorks3DS_Client Class)

The number of records in the ACSRootCert arrays.

Object Oriented Interface

public function getACSRootCertCount();


public function setACSRootCertCount($value);

Procedural Interface

ipworks3ds_client_get($res, 3 );


ipworks3ds_client_set($res, 3, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ACSRootCertEncoded
• ACSRootCertStore
• ACSRootCertStorePassword
• ACSRootCertStoreType
• ACSRootCertSubject

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

This property is not available at design time.

Data Type

Integer

ACSRootCertEncoded Property (IPWorks3DS_Client Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getACSRootCertEncoded($acsrootcertindex);


public function setACSRootCertEncoded($acsrootcertindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 5 , $acsrootcertindex);


ipworks3ds_client_set($res, 5, $value , $acsrootcertindex);

Default Value

''

Remarks

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

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

The $acsrootcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

Binary String

ACSRootCertStore Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getACSRootCertStore($acsrootcertindex);


public function setACSRootCertStore($acsrootcertindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 21 , $acsrootcertindex);


ipworks3ds_client_set($res, 21, $value , $acsrootcertindex);

Default Value

'MY'

Remarks

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

The ACSRootCertStoreType property denotes the type of the certificate store specified by ACSRootCertStore. If the store is password protected, specify the password in ACSRootCertStorePassword.

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

Designations of certificate stores are platform-dependent.

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

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

The $acsrootcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

Binary String

ACSRootCertStorePassword Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getACSRootCertStorePassword($acsrootcertindex);


public function setACSRootCertStorePassword($acsrootcertindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 22 , $acsrootcertindex);


ipworks3ds_client_set($res, 22, $value , $acsrootcertindex);

Default Value

''

Remarks

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

The $acsrootcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

String

ACSRootCertStoreType Property (IPWorks3DS_Client Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getACSRootCertStoreType($acsrootcertindex);


public function setACSRootCertStoreType($acsrootcertindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 23 , $acsrootcertindex);


ipworks3ds_client_set($res, 23, $value , $acsrootcertindex);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

The $acsrootcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

Integer

ACSRootCertSubject Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getACSRootCertSubject($acsrootcertindex);


public function setACSRootCertSubject($acsrootcertindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 24 , $acsrootcertindex);


ipworks3ds_client_set($res, 24, $value , $acsrootcertindex);

Default Value

''

Remarks

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

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

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

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

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

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

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

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

The $acsrootcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

String

ACSUIType Property (IPWorks3DS_Client Class)

UI type rendered by the 3DS SDK.

Object Oriented Interface

public function getACSUIType();

Procedural Interface

ipworks3ds_client_get($res, 32 );

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

Challenge additional information text.

Object Oriented Interface

public function getChallengeAdditionalInformation();

Procedural Interface

ipworks3ds_client_get($res, 33 );

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

Challenge Additional Label.

Object Oriented Interface

public function getChallengeAdditionalLabel();

Procedural Interface

ipworks3ds_client_get($res, 34 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ChallengeCancellationIndicator Property (IPWorks3DS_Client Class)

Challenge Cancellation Indicator.

Object Oriented Interface

public function getChallengeCancellationIndicator();


public function setChallengeCancellationIndicator($value);

Procedural Interface

ipworks3ds_client_get($res, 35 );


ipworks3ds_client_set($res, 35, $value );

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

Whether or not the challenge cycle is complete.

Object Oriented Interface

public function getChallengeComplete();

Procedural Interface

ipworks3ds_client_get($res, 36 );

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

Cardholder entered data.

Object Oriented Interface

public function getChallengeDataEntry();


public function setChallengeDataEntry($value);

Procedural Interface

ipworks3ds_client_get($res, 37 );


ipworks3ds_client_set($res, 37, $value );

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

Cardholder entered data.

Object Oriented Interface

public function getChallengeDataEntryTwo();


public function setChallengeDataEntryTwo($value);

Procedural Interface

ipworks3ds_client_get($res, 38 );


ipworks3ds_client_set($res, 38, $value );

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

ChallengeEntryBoxAutofill Property (IPWorks3DS_Client Class)

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.

Object Oriented Interface

public function getChallengeEntryBoxAutofill();

Procedural Interface

ipworks3ds_client_get($res, 39 );

Default Value

false

Remarks

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. When enabled, the 3DS SDK/OS automatically copies the received or saved code or password in the Challenge Data Entry.

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

Data Type

Boolean

ChallengeEntryBoxAutofillType Property (IPWorks3DS_Client Class)

Indicates the type of data expected when the Challenge Data Entry Autofill is active.

Object Oriented Interface

public function getChallengeEntryBoxAutofillType();

Procedural Interface

ipworks3ds_client_get($res, 40 );

Default Value

0

Remarks

Indicates the type of data expected when the Challenge Data Entry Autofill is active. 01 = SMS OTP 02 = Password

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

Data Type

Integer

ChallengeEntryBoxKeyboardType Property (IPWorks3DS_Client Class)

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.

Object Oriented Interface

public function getChallengeEntryBoxKeyboardType();

Procedural Interface

ipworks3ds_client_get($res, 41 );

Default Value

0

Remarks

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. 0 - Undefined 1 - Numeric keyboard 2 - Alphanumeric keyboard

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

Data Type

Integer

ChallengeEntryBoxLabel Property (IPWorks3DS_Client Class)

Label to specify the expected data entry provided by the ACS.

Object Oriented Interface

public function getChallengeEntryBoxLabel();

Procedural Interface

ipworks3ds_client_get($res, 42 );

Default Value

''

Remarks

Label to specify the expected data entry provided by the ACS.

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

Data Type

String

ChallengeEntryBoxLengthMax Property (IPWorks3DS_Client Class)

Indicates to the 3DS SDK the maximum length of the challenge data entry.

Object Oriented Interface

public function getChallengeEntryBoxLengthMax();

Procedural Interface

ipworks3ds_client_get($res, 43 );

Default Value

0

Remarks

Indicates to the 3DS SDK the maximum length of the challenge data entry.

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

Data Type

Integer

ChallengeEntryBoxMasking Property (IPWorks3DS_Client Class)

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

Object Oriented Interface

public function getChallengeEntryBoxMasking();

Procedural Interface

ipworks3ds_client_get($res, 44 );

Default Value

false

Remarks

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

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

Data Type

Boolean

ChallengeEntryBoxMaskingToggle Property (IPWorks3DS_Client Class)

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

Object Oriented Interface

public function getChallengeEntryBoxMaskingToggle();

Procedural Interface

ipworks3ds_client_get($res, 45 );

Default Value

false

Remarks

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

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

Data Type

Boolean

ChallengeEntryBoxTwoAutofill Property (IPWorks3DS_Client Class)

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.

Object Oriented Interface

public function getChallengeEntryBoxTwoAutofill();

Procedural Interface

ipworks3ds_client_get($res, 46 );

Default Value

false

Remarks

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. When enabled, the 3DS SDK/OS automatically copies the received or saved code or password in the Challenge Data Entry.

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

Data Type

Boolean

ChallengeEntryBoxTwoAutofillType Property (IPWorks3DS_Client Class)

Indicates the type of data expected when the Challenge Data Entry Autofill is active.

Object Oriented Interface

public function getChallengeEntryBoxTwoAutofillType();

Procedural Interface

ipworks3ds_client_get($res, 47 );

Default Value

0

Remarks

Indicates the type of data expected when the Challenge Data Entry Autofill is active. 01 = SMS OTP 02 = Password

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

Data Type

Integer

ChallengeEntryBoxTwoKeyboardType Property (IPWorks3DS_Client Class)

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.

Object Oriented Interface

public function getChallengeEntryBoxTwoKeyboardType();

Procedural Interface

ipworks3ds_client_get($res, 48 );

Default Value

0

Remarks

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. 0 - Undefined 1 - Numeric keyboard 2 - Alphanumeric keyboard

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

Data Type

Integer

ChallengeEntryBoxTwoLabel Property (IPWorks3DS_Client Class)

Label to specify the expected data entry provided by the ACS.

Object Oriented Interface

public function getChallengeEntryBoxTwoLabel();

Procedural Interface

ipworks3ds_client_get($res, 49 );

Default Value

''

Remarks

Label to specify the expected data entry provided by the ACS.

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

Data Type

String

ChallengeEntryBoxTwoLengthMax Property (IPWorks3DS_Client Class)

Indicates to the 3DS SDK the maximum length of the challenge data entry.

Object Oriented Interface

public function getChallengeEntryBoxTwoLengthMax();

Procedural Interface

ipworks3ds_client_get($res, 50 );

Default Value

0

Remarks

Indicates to the 3DS SDK the maximum length of the challenge data entry.

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

Data Type

Integer

ChallengeEntryBoxTwoMasking Property (IPWorks3DS_Client Class)

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

Object Oriented Interface

public function getChallengeEntryBoxTwoMasking();

Procedural Interface

ipworks3ds_client_get($res, 51 );

Default Value

false

Remarks

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

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

Data Type

Boolean

ChallengeEntryBoxTwoMaskingToggle Property (IPWorks3DS_Client Class)

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

Object Oriented Interface

public function getChallengeEntryBoxTwoMaskingToggle();

Procedural Interface

ipworks3ds_client_get($res, 52 );

Default Value

false

Remarks

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

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

Data Type

Boolean

ChallengeInfoHeader Property (IPWorks3DS_Client Class)

Challenge information screen header.

Object Oriented Interface

public function getChallengeInfoHeader();

Procedural Interface

ipworks3ds_client_get($res, 53 );

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

Challenge information label.

Object Oriented Interface

public function getChallengeInfoLabel();

Procedural Interface

ipworks3ds_client_get($res, 54 );

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

Challenge information text.

Object Oriented Interface

public function getChallengeInfoText();

Procedural Interface

ipworks3ds_client_get($res, 55 );

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

ChallengeSelectInfoCount Property (IPWorks3DS_Client Class)

The number of records in the ChallengeSelectInfo arrays.

Object Oriented Interface

public function getChallengeSelectInfoCount();

Procedural Interface

ipworks3ds_client_get($res, 56 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChallengeSelectInfoName
• ChallengeSelectInfoValue

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

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

Data Type

Integer

ChallengeSelectInfoName Property (IPWorks3DS_Client Class)

The name of the selection option.

Object Oriented Interface

public function getChallengeSelectInfoName($challengeselectinfoindex);

Procedural Interface

ipworks3ds_client_get($res, 57 , $challengeselectinfoindex);

Default Value

''

Remarks

The name of the selection option.

The $challengeselectinfoindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeSelectInfoCount property.

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

Data Type

String

ChallengeSelectInfoValue Property (IPWorks3DS_Client Class)

The value of the selection option.

Object Oriented Interface

public function getChallengeSelectInfoValue($challengeselectinfoindex);

Procedural Interface

ipworks3ds_client_get($res, 58 , $challengeselectinfoindex);

Default Value

''

Remarks

The value of the selection option.

The $challengeselectinfoindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeSelectInfoCount property.

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

Data Type

String

DataPacketOut Property (IPWorks3DS_Client Class)

Contains the data packet sent to the server.

Object Oriented Interface

public function getDataPacketOut();

Procedural Interface

ipworks3ds_client_get($res, 59 );

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

Device Binding Data Entry.

Object Oriented Interface

public function getDeviceBindingDataEntry();


public function setDeviceBindingDataEntry($value);

Procedural Interface

ipworks3ds_client_get($res, 60 );


ipworks3ds_client_set($res, 60, $value );

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

Device binding information text.

Object Oriented Interface

public function getDeviceBindingInformationText();

Procedural Interface

ipworks3ds_client_get($res, 61 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

DeviceParamCount Property (IPWorks3DS_Client Class)

The number of records in the DeviceParam arrays.

Object Oriented Interface

public function getDeviceParamCount();


public function setDeviceParamCount($value);

Procedural Interface

ipworks3ds_client_get($res, 62 );


ipworks3ds_client_set($res, 62, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DeviceParamCategory
• DeviceParamFieldName
• DeviceParamValue
• DeviceParamValueType

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

This property is not available at design time.

Data Type

Integer

DeviceParamCategory Property (IPWorks3DS_Client Class)

The category of the parameter.

Object Oriented Interface

public function getDeviceParamCategory($deviceparamindex);


public function setDeviceParamCategory($deviceparamindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 63 , $deviceparamindex);


ipworks3ds_client_set($res, 63, $value , $deviceparamindex);

Default Value

0

Remarks

The category of the parameter. Possible values include:

The $deviceparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

Integer

DeviceParamFieldName Property (IPWorks3DS_Client Class)

The name of the parameter.

Object Oriented Interface

public function getDeviceParamFieldName($deviceparamindex);


public function setDeviceParamFieldName($deviceparamindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 64 , $deviceparamindex);


ipworks3ds_client_set($res, 64, $value , $deviceparamindex);

Default Value

''

Remarks

The name of the parameter.

The $deviceparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

String

DeviceParamValue Property (IPWorks3DS_Client Class)

The value of the parameter.

Object Oriented Interface

public function getDeviceParamValue($deviceparamindex);


public function setDeviceParamValue($deviceparamindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 65 , $deviceparamindex);


ipworks3ds_client_set($res, 65, $value , $deviceparamindex);

Default Value

''

Remarks

The value of the parameter.

The $deviceparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

String

DeviceParamValueType Property (IPWorks3DS_Client Class)

The type of the value.

Object Oriented Interface

public function getDeviceParamValueType($deviceparamindex);


public function setDeviceParamValueType($deviceparamindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 66 , $deviceparamindex);


ipworks3ds_client_set($res, 66, $value , $deviceparamindex);

Default Value

2

Remarks

The type of the value. Possible values are:

The $deviceparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

Integer

DirectoryServerCertEncoded Property (IPWorks3DS_Client Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getDirectoryServerCertEncoded();


public function setDirectoryServerCertEncoded($value);

Procedural Interface

ipworks3ds_client_get($res, 68 );


ipworks3ds_client_set($res, 68, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

DirectoryServerCertStore Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getDirectoryServerCertStore();


public function setDirectoryServerCertStore($value);

Procedural Interface

ipworks3ds_client_get($res, 84 );


ipworks3ds_client_set($res, 84, $value );

Default Value

'MY'

Remarks

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

The DirectoryServerCertStoreType property denotes the type of the certificate store specified by DirectoryServerCertStore. If the store is password protected, specify the password in DirectoryServerCertStorePassword.

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

DirectoryServerCertStorePassword Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getDirectoryServerCertStorePassword();


public function setDirectoryServerCertStorePassword($value);

Procedural Interface

ipworks3ds_client_get($res, 85 );


ipworks3ds_client_set($res, 85, $value );

Default Value

''

Remarks

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

Data Type

String

DirectoryServerCertStoreType Property (IPWorks3DS_Client Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getDirectoryServerCertStoreType();


public function setDirectoryServerCertStoreType($value);

Procedural Interface

ipworks3ds_client_get($res, 86 );


ipworks3ds_client_set($res, 86, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

DirectoryServerCertSubject Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getDirectoryServerCertSubject();


public function setDirectoryServerCertSubject($value);

Procedural Interface

ipworks3ds_client_get($res, 87 );


ipworks3ds_client_set($res, 87, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

DirectoryServerId Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getDirectoryServerId();


public function setDirectoryServerId($value);

Procedural Interface

ipworks3ds_client_get($res, 95 );


ipworks3ds_client_set($res, 95, $value );

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

Directory Server Key Identifier (kid).

Object Oriented Interface

public function getDirectoryServerKeyId();


public function setDirectoryServerKeyId($value);

Procedural Interface

ipworks3ds_client_get($res, 96 );


ipworks3ds_client_set($res, 96, $value );

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

Challenge information text indicator.

Object Oriented Interface

public function getEnableChallengeInfoTextIndicator();

Procedural Interface

ipworks3ds_client_get($res, 97 );

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

The error packet.

Object Oriented Interface

public function getErrorPacket();

Procedural Interface

ipworks3ds_client_get($res, 98 );

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

Expandable information label.

Object Oriented Interface

public function getExpandableInformationLabel();

Procedural Interface

ipworks3ds_client_get($res, 99 );

Default Value

''

Remarks

Label displayed to the cardholder for the content in ExpandableInformationText.

This property is read-only.

Data Type

String

ExpandableInformationText Property (IPWorks3DS_Client Class)

Expandable information text.

Object Oriented Interface

public function getExpandableInformationText();

Procedural Interface

ipworks3ds_client_get($res, 100 );

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

ExtensionCount Property (IPWorks3DS_Client Class)

The number of records in the Extension arrays.

Object Oriented Interface

public function getExtensionCount();


public function setExtensionCount($value);

Procedural Interface

ipworks3ds_client_get($res, 101 );


ipworks3ds_client_set($res, 101, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ExtensionCritical
• ExtensionData
• ExtensionId
• ExtensionName

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

This property is not available at design time.

Data Type

Integer

ExtensionCritical Property (IPWorks3DS_Client Class)

Whether the extension is critical.

Object Oriented Interface

public function getExtensionCritical($extensionindex);


public function setExtensionCritical($extensionindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 102 , $extensionindex);


ipworks3ds_client_set($res, 102, $value , $extensionindex);

Default Value

false

Remarks

Whether the extension is critical.

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

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

This property is not available at design time.

Data Type

Boolean

ExtensionData Property (IPWorks3DS_Client Class)

The extension data as JSON.

Object Oriented Interface

public function getExtensionData($extensionindex);


public function setExtensionData($extensionindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 103 , $extensionindex);


ipworks3ds_client_set($res, 103, $value , $extensionindex);

Default Value

''

Remarks

The extension data as JSON.

This setting specifies the JSON formatted extension data.

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

This property is not available at design time.

Data Type

String

ExtensionId Property (IPWorks3DS_Client Class)

The id of the specified extension.

Object Oriented Interface

public function getExtensionId($extensionindex);


public function setExtensionId($extensionindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 104 , $extensionindex);


ipworks3ds_client_set($res, 104, $value , $extensionindex);

Default Value

''

Remarks

The id of the specified extension.

This setting specifies a unique identifier for the extension.

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

This property is not available at design time.

Data Type

String

ExtensionName Property (IPWorks3DS_Client Class)

The extension name.

Object Oriented Interface

public function getExtensionName($extensionindex);


public function setExtensionName($extensionindex, $value);

Procedural Interface

ipworks3ds_client_get($res, 105 , $extensionindex);


ipworks3ds_client_set($res, 105, $value , $extensionindex);

Default Value

''

Remarks

The extension name.

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

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

This property is not available at design time.

Data Type

String

IssuerImage1 Property (IPWorks3DS_Client Class)

Issuer image URL 1.

Object Oriented Interface

public function getIssuerImage1();

Procedural Interface

ipworks3ds_client_get($res, 106 );

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

Issuer image URL 2.

Object Oriented Interface

public function getIssuerImage2();

Procedural Interface

ipworks3ds_client_get($res, 107 );

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

Issuer image URL 3.

Object Oriented Interface

public function getIssuerImage3();

Procedural Interface

ipworks3ds_client_get($res, 108 );

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

Message version.

Object Oriented Interface

public function getMessageVersion();


public function setMessageVersion($value);

Procedural Interface

ipworks3ds_client_get($res, 109 );


ipworks3ds_client_set($res, 109, $value );

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

OOB App label.

Object Oriented Interface

public function getOOBAppLabel();

Procedural Interface

ipworks3ds_client_get($res, 110 );

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

OOB App status.

Object Oriented Interface

public function getOOBAppStatus();


public function setOOBAppStatus($value);

Procedural Interface

ipworks3ds_client_get($res, 111 );


ipworks3ds_client_set($res, 111, $value );

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

OOB App label.

Object Oriented Interface

public function getOOBAppURL();

Procedural Interface

ipworks3ds_client_get($res, 112 );

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

OOB App URL Indicator.

Object Oriented Interface

public function getOOBAppURLIndicator();


public function setOOBAppURLIndicator($value);

Procedural Interface

ipworks3ds_client_get($res, 113 );


ipworks3ds_client_set($res, 113, $value );

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

OOB continuation indicator.

Object Oriented Interface

public function getOOBContinuationIndicator();


public function setOOBContinuationIndicator($value);

Procedural Interface

ipworks3ds_client_get($res, 114 );


ipworks3ds_client_set($res, 114, $value );

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

OOB continuation label.

Object Oriented Interface

public function getOOBContinueLabel();

Procedural Interface

ipworks3ds_client_get($res, 115 );

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

Payment system image URL 1.

Object Oriented Interface

public function getPaymentSystemImage1();

Procedural Interface

ipworks3ds_client_get($res, 116 );

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

Payment system image URL 2.

Object Oriented Interface

public function getPaymentSystemImage2();

Procedural Interface

ipworks3ds_client_get($res, 117 );

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

Payment system image URL 3.

Object Oriented Interface

public function getPaymentSystemImage3();

Procedural Interface

ipworks3ds_client_get($res, 118 );

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

ProxyAuthScheme Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

ipworks3ds_client_get($res, 119 );


ipworks3ds_client_set($res, 119, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

ipworks3ds_client_get($res, 120 );


ipworks3ds_client_set($res, 120, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

ipworks3ds_client_get($res, 121 );


ipworks3ds_client_set($res, 121, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

ipworks3ds_client_get($res, 122 );


ipworks3ds_client_set($res, 122, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

ipworks3ds_client_get($res, 123 );


ipworks3ds_client_set($res, 123, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

ipworks3ds_client_get($res, 124 );


ipworks3ds_client_set($res, 124, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

ipworks3ds_client_get($res, 125 );


ipworks3ds_client_set($res, 125, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

RequestorAppURL Property (IPWorks3DS_Client Class)

3DS Requestor App URL.

Object Oriented Interface

public function getRequestorAppURL();


public function setRequestorAppURL($value);

Procedural Interface

ipworks3ds_client_get($res, 126 );


ipworks3ds_client_set($res, 126, $value );

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

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

Object Oriented Interface

public function getResendInformationLabel();

Procedural Interface

ipworks3ds_client_get($res, 127 );

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

The unique SDK App Id.

Object Oriented Interface

public function getSDKAppId();


public function setSDKAppId($value);

Procedural Interface

ipworks3ds_client_get($res, 128 );


ipworks3ds_client_set($res, 128, $value );

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

SDK Transaction ID.

Object Oriented Interface

public function getSDKTransactionId();


public function setSDKTransactionId($value);

Procedural Interface

ipworks3ds_client_get($res, 129 );


ipworks3ds_client_set($res, 129, $value );

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

SSLAcceptServerCertEncoded Property (IPWorks3DS_Client Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks3ds_client_get($res, 131 );


ipworks3ds_client_set($res, 131, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (IPWorks3DS_Client Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworks3ds_client_get($res, 159 );


ipworks3ds_client_set($res, 159, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworks3ds_client_get($res, 175 );


ipworks3ds_client_set($res, 175, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

ipworks3ds_client_get($res, 176 );


ipworks3ds_client_set($res, 176, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (IPWorks3DS_Client Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworks3ds_client_get($res, 177 );


ipworks3ds_client_set($res, 177, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworks3ds_client_get($res, 178 );


ipworks3ds_client_set($res, 178, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLServerCertEncoded Property (IPWorks3DS_Client Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks3ds_client_get($res, 187 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

SubmitAuthenticationLabel Property (IPWorks3DS_Client Class)

Label for UI button users select to submit authentication.

Object Oriented Interface

public function getSubmitAuthenticationLabel();

Procedural Interface

ipworks3ds_client_get($res, 214 );

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworks3ds_client_get($res, 215 );


ipworks3ds_client_set($res, 215, $value );

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.

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

The default value for the Timeout property is 30 seconds.

Data Type

Integer

TogglePositionIndicator Property (IPWorks3DS_Client Class)

Toggle Position Indicator.

Object Oriented Interface

public function getTogglePositionIndicator();

Procedural Interface

ipworks3ds_client_get($res, 216 );

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

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

Object Oriented Interface

public function getTransactionStatus();

Procedural Interface

ipworks3ds_client_get($res, 217 );

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

Whether or not the additional choice button is selected.

Object Oriented Interface

public function getUseAdditionalChallenge();


public function setUseAdditionalChallenge($value);

Procedural Interface

ipworks3ds_client_get($res, 218 );


ipworks3ds_client_set($res, 218, $value );

Default Value

false

Remarks

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

Data Type

Boolean

UseInformationContinuation Property (IPWorks3DS_Client Class)

Whether or not the Information Continue button is selected.

Object Oriented Interface

public function getUseInformationContinuation();


public function setUseInformationContinuation($value);

Procedural Interface

ipworks3ds_client_get($res, 219 );


ipworks3ds_client_set($res, 219, $value );

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

Whitelisting Data Entry.

Object Oriented Interface

public function getWhitelistingDataEntry();


public function setWhitelistingDataEntry($value);

Procedural Interface

ipworks3ds_client_get($res, 220 );


ipworks3ds_client_set($res, 220, $value );

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

Whitelisting information text.

Object Oriented Interface

public function getWhitelistingInformationText();

Procedural Interface

ipworks3ds_client_get($res, 221 );

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

Label for why information section.

Object Oriented Interface

public function getWhyInformationLabel();

Procedural Interface

ipworks3ds_client_get($res, 222 );

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

Text to explain the authentication task to the user.

Object Oriented Interface

public function getWhyInformationText();

Procedural Interface

ipworks3ds_client_get($res, 223 );

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

Adds a device parameter to the collection.

Object Oriented Interface

public function doAddDeviceParam($field, $value, $valuetype, $category);

Procedural Interface

ipworks3ds_client_do_adddeviceparam($res, $field, $value, $valuetype, $category);

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);

AddExtension Method (IPWorks3DS_Client Class)

Adds an extension to the collection.

Object Oriented Interface

public function doAddExtension($id, $name, $critical, $data);

Procedural Interface

ipworks3ds_client_do_addextension($res, $id, $name, $critical, $data);

Remarks

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

Note: The maximum number of extensions is 10.

AddRequestField Method (IPWorks3DS_Client Class)

Adds a field to the data in the request.

Object Oriented Interface

public function doAddRequestField($name, $value, $valuetype);

Procedural Interface

ipworks3ds_client_do_addrequestfield($res, $name, $value, $valuetype);

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.

CheckAuthResponse Method (IPWorks3DS_Client Class)

Checks the received packet.

Object Oriented Interface

public function doCheckAuthResponse($authresponse);

Procedural Interface

ipworks3ds_client_do_checkauthresponse($res, $authresponse);

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.

Config Method (IPWorks3DS_Client Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks3ds_client_do_config($res, $configurationstring);

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.

GetAuthRequest Method (IPWorks3DS_Client Class)

Prepares data to be sent by the 3DS Server.

Object Oriented Interface

public function doGetAuthRequest();

Procedural Interface

ipworks3ds_client_do_getauthrequest($res);

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.

Interrupt Method (IPWorks3DS_Client Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks3ds_client_do_interrupt($res);

Remarks

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

Reset Method (IPWorks3DS_Client Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks3ds_client_do_reset($res);

Remarks

This method clears all properties to their default values.

ResetTransactionInfo Method (IPWorks3DS_Client Class)

Resets transaction specific information.

Object Oriented Interface

public function doResetTransactionInfo();

Procedural Interface

ipworks3ds_client_do_resettransactioninfo($res);

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

SendChallengeRequest Method (IPWorks3DS_Client Class)

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

Object Oriented Interface

public function doSendChallengeRequest();

Procedural Interface

ipworks3ds_client_do_sendchallengerequest($res);

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.

DataPacketIn Event (IPWorks3DS_Client Class)

Fired when receiving a data packet from the server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

ipworks3ds_client_register_callback($res, 1, array($this, 'fireDataPacketIn'));

Parameter List

 'datapacket'

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

Fired when sending a data packet to the server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

ipworks3ds_client_register_callback($res, 2, array($this, 'fireDataPacketOut'));

Parameter List

 'datapacket'

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

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks3ds_client_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks3ds_client_register_callback($res, 4, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks3ds_client_register_callback($res, 5, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (IPWorks3DS_Client Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks3ds_client_register_callback($res, 6, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (Client Class)

Client Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Trappable Errors (Client Class)

Client Errors

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors