Server Class

Properties   Methods   Events   Config Settings   Errors  

The Server class provides support for the 3DS Server role as defined in the EMV® 3-D Secure (EMV 3DS) specification.

Class Name

IPWorks3DS_Server

Procedural Interface

 ipworks3ds_server_open();
 ipworks3ds_server_close($res);
 ipworks3ds_server_register_callback($res, $id, $function);
 ipworks3ds_server_get_last_error($res);
 ipworks3ds_server_get_last_error_code($res);
 ipworks3ds_server_set($res, $id, $index, $value);
 ipworks3ds_server_get($res, $id, $index);
 ipworks3ds_server_do_addextension($res, $id, $name, $critical, $data);
 ipworks3ds_server_do_addrequestfield($res, $name, $value, $valuetype);
 ipworks3ds_server_do_checkresponse($res, $response);
 ipworks3ds_server_do_config($res, $configurationstring);
 ipworks3ds_server_do_getchallengerequest($res);
 ipworks3ds_server_do_getmethoddata($res);
 ipworks3ds_server_do_getoperationresponse($res);
 ipworks3ds_server_do_getresultsresponse($res);
 ipworks3ds_server_do_interrupt($res);
 ipworks3ds_server_do_requestcardranges($res);
 ipworks3ds_server_do_reset($res);
 ipworks3ds_server_do_resettransactioninfo($res);
 ipworks3ds_server_do_sendauthrequest($res);

Remarks

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

Connecting with SSL Client Authentication

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

Option 1: PFX With CA Certs

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

Option 2: SSLCACerts Configuration Setting

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

PHP Example

$ca_int = <<<EOT -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- EOT; $ca_root = <<<EOT -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... 8ECs48NRSON+/Pqm9Hxw1H3/yz2qLG4zTI7xJVDESZGEXadLwCJXD6OReX2F/BtU d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- EOT; $server->doConfig('SSLCACerts=' . $ca_int . '\n' . $ca_root);

Option 3: CA Certs in Windows Store

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

Card Ranges

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

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

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

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

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

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

When MessageVersion is set to 2.3.1, the CardRangeData event will fire for each card range data object received, and the Ranges and ACSProtocolInfos properties will be populated to be accessed within the event handler. Optionally, the DS may return a list of URLs that the 3DS Server can use for communication with the DS. If present, these will be available via both the DSURL event and the DSURLs property.

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

The following properties are applicable when calling this method:

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

The following properties are populated after calling this method:

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

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

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

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

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

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

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

Method Invocation

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

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

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

The following properties are applicable when calling this method:

• MethodNotificationURL (required)

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

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

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

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

Sending the Authentication Request

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

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

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

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

App-Based Flow

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

Browser-Based Flow

Before calling this method, first check the cached card-range data to determine if a 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 True to indicate that SPC is supported by the 3DS Requestor.

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

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

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

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

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

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

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

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

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

Challenge Interaction

If the TransactionStatus is C, a challenge is required.

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

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

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

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

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

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

Example Form

Response Handling

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

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

Response Handling

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

The following messages can be parsed using this method:

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

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

Method Data from MethodNotificationURL

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

• ServerTransactionId

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

Results Request message from ResultsURL

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

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

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

After calling this method, the following properties are populated:

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

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

If TransactionStatus is D and TransactionStatusReason is 29 or 30, this indicates that decoupled authentication should now be performed. When building the Results Response, a ResultsStatus value of 04 should be used. Then, within 60 seconds, a new 3RI authentication must be started with the following field requirements:

• ThreeRIIndicator set to 19, indicating Decoupled Authentication Fallback
• DecoupledRequestIndicator set to Y
• AuthenticationInformation set with threeDSReqPriorRef set to the ACS Transaction ID and threeDSReqPriorAuthMethod set to 02 (Cardholder challenge occurred by ACS).

Final Challenge Response from NotificationURL

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

• ServerTransactionId
• TransactionStatus

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

Operation Request Message (OReq)

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

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

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

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

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

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

Logging Notes

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

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

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

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

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

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

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

Property List

---

The following is the full list of the properties of the 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.

AcceptLanguage Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getAcceptLanguage();
public function setAcceptLanguage($value);

Procedural Interface

ipworks3ds_server_get($res, 1 );
ipworks3ds_server_set($res, 1, $value );

Default Value

''

Remarks

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

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

Valid for MessageVersion 2.3.1 only.

Data Type

String

AccountType Property (IPWorks3DS_Server Class)

Indicates the type of account.

Object Oriented Interface

public function getAccountType();
public function setAccountType($value);

Procedural Interface

ipworks3ds_server_get($res, 2 );
ipworks3ds_server_set($res, 2, $value );

Default Value

''

Remarks

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

Valid values are as follows:

Data Type

String

AcquirerBIN Property (IPWorks3DS_Server Class)

Acquiring institution identification code.

Object Oriented Interface

public function getAcquirerBIN();
public function setAcquirerBIN($value);

Procedural Interface

ipworks3ds_server_get($res, 3 );
ipworks3ds_server_set($res, 3, $value );

Default Value

''

Remarks

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

Data Type

String

AcquirerCountryCode Property (IPWorks3DS_Server Class)

Acquirer Country Code.

Object Oriented Interface

public function getAcquirerCountryCode();
public function setAcquirerCountryCode($value);

Procedural Interface

ipworks3ds_server_get($res, 4 );
ipworks3ds_server_set($res, 4, $value );

Default Value

''

Remarks

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

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

Valid for MessageVersion 2.3.1 only.

Data Type

String

AcquirerMerchantId Property (IPWorks3DS_Server Class)

Acquirer-assigned merchant identifier.

Object Oriented Interface

public function getAcquirerMerchantId();
public function setAcquirerMerchantId($value);

Procedural Interface

ipworks3ds_server_get($res, 5 );
ipworks3ds_server_set($res, 5, $value );

Default Value

''

Remarks

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

Data Type

String

ACSProtocolInfoCount Property (IPWorks3DS_Server Class)

The number of records in the ACSProtocolInfo arrays.

Object Oriented Interface

public function getACSProtocolInfoCount();

Procedural Interface

ipworks3ds_server_get($res, 6 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ACSProtocolInfoIndicator
• ACSProtocolInfoProtocolVersion
• ACSProtocolInfoSupportedMsgExt
• ACSProtocolInfoThreeDSMethodURL

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

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

Data Type

Integer

ACSProtocolInfoIndicator Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getACSProtocolInfoIndicator($acsprotocolinfoindex);

Procedural Interface

ipworks3ds_server_get($res, 7 , $acsprotocolinfoindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ACSProtocolInfoProtocolVersion Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getACSProtocolInfoProtocolVersion($acsprotocolinfoindex);

Procedural Interface

ipworks3ds_server_get($res, 8 , $acsprotocolinfoindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ACSProtocolInfoSupportedMsgExt Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getACSProtocolInfoSupportedMsgExt($acsprotocolinfoindex);

Procedural Interface

ipworks3ds_server_get($res, 9 , $acsprotocolinfoindex);

Default Value

''

Remarks

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

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

id,version;id2,version2;...

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

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

Data Type

String

ACSProtocolInfoThreeDSMethodURL Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getACSProtocolInfoThreeDSMethodURL($acsprotocolinfoindex);

Procedural Interface

ipworks3ds_server_get($res, 10 , $acsprotocolinfoindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ACSURL Property (IPWorks3DS_Server Class)

URL of the ACS to be used for the challenge.

Object Oriented Interface

public function getACSURL();
public function setACSURL($value);

Procedural Interface

ipworks3ds_server_get($res, 11 );
ipworks3ds_server_set($res, 11, $value );

Default Value

''

Remarks

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

Data Type

String

AuthenticationECI Property (IPWorks3DS_Server Class)

Value to be passed in the authorization message.

Object Oriented Interface

public function getAuthenticationECI();

Procedural Interface

ipworks3ds_server_get($res, 12 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

AuthenticationIndicator Property (IPWorks3DS_Server Class)

3DS Requestor Authentication Indicator.

Object Oriented Interface

public function getAuthenticationIndicator();
public function setAuthenticationIndicator($value);

Procedural Interface

ipworks3ds_server_get($res, 13 );
ipworks3ds_server_set($res, 13, $value );

Default Value

'01'

Remarks

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

Data Type

String

AuthenticationValue Property (IPWorks3DS_Server Class)

Used to provide proof of authentication.

Object Oriented Interface

public function getAuthenticationValue();

Procedural Interface

ipworks3ds_server_get($res, 14 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

BillingAddressCity Property (IPWorks3DS_Server Class)

The city of the address.

Object Oriented Interface

public function getBillingAddressCity();
public function setBillingAddressCity($value);

Procedural Interface

ipworks3ds_server_get($res, 15 );
ipworks3ds_server_set($res, 15, $value );

Default Value

''

Remarks

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

Data Type

String

BillingAddressCountry Property (IPWorks3DS_Server Class)

The country of the address.

Object Oriented Interface

public function getBillingAddressCountry();
public function setBillingAddressCountry($value);

Procedural Interface

ipworks3ds_server_get($res, 16 );
ipworks3ds_server_set($res, 16, $value );

Default Value

''

Remarks

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

Data Type

String

BillingAddressLine1 Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getBillingAddressLine1();
public function setBillingAddressLine1($value);

Procedural Interface

ipworks3ds_server_get($res, 17 );
ipworks3ds_server_set($res, 17, $value );

Default Value

''

Remarks

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

Data Type

String

BillingAddressLine2 Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getBillingAddressLine2();
public function setBillingAddressLine2($value);

Procedural Interface

ipworks3ds_server_get($res, 18 );
ipworks3ds_server_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

BillingAddressLine3 Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getBillingAddressLine3();
public function setBillingAddressLine3($value);

Procedural Interface

ipworks3ds_server_get($res, 19 );
ipworks3ds_server_set($res, 19, $value );

Default Value

''

Remarks

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

Data Type

String

BillingAddressPostalCode Property (IPWorks3DS_Server Class)

The ZIP or other postal code of the address.

Object Oriented Interface

public function getBillingAddressPostalCode();
public function setBillingAddressPostalCode($value);

Procedural Interface

ipworks3ds_server_get($res, 20 );
ipworks3ds_server_set($res, 20, $value );

Default Value

''

Remarks

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

Data Type

String

BillingAddressState Property (IPWorks3DS_Server Class)

The state or province of the address.

Object Oriented Interface

public function getBillingAddressState();
public function setBillingAddressState($value);

Procedural Interface

ipworks3ds_server_get($res, 21 );
ipworks3ds_server_set($res, 21, $value );

Default Value

''

Remarks

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

Data Type

String

BrowserAcceptHeader Property (IPWorks3DS_Server Class)

HTTP accept header sent from the cardholder's browser.

Object Oriented Interface

public function getBrowserAcceptHeader();
public function setBrowserAcceptHeader($value);

Procedural Interface

ipworks3ds_server_get($res, 22 );
ipworks3ds_server_set($res, 22, $value );

Default Value

''

Remarks

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

Data Type

String

BrowserIPAddress Property (IPWorks3DS_Server Class)

IP address of the cardholder's browser.

Object Oriented Interface

public function getBrowserIPAddress();
public function setBrowserIPAddress($value);

Procedural Interface

ipworks3ds_server_get($res, 23 );
ipworks3ds_server_set($res, 23, $value );

Default Value

''

Remarks

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

Data Type

String

BrowserJavaEnabledVal Property (IPWorks3DS_Server Class)

Ability of the cardholder's browser to execute Java.

Object Oriented Interface

public function getBrowserJavaEnabledVal();
public function setBrowserJavaEnabledVal($value);

Procedural Interface

ipworks3ds_server_get($res, 24 );
ipworks3ds_server_set($res, 24, $value );

Default Value

0

Remarks

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

Possible values are as follows:

Data Type

Integer

BrowserJavaScriptEnabledVal Property (IPWorks3DS_Server Class)

Ability of the cardholder's browser to execute JavaScript.

Object Oriented Interface

public function getBrowserJavaScriptEnabledVal();
public function setBrowserJavaScriptEnabledVal($value);

Procedural Interface

ipworks3ds_server_get($res, 25 );
ipworks3ds_server_set($res, 25, $value );

Default Value

0

Remarks

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

Possible values are as follows:

Data Type

Integer

BrowserLanguage Property (IPWorks3DS_Server Class)

The cardholder's browser language.

Object Oriented Interface

public function getBrowserLanguage();
public function setBrowserLanguage($value);

Procedural Interface

ipworks3ds_server_get($res, 26 );
ipworks3ds_server_set($res, 26, $value );

Default Value

''

Remarks

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

Data Type

String

BrowserScreenColorDepth Property (IPWorks3DS_Server Class)

The screen color depth of the cardholder's browser.

Object Oriented Interface

public function getBrowserScreenColorDepth();
public function setBrowserScreenColorDepth($value);

Procedural Interface

ipworks3ds_server_get($res, 27 );
ipworks3ds_server_set($res, 27, $value );

Default Value

''

Remarks

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

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

Data Type

String

BrowserScreenHeight Property (IPWorks3DS_Server Class)

The screen height of the cardholder's browser.

Object Oriented Interface

public function getBrowserScreenHeight();
public function setBrowserScreenHeight($value);

Procedural Interface

ipworks3ds_server_get($res, 28 );
ipworks3ds_server_set($res, 28, $value );

Default Value

''

Remarks

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

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

Data Type

String

BrowserScreenWidth Property (IPWorks3DS_Server Class)

The screen width of the cardholder's browser.

Object Oriented Interface

public function getBrowserScreenWidth();
public function setBrowserScreenWidth($value);

Procedural Interface

ipworks3ds_server_get($res, 29 );
ipworks3ds_server_set($res, 29, $value );

Default Value

''

Remarks

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

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

Data Type

String

BrowserTimeZone Property (IPWorks3DS_Server Class)

The timezone offset of the cardholder's browser.

Object Oriented Interface

public function getBrowserTimeZone();
public function setBrowserTimeZone($value);

Procedural Interface

ipworks3ds_server_get($res, 30 );
ipworks3ds_server_set($res, 30, $value );

Default Value

''

Remarks

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

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

Data Type

String

BrowserUserAgent Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getBrowserUserAgent();
public function setBrowserUserAgent($value);

Procedural Interface

ipworks3ds_server_get($res, 31 );
ipworks3ds_server_set($res, 31, $value );

Default Value

''

Remarks

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

Data Type

String

CardExpDate Property (IPWorks3DS_Server Class)

Expiration date of the PAN or Token.

Object Oriented Interface

public function getCardExpDate();
public function setCardExpDate($value);

Procedural Interface

ipworks3ds_server_get($res, 32 );
ipworks3ds_server_set($res, 32, $value );

Default Value

''

Remarks

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

Data Type

String

CardholderEmail Property (IPWorks3DS_Server Class)

The cardholder email address.

Object Oriented Interface

public function getCardholderEmail();
public function setCardholderEmail($value);

Procedural Interface

ipworks3ds_server_get($res, 33 );
ipworks3ds_server_set($res, 33, $value );

Default Value

''

Remarks

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

Data Type

String

CardholderHomePhone Property (IPWorks3DS_Server Class)

The cardholder home phone number.

Object Oriented Interface

public function getCardholderHomePhone();
public function setCardholderHomePhone($value);

Procedural Interface

ipworks3ds_server_get($res, 34 );
ipworks3ds_server_set($res, 34, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

CardholderMobilePhone Property (IPWorks3DS_Server Class)

The cardholder mobile phone number.

Object Oriented Interface

public function getCardholderMobilePhone();
public function setCardholderMobilePhone($value);

Procedural Interface

ipworks3ds_server_get($res, 35 );
ipworks3ds_server_set($res, 35, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

CardholderName Property (IPWorks3DS_Server Class)

Name of the cardholder.

Object Oriented Interface

public function getCardholderName();
public function setCardholderName($value);

Procedural Interface

ipworks3ds_server_get($res, 36 );
ipworks3ds_server_set($res, 36, $value );

Default Value

''

Remarks

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

Data Type

String

CardholderWorkPhone Property (IPWorks3DS_Server Class)

The cardholder work phone number.

Object Oriented Interface

public function getCardholderWorkPhone();
public function setCardholderWorkPhone($value);

Procedural Interface

ipworks3ds_server_get($res, 37 );
ipworks3ds_server_set($res, 37, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

CardNumber Property (IPWorks3DS_Server Class)

Customer's account number that will be authenticated.

Object Oriented Interface

public function getCardNumber();
public function setCardNumber($value);

Procedural Interface

ipworks3ds_server_get($res, 38 );
ipworks3ds_server_set($res, 38, $value );

Default Value

''

Remarks

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

Data Type

String

CardRangeCount Property (IPWorks3DS_Server Class)

The number of records in the CardRange arrays.

Object Oriented Interface

public function getCardRangeCount();

Procedural Interface

ipworks3ds_server_get($res, 39 );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

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

Data Type

Integer

CardRangeACSEndProtocolVersion Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeACSEndProtocolVersion($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 40 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CardRangeACSInformationIndicator Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeACSInformationIndicator($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 41 , $cardrangeindex);

Default Value

'0'

Remarks

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

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

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

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

Data Type

String

CardRangeACSStartProtocolVersion Property (IPWorks3DS_Server Class)

The earliest (i.

Object Oriented Interface

public function getCardRangeACSStartProtocolVersion($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 42 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CardRangeAction Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeAction($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 43 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

CardRangeDSEndProtocolVersion Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeDSEndProtocolVersion($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 44 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CardRangeDSStartProtocolVersion Property (IPWorks3DS_Server Class)

The earliest (i.

Object Oriented Interface

public function getCardRangeDSStartProtocolVersion($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 45 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CardRangeEnd Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeEnd($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 46 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

CardRangeMethodURL Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeMethodURL($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 47 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CardRangeStart Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getCardRangeStart($cardrangeindex);

Procedural Interface

ipworks3ds_server_get($res, 48 , $cardrangeindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

ChallengeWindowSize Property (IPWorks3DS_Server Class)

Challenge window size.

Object Oriented Interface

public function getChallengeWindowSize();
public function setChallengeWindowSize($value);

Procedural Interface

ipworks3ds_server_get($res, 49 );
ipworks3ds_server_set($res, 49, $value );

Default Value

1

Remarks

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

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

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

Data Type

Integer

ClientAuthRequest Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getClientAuthRequest();
public function setClientAuthRequest($value);

Procedural Interface

ipworks3ds_server_get($res, 50 );
ipworks3ds_server_set($res, 50, $value );

Default Value

''

Remarks

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

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

Data Type

String

ClientAuthResponse Property (IPWorks3DS_Server Class)

The authentication response for an app-based flow.

Object Oriented Interface

public function getClientAuthResponse();

Procedural Interface

ipworks3ds_server_get($res, 51 );

Default Value

''

Remarks

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

See SendAuthRequest for more details about handling the response.

This property is read-only.

Data Type

String

DataPacketOut Property (IPWorks3DS_Server Class)

Contains the data packet sent to the server.

Object Oriented Interface

public function getDataPacketOut();

Procedural Interface

ipworks3ds_server_get($res, 52 );

Default Value

''

Remarks

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

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

Data Type

String

DeviceChannel Property (IPWorks3DS_Server Class)

Device channel.

Object Oriented Interface

public function getDeviceChannel();
public function setDeviceChannel($value);

Procedural Interface

ipworks3ds_server_get($res, 53 );
ipworks3ds_server_set($res, 53, $value );

Default Value

'02'

Remarks

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

Possible values include:

Data Type

String

DirectoryServerURL Property (IPWorks3DS_Server Class)

The address of the Directory Server.

Object Oriented Interface

public function getDirectoryServerURL();
public function setDirectoryServerURL($value);

Procedural Interface

ipworks3ds_server_get($res, 54 );
ipworks3ds_server_set($res, 54, $value );

Default Value

''

Remarks

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

Data Type

String

DSSupportedProtocols Property (IPWorks3DS_Server Class)

Protocol Versions supported by the DS.

Object Oriented Interface

public function getDSSupportedProtocols();
public function setDSSupportedProtocols($value);

Procedural Interface

ipworks3ds_server_get($res, 55 );
ipworks3ds_server_set($res, 55, $value );

Default Value

0

Remarks

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

Data Type

Integer

DSURLCount Property (IPWorks3DS_Server Class)

The number of records in the DSURL arrays.

Object Oriented Interface

public function getDSURLCount();

Procedural Interface

ipworks3ds_server_get($res, 56 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DSURLCountryCode
• DSURLThreeDSServerToDsUrl

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

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

Data Type

Integer

DSURLCountryCode Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getDSURLCountryCode($dsurlindex);

Procedural Interface

ipworks3ds_server_get($res, 57 , $dsurlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

DSURLThreeDSServerToDsUrl Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getDSURLThreeDSServerToDsUrl($dsurlindex);

Procedural Interface

ipworks3ds_server_get($res, 58 , $dsurlindex);

Default Value

''

Remarks

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

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

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

Data Type

String

ErrorPacket Property (IPWorks3DS_Server Class)

The error packet.

Object Oriented Interface

public function getErrorPacket();

Procedural Interface

ipworks3ds_server_get($res, 59 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

ExtensionCount Property (IPWorks3DS_Server Class)

The number of records in the Extension arrays.

Object Oriented Interface

public function getExtensionCount();
public function setExtensionCount($value);

Procedural Interface

ipworks3ds_server_get($res, 60 );
ipworks3ds_server_set($res, 60, $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_Server Class)

Whether the extension is critical.

Object Oriented Interface

public function getExtensionCritical($extensionindex);
public function setExtensionCritical($extensionindex, $value);

Procedural Interface

ipworks3ds_server_get($res, 61 , $extensionindex);
ipworks3ds_server_set($res, 61, $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_Server Class)

The extension data as JSON.

Object Oriented Interface

public function getExtensionData($extensionindex);
public function setExtensionData($extensionindex, $value);

Procedural Interface

ipworks3ds_server_get($res, 62 , $extensionindex);
ipworks3ds_server_set($res, 62, $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_Server Class)

The id of the specified extension.

Object Oriented Interface

public function getExtensionId($extensionindex);
public function setExtensionId($extensionindex, $value);

Procedural Interface

ipworks3ds_server_get($res, 63 , $extensionindex);
ipworks3ds_server_set($res, 63, $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_Server Class)

The extension name.

Object Oriented Interface

public function getExtensionName($extensionindex);
public function setExtensionName($extensionindex, $value);

Procedural Interface

ipworks3ds_server_get($res, 64 , $extensionindex);
ipworks3ds_server_set($res, 64, $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

MerchantCategoryCode Property (IPWorks3DS_Server Class)

Merchant category code.

Object Oriented Interface

public function getMerchantCategoryCode();
public function setMerchantCategoryCode($value);

Procedural Interface

ipworks3ds_server_get($res, 65 );
ipworks3ds_server_set($res, 65, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantCountryCode Property (IPWorks3DS_Server Class)

Country code of the merchant.

Object Oriented Interface

public function getMerchantCountryCode();
public function setMerchantCountryCode($value);

Procedural Interface

ipworks3ds_server_get($res, 66 );
ipworks3ds_server_set($res, 66, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantName Property (IPWorks3DS_Server Class)

Merchant name.

Object Oriented Interface

public function getMerchantName();
public function setMerchantName($value);

Procedural Interface

ipworks3ds_server_get($res, 67 );
ipworks3ds_server_set($res, 67, $value );

Default Value

''

Remarks

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

Data Type

String

MessageCategory Property (IPWorks3DS_Server Class)

The category of the message.

Object Oriented Interface

public function getMessageCategory();
public function setMessageCategory($value);

Procedural Interface

ipworks3ds_server_get($res, 68 );
ipworks3ds_server_set($res, 68, $value );

Default Value

''

Remarks

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

Possible values include:

Data Type

String

MessageVersion Property (IPWorks3DS_Server Class)

Protocol version identifier.

Object Oriented Interface

public function getMessageVersion();
public function setMessageVersion($value);

Procedural Interface

ipworks3ds_server_get($res, 69 );
ipworks3ds_server_set($res, 69, $value );

Default Value

'2.1.0'

Remarks

The protocol version number of the specification used by the system creating this message.

Possible values are:

The message version number is set by the 3DS Server which originates the protocol with the AReq message (when SendAuthRequest is called). The message version number does not change during a 3DS transaction.

Data Type

String

MethodNotificationURL Property (IPWorks3DS_Server Class)

The URL to which the method notification will be posted.

Object Oriented Interface

public function getMethodNotificationURL();
public function setMethodNotificationURL($value);

Procedural Interface

ipworks3ds_server_get($res, 70 );
ipworks3ds_server_set($res, 70, $value );

Default Value

''

Remarks

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

Data Type

String

NotificationURL Property (IPWorks3DS_Server Class)

The notification URL to which the challenge response is sent.

Object Oriented Interface

public function getNotificationURL();
public function setNotificationURL($value);

Procedural Interface

ipworks3ds_server_get($res, 71 );
ipworks3ds_server_set($res, 71, $value );

Default Value

''

Remarks

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

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

Data Type

String

OperationInfoCategory Property (IPWorks3DS_Server Class)

Indicates the category/type of information.

Object Oriented Interface

public function getOperationInfoCategory();

Procedural Interface

ipworks3ds_server_get($res, 72 );

Default Value

''

Remarks

Indicates the category/type of information.

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

Data Type

String

OperationInfoDescription Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoDescription();

Procedural Interface

ipworks3ds_server_get($res, 73 );

Default Value

''

Remarks

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

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

Data Type

String

OperationInfoExpirationDate Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoExpirationDate();

Procedural Interface

ipworks3ds_server_get($res, 74 );

Default Value

''

Remarks

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

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

Data Type

String

OperationInfoMessageStatus Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoMessageStatus();
public function setOperationInfoMessageStatus($value);

Procedural Interface

ipworks3ds_server_get($res, 75 );
ipworks3ds_server_set($res, 75, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OperationInfoPriorTransactionId Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoPriorTransactionId();

Procedural Interface

ipworks3ds_server_get($res, 76 );

Default Value

''

Remarks

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

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

Data Type

String

OperationInfoPriorTransactionIdType Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoPriorTransactionIdType();

Procedural Interface

ipworks3ds_server_get($res, 77 );

Default Value

0

Remarks

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

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

Data Type

Integer

OperationInfoSequenceId Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoSequenceId();

Procedural Interface

ipworks3ds_server_get($res, 78 );

Default Value

''

Remarks

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

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

Data Type

String

OperationInfoSequenceNumber Property (IPWorks3DS_Server Class)

The current message in the sequence.

Object Oriented Interface

public function getOperationInfoSequenceNumber();
public function setOperationInfoSequenceNumber($value);

Procedural Interface

ipworks3ds_server_get($res, 79 );
ipworks3ds_server_set($res, 79, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OperationInfoSequenceTotal Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getOperationInfoSequenceTotal();

Procedural Interface

ipworks3ds_server_get($res, 80 );

Default Value

0

Remarks

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

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

Data Type

Integer

OperationInfoSeverity Property (IPWorks3DS_Server Class)

Indicates the importance/severity level of the operational information.

Object Oriented Interface

public function getOperationInfoSeverity();

Procedural Interface

ipworks3ds_server_get($res, 81 );

Default Value

''

Remarks

Indicates the importance/severity level of the operational information.

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

Data Type

String

ProxyAuthScheme Property (IPWorks3DS_Server Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks3ds_server_get($res, 82 );
ipworks3ds_server_set($res, 82, $value );

Default Value

0

Remarks

The 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 class 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_Server Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks3ds_server_get($res, 83 );
ipworks3ds_server_set($res, 83, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorks3DS_Server Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks3ds_server_get($res, 84 );
ipworks3ds_server_set($res, 84, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties 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_Server Class)

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_server_get($res, 85 );
ipworks3ds_server_set($res, 85, $value );

Default Value

80

Remarks

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_Server 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_server_get($res, 86 );
ipworks3ds_server_set($res, 86, $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_Server Class)

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_server_get($res, 87 );
ipworks3ds_server_set($res, 87, $value );

Default Value

0

Remarks

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_Server Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks3ds_server_get($res, 88 );
ipworks3ds_server_set($res, 88, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

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

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

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

Data Type

String

PurchaseAmount Property (IPWorks3DS_Server Class)

Purchase amount to be authorized.

Object Oriented Interface

public function getPurchaseAmount();
public function setPurchaseAmount($value);

Procedural Interface

ipworks3ds_server_get($res, 89 );
ipworks3ds_server_set($res, 89, $value );

Default Value

''

Remarks

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

Data Type

String

PurchaseCurrency Property (IPWorks3DS_Server Class)

Identifies the type of currency used by the merchant.

Object Oriented Interface

public function getPurchaseCurrency();
public function setPurchaseCurrency($value);

Procedural Interface

ipworks3ds_server_get($res, 90 );
ipworks3ds_server_set($res, 90, $value );

Default Value

'840'

Remarks

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

Data Type

String

PurchaseDate Property (IPWorks3DS_Server Class)

The date of the transaction.

Object Oriented Interface

public function getPurchaseDate();
public function setPurchaseDate($value);

Procedural Interface

ipworks3ds_server_get($res, 91 );
ipworks3ds_server_set($res, 91, $value );

Default Value

''

Remarks

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

Data Type

String

PurchaseExponent Property (IPWorks3DS_Server Class)

Minor units of currency.

Object Oriented Interface

public function getPurchaseExponent();
public function setPurchaseExponent($value);

Procedural Interface

ipworks3ds_server_get($res, 92 );
ipworks3ds_server_set($res, 92, $value );

Default Value

'2'

Remarks

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

Data Type

String

RangeCount Property (IPWorks3DS_Server Class)

The number of records in the Range arrays.

Object Oriented Interface

public function getRangeCount();

Procedural Interface

ipworks3ds_server_get($res, 93 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RangeEnd
• RangeStart

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

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

Data Type

Integer

RangeEnd Property (IPWorks3DS_Server Class)

The final card number in the current range.

Object Oriented Interface

public function getRangeEnd($rangeindex);

Procedural Interface

ipworks3ds_server_get($res, 94 , $rangeindex);

Default Value

''

Remarks

The final card number in the current range.

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

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

Data Type

String

RangeStart Property (IPWorks3DS_Server Class)

The first card number in the current range.

Object Oriented Interface

public function getRangeStart($rangeindex);

Procedural Interface

ipworks3ds_server_get($res, 95 , $rangeindex);

Default Value

''

Remarks

The first card number in the current range.

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

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

Data Type

String

RecurringExpDate Property (IPWorks3DS_Server Class)

Recurring expiration date.

Object Oriented Interface

public function getRecurringExpDate();
public function setRecurringExpDate($value);

Procedural Interface

ipworks3ds_server_get($res, 96 );
ipworks3ds_server_set($res, 96, $value );

Default Value

''

Remarks

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

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

Data Type

String

RecurringFrequency Property (IPWorks3DS_Server Class)

The number of days between recurring payments.

Object Oriented Interface

public function getRecurringFrequency();
public function setRecurringFrequency($value);

Procedural Interface

ipworks3ds_server_get($res, 97 );
ipworks3ds_server_set($res, 97, $value );

Default Value

''

Remarks

This field indicates the minimum number of days between authorizations.

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

Data Type

String

RequestorId Property (IPWorks3DS_Server Class)

Directory server assigned 3DS Requestor identifier.

Object Oriented Interface

public function getRequestorId();
public function setRequestorId($value);

Procedural Interface

ipworks3ds_server_get($res, 98 );
ipworks3ds_server_set($res, 98, $value );

Default Value

''

Remarks

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

Data Type

String

RequestorName Property (IPWorks3DS_Server Class)

Directory server assigned 3DS Requestor name.

Object Oriented Interface

public function getRequestorName();
public function setRequestorName($value);

Procedural Interface

ipworks3ds_server_get($res, 99 );
ipworks3ds_server_set($res, 99, $value );

Default Value

''

Remarks

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

Data Type

String

RequestorURL Property (IPWorks3DS_Server Class)

3DS Requestor website or customer care site.

Object Oriented Interface

public function getRequestorURL();
public function setRequestorURL($value);

Procedural Interface

ipworks3ds_server_get($res, 100 );
ipworks3ds_server_set($res, 100, $value );

Default Value

''

Remarks

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

Data Type

String

ResultsStatus Property (IPWorks3DS_Server Class)

The status of the Results Request.

Object Oriented Interface

public function getResultsStatus();
public function setResultsStatus($value);

Procedural Interface

ipworks3ds_server_get($res, 101 );
ipworks3ds_server_set($res, 101, $value );

Default Value

0

Remarks

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

Possible values include:

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

If the TransactionStatus is D and a DecoupledRequestIndicator value of F or B was used, ResultsStatus should be set to 04 and a separate 3RI authentication should be initiated within 60 seconds.

Data Type

Integer

ResultsURL Property (IPWorks3DS_Server Class)

3DS Server URL.

Object Oriented Interface

public function getResultsURL();
public function setResultsURL($value);

Procedural Interface

ipworks3ds_server_get($res, 102 );
ipworks3ds_server_set($res, 102, $value );

Default Value

''

Remarks

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

Data Type

String

SDKType Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getSDKType();
public function setSDKType($value);

Procedural Interface

ipworks3ds_server_get($res, 103 );
ipworks3ds_server_set($res, 103, $value );

Default Value

'01'

Remarks

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

Valid values are:

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

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

This property is valid for MessageVersion 2.3.1 only.

Data Type

String

SerialNumber Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getSerialNumber();
public function setSerialNumber($value);

Procedural Interface

ipworks3ds_server_get($res, 104 );
ipworks3ds_server_set($res, 104, $value );

Default Value

''

Remarks

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

Data Type

String

ServerTransactionId Property (IPWorks3DS_Server Class)

Server transaction identifier.

Object Oriented Interface

public function getServerTransactionId();
public function setServerTransactionId($value);

Procedural Interface

ipworks3ds_server_get($res, 105 );
ipworks3ds_server_set($res, 105, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressCity Property (IPWorks3DS_Server Class)

The city of the address.

Object Oriented Interface

public function getShippingAddressCity();
public function setShippingAddressCity($value);

Procedural Interface

ipworks3ds_server_get($res, 106 );
ipworks3ds_server_set($res, 106, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressCountry Property (IPWorks3DS_Server Class)

The country of the address.

Object Oriented Interface

public function getShippingAddressCountry();
public function setShippingAddressCountry($value);

Procedural Interface

ipworks3ds_server_get($res, 107 );
ipworks3ds_server_set($res, 107, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressLine1 Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getShippingAddressLine1();
public function setShippingAddressLine1($value);

Procedural Interface

ipworks3ds_server_get($res, 108 );
ipworks3ds_server_set($res, 108, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressLine2 Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getShippingAddressLine2();
public function setShippingAddressLine2($value);

Procedural Interface

ipworks3ds_server_get($res, 109 );
ipworks3ds_server_set($res, 109, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressLine3 Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getShippingAddressLine3();
public function setShippingAddressLine3($value);

Procedural Interface

ipworks3ds_server_get($res, 110 );
ipworks3ds_server_set($res, 110, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressPostalCode Property (IPWorks3DS_Server Class)

The ZIP or other postal code of the address.

Object Oriented Interface

public function getShippingAddressPostalCode();
public function setShippingAddressPostalCode($value);

Procedural Interface

ipworks3ds_server_get($res, 111 );
ipworks3ds_server_set($res, 111, $value );

Default Value

''

Remarks

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

Data Type

String

ShippingAddressState Property (IPWorks3DS_Server Class)

The state or province of the address.

Object Oriented Interface

public function getShippingAddressState();
public function setShippingAddressState($value);

Procedural Interface

ipworks3ds_server_get($res, 112 );
ipworks3ds_server_set($res, 112, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorks3DS_Server Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks3ds_server_get($res, 113 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks3DS_Server Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks3ds_server_get($res, 114 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks3DS_Server Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks3ds_server_get($res, 115 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks3DS_Server Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks3ds_server_get($res, 116 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks3DS_Server Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks3ds_server_get($res, 117 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks3DS_Server Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks3ds_server_get($res, 118 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks3DS_Server Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks3ds_server_get($res, 119 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks3DS_Server Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks3ds_server_get($res, 120 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks3DS_Server Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks3ds_server_get($res, 121 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks3DS_Server Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks3ds_server_get($res, 122 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks3DS_Server Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks3ds_server_get($res, 123 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks3DS_Server Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks3ds_server_get($res, 124 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks3DS_Server Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks3ds_server_get($res, 125 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks3DS_Server Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks3ds_server_get($res, 126 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks3DS_Server Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks3ds_server_get($res, 127 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks3DS_Server Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks3ds_server_get($res, 128 );
ipworks3ds_server_set($res, 128, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks3DS_Server 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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks3ds_server_get($res, 129 );
ipworks3ds_server_set($res, 129, $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

SSLAcceptServerCertStoreType Property (IPWorks3DS_Server Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks3ds_server_get($res, 130 );
ipworks3ds_server_set($res, 130, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (IPWorks3DS_Server Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks3ds_server_get($res, 131 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks3DS_Server Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks3ds_server_get($res, 132 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks3DS_Server Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks3ds_server_get($res, 133 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks3DS_Server Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks3ds_server_get($res, 134 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks3DS_Server Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks3ds_server_get($res, 135 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks3DS_Server Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks3ds_server_get($res, 136 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks3DS_Server Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks3ds_server_get($res, 137 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks3DS_Server Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks3ds_server_get($res, 138 );
ipworks3ds_server_set($res, 138, $value );

Default Value

''

Remarks

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 as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks3DS_Server Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks3ds_server_get($res, 139 );
ipworks3ds_server_set($res, 139, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (IPWorks3DS_Server Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks3ds_server_get($res, 140 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks3DS_Server Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks3ds_server_get($res, 141 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks3DS_Server Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks3ds_server_get($res, 142 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks3DS_Server Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks3ds_server_get($res, 143 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks3DS_Server Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks3ds_server_get($res, 144 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks3DS_Server Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks3ds_server_get($res, 145 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks3DS_Server Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks3ds_server_get($res, 146 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks3DS_Server Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks3ds_server_get($res, 147 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks3DS_Server Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks3ds_server_get($res, 148 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks3DS_Server Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks3ds_server_get($res, 149 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks3DS_Server Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks3ds_server_get($res, 150 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks3DS_Server Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks3ds_server_get($res, 151 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks3DS_Server Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks3ds_server_get($res, 152 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks3DS_Server Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks3ds_server_get($res, 153 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks3DS_Server Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks3ds_server_get($res, 154 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks3DS_Server Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks3ds_server_get($res, 155 );
ipworks3ds_server_set($res, 155, $value );

Default Value

'MY'

Remarks

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorks3DS_Server 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_server_get($res, 156 );
ipworks3ds_server_set($res, 156, $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_Server Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks3ds_server_get($res, 157 );
ipworks3ds_server_set($res, 157, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (IPWorks3DS_Server Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks3ds_server_get($res, 158 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks3DS_Server Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks3ds_server_get($res, 159 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks3DS_Server Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks3ds_server_get($res, 160 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks3DS_Server Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks3ds_server_get($res, 161 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks3DS_Server Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks3ds_server_get($res, 162 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks3DS_Server Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks3ds_server_get($res, 163 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks3DS_Server Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks3ds_server_get($res, 164 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks3DS_Server Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks3ds_server_get($res, 165 );
ipworks3ds_server_set($res, 165, $value );

Default Value

''

Remarks

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 as follows:

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

Data Type

String

SSLCertEncoded Property (IPWorks3DS_Server Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks3ds_server_get($res, 166 );
ipworks3ds_server_set($res, 166, $value );

Default Value

''

Remarks

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

SSLServerCertEffectiveDate Property (IPWorks3DS_Server Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks3ds_server_get($res, 167 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks3DS_Server Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks3ds_server_get($res, 168 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks3DS_Server Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks3ds_server_get($res, 169 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks3DS_Server Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks3ds_server_get($res, 170 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks3DS_Server Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks3ds_server_get($res, 171 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks3DS_Server Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks3ds_server_get($res, 172 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks3DS_Server Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks3ds_server_get($res, 173 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks3DS_Server Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks3ds_server_get($res, 174 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks3DS_Server Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks3ds_server_get($res, 175 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks3DS_Server Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks3ds_server_get($res, 176 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks3DS_Server Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks3ds_server_get($res, 177 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks3DS_Server Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks3ds_server_get($res, 178 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks3DS_Server Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks3ds_server_get($res, 179 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks3DS_Server Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks3ds_server_get($res, 180 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks3DS_Server Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks3ds_server_get($res, 181 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks3DS_Server Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks3ds_server_get($res, 182 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks3DS_Server 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 getSSLServerCertStorePassword();

Procedural Interface

ipworks3ds_server_get($res, 183 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks3DS_Server Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks3ds_server_get($res, 184 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks3DS_Server Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks3ds_server_get($res, 185 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks3DS_Server Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks3ds_server_get($res, 186 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks3DS_Server Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks3ds_server_get($res, 187 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks3DS_Server Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks3ds_server_get($res, 188 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks3DS_Server Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks3ds_server_get($res, 189 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks3DS_Server Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks3ds_server_get($res, 190 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks3DS_Server Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks3ds_server_get($res, 191 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks3DS_Server Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks3ds_server_get($res, 192 );

Default Value

''

Remarks

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 as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks3DS_Server Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks3ds_server_get($res, 193 );

Default Value

''

Remarks

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

Timeout Property (IPWorks3DS_Server Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks3ds_server_get($res, 194 );
ipworks3ds_server_set($res, 194, $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.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 30 seconds.

Data Type

Integer

TransactionStatus Property (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function getTransactionStatus();

Procedural Interface

ipworks3ds_server_get($res, 195 );

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

AddExtension Method (IPWorks3DS_Server Class)

Adds an extension to the collection.

Object Oriented Interface

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

Procedural Interface

ipworks3ds_server_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_Server Class)

Adds a field to the data in the request.

Object Oriented Interface

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

Procedural Interface

ipworks3ds_server_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.

CheckResponse Method (IPWorks3DS_Server Class)

Parses the specified message.

Object Oriented Interface

public function doCheckResponse($response);

Procedural Interface

ipworks3ds_server_do_checkresponse($res, $response);

Remarks

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

The following messages can be parsed using this method:

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

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

Method Data from MethodNotificationURL

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

• ServerTransactionId

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

Results Request message from ResultsURL

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

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

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

After calling this method, the following properties are populated:

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

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

If TransactionStatus is D and TransactionStatusReason is 29 or 30, this indicates that decoupled authentication should now be performed. When building the Results Response, a ResultsStatus value of 04 should be used. Then, within 60 seconds, a new 3RI authentication must be started with the following field requirements:

• ThreeRIIndicator set to 19, indicating Decoupled Authentication Fallback
• DecoupledRequestIndicator set to Y
• AuthenticationInformation set with threeDSReqPriorRef set to the ACS Transaction ID and threeDSReqPriorAuthMethod set to 02 (Cardholder challenge occurred by ACS).

Final Challenge Response from NotificationURL

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

• ServerTransactionId
• TransactionStatus

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

Operation Request Message (OReq)

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

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

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

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

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

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

Config Method (IPWorks3DS_Server Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks3ds_server_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.

GetChallengeRequest Method (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function doGetChallengeRequest();

Procedural Interface

ipworks3ds_server_do_getchallengerequest($res);

Remarks

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

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

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

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

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

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

Example Form

Response Handling

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

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

GetMethodData Method (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function doGetMethodData();

Procedural Interface

ipworks3ds_server_do_getmethoddata($res);

Remarks

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

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

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

The following properties are applicable when calling this method:

• MethodNotificationURL (required)

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

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

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

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

GetOperationResponse Method (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function doGetOperationResponse();

Procedural Interface

ipworks3ds_server_do_getoperationresponse($res);

Remarks

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

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

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

Possible values include:

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

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

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

GetResultsResponse Method (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function doGetResultsResponse();

Procedural Interface

ipworks3ds_server_do_getresultsresponse($res);

Remarks

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

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

Possible values include:

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

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

Interrupt Method (IPWorks3DS_Server Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks3ds_server_do_interrupt($res);

Remarks

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

RequestCardRanges Method (IPWorks3DS_Server Class)

Requests card ranges from the directory server.

Object Oriented Interface

public function doRequestCardRanges();

Procedural Interface

ipworks3ds_server_do_requestcardranges($res);

Remarks

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

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

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

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

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

When MessageVersion is set to 2.3.1, the CardRangeData event will fire for each card range data object received, and the Ranges and ACSProtocolInfos properties will be populated to be accessed within the event handler. Optionally, the DS may return a list of URLs that the 3DS Server can use for communication with the DS. If present, these will be available via both the DSURL event and the DSURLs property.

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

The following properties are applicable when calling this method:

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

The following properties are populated after calling this method:

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

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

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

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

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

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

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

Reset Method (IPWorks3DS_Server Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks3ds_server_do_reset($res);

Remarks

This method clears all properties to their default values.

ResetTransactionInfo Method (IPWorks3DS_Server Class)

Resets transaction specific information.

Object Oriented Interface

public function doResetTransactionInfo();

Procedural Interface

ipworks3ds_server_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 a Browser-Based flow the following are reset:

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

SendAuthRequest Method (IPWorks3DS_Server Class)

Sends the authentication request to the directory server.

Object Oriented Interface

public function doSendAuthRequest();

Procedural Interface

ipworks3ds_server_do_sendauthrequest($res);

Remarks

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

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

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

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

App-Based Flow

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

Browser-Based Flow

Before calling this method, first check the cached card-range data to determine if a 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 True to indicate that SPC is supported by the 3DS Requestor.

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

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

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

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

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

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

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

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

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

CardRange Event (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function fireCardRange($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 1, array($this, 'fireCardRange'));

Parameter List

 'rangestart'
 'rangeend'
 'rangeaction'
 'acsstartprotocolversion'
 'acsendprotocolversion'
 'dsstartprotocolversion'
 'dsendprotocolversion'
 'threedsmethodurl'
 'acsinformationindicator'
 'valid'

Remarks

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

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

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

CardRangeData Event (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function fireCardRangeData($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 2, array($this, 'fireCardRangeData'));

Parameter List

 'rangeaction'
 'issuercountrycode'
 'dsprotocolversions'
 'status'

Remarks

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

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

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

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

DataPacketIn Event (IPWorks3DS_Server Class)

Fired when receiving a data packet from the server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 3, 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_Server Class)

Fired when sending a data packet to the server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 4, 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.

DSURL Event (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function fireDSURL($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 5, array($this, 'fireDSURL'));

Parameter List

 'threedsservertodsurl'
 'dscountrycode'

Remarks

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

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

Error Event (IPWorks3DS_Server Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 6, 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_Server Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 7, 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"

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

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

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

MessageExtension Event (IPWorks3DS_Server Class)

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

Object Oriented Interface

public function fireMessageExtension($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 8, array($this, 'fireMessageExtension'));

Parameter List

 'name'
 'id'
 'data'
 'critical'
 'recognized'

Remarks

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

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

SSLServerAuthentication Event (IPWorks3DS_Server Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (IPWorks3DS_Server Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks3ds_server_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (Server Class)

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

Server Config Settings

SSL Config Settings

Trappable Errors (Server Class)

Server 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