Server Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorks3DS.Server

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:

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

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 CardRangesMethodURL is defined for the card range, this method should be used to prepare data to be sent via the cardholder's browser to the CardRangesMethodURL.

If the CardRangesMethodURL 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 CardRangesMethodURL.

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

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

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

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

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

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

Response Handling

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

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

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

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

The following properties are applicable after calling this method:

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

Response Handling - App-Based Flow

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

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

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

Response Handling - Browser-Based Flow

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

See the GetChallengeRequest method for more details.

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

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

SPC-Based Authentication

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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"

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

Method List

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

Event List

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

Config Settings

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

AcceptLanguage Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var acceptLanguage: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=acceptLanguage,setter=setAcceptLanguage:) NSString* acceptLanguage;

- (NSString*)acceptLanguage;
- (void)setAcceptLanguage :(NSString*)newAcceptLanguage;

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.

AccountType Property (Server Module)

Indicates the type of account.

Syntax

• Swift
• Objective-C

public var accountType: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accountType,setter=setAccountType:) NSString* accountType;

- (NSString*)accountType;
- (void)setAccountType :(NSString*)newAccountType;

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:

AcquirerBIN Property (Server Module)

Acquiring institution identification code.

Syntax

• Swift
• Objective-C

public var acquirerBIN: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=acquirerBIN,setter=setAcquirerBIN:) NSString* acquirerBIN;

- (NSString*)acquirerBIN;
- (void)setAcquirerBIN :(NSString*)newAcquirerBIN;

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.

AcquirerCountryCode Property (Server Module)

Acquirer Country Code.

Syntax

• Swift
• Objective-C

public var acquirerCountryCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=acquirerCountryCode,setter=setAcquirerCountryCode:) NSString* acquirerCountryCode;

- (NSString*)acquirerCountryCode;
- (void)setAcquirerCountryCode :(NSString*)newAcquirerCountryCode;

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.

AcquirerMerchantId Property (Server Module)

Acquirer-assigned merchant identifier.

Syntax

• Swift
• Objective-C

public var acquirerMerchantId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=acquirerMerchantId,setter=setAcquirerMerchantId:) NSString* acquirerMerchantId;

- (NSString*)acquirerMerchantId;
- (void)setAcquirerMerchantId :(NSString*)newAcquirerMerchantId;

Default Value

""

Remarks

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

ACSProtocolInfos Property (Server Module)

A collection of protocol versions and other associated information supported by the ACS for a card range.

Syntax

• Swift
• Objective-C

public var acsProtocolInfos: Array<ACSProtocolInfo> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=ACSProtocolInfoCount) int ACSProtocolInfoCount;

- (int)ACSProtocolInfoCount;

- (NSString*)ACSProtocolInfoIndicator:(int)aCSProtocolInfoIndex;

- (NSString*)ACSProtocolInfoProtocolVersion:(int)aCSProtocolInfoIndex;

- (NSString*)ACSProtocolInfoSupportedMsgExt:(int)aCSProtocolInfoIndex;

- (NSString*)ACSProtocolInfoThreeDSMethodURL:(int)aCSProtocolInfoIndex;

Default Value

""

Remarks

A list of information returned when retrieving card ranges using the RequestCardRanges method.

Each card range will include information including the Protocol Version supported by the ACS for the card range, the 3DS Method URL, supported extensions, and other additional information from the ACS.

This field is only applicable when MessageVersion is 2.3.1.

This property is read-only.

ACSURL Property (Server Module)

URL of the ACS to be used for the challenge.

Syntax

• Swift
• Objective-C

public var acsurl: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=ACSURL,setter=setACSURL:) NSString* ACSURL;

- (NSString*)ACSURL;
- (void)setACSURL :(NSString*)newACSURL;

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.

AuthenticationECI Property (Server Module)

Value to be passed in the authorization message.

Syntax

• Swift
• Objective-C

public var authenticationECI: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=authenticationECI) NSString* authenticationECI;

- (NSString*)authenticationECI;

Default Value

""

Remarks

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

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

This property is read-only.

AuthenticationIndicator Property (Server Module)

3DS Requestor Authentication Indicator.

Syntax

• Swift
• Objective-C

public var authenticationIndicator: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authenticationIndicator,setter=setAuthenticationIndicator:) NSString* authenticationIndicator;

- (NSString*)authenticationIndicator;
- (void)setAuthenticationIndicator :(NSString*)newAuthenticationIndicator;

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:

AuthenticationValue Property (Server Module)

Used to provide proof of authentication.

Syntax

• Swift
• Objective-C

public var authenticationValue: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=authenticationValue) NSString* authenticationValue;

- (NSString*)authenticationValue;

Default Value

""

Remarks

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

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

This property is read-only.

BillingAddress Property (Server Module)

The customer's billing address.

Syntax

• Swift
• Objective-C

public var billingAddress: AddressInfo {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=billingAddressCity,setter=setBillingAddressCity:) NSString* billingAddressCity;

- (NSString*)billingAddressCity;
- (void)setBillingAddressCity :(NSString*)newBillingAddressCity;

@property (nonatomic,readwrite,assign,getter=billingAddressCountry,setter=setBillingAddressCountry:) NSString* billingAddressCountry;

- (NSString*)billingAddressCountry;
- (void)setBillingAddressCountry :(NSString*)newBillingAddressCountry;

@property (nonatomic,readwrite,assign,getter=billingAddressLine1,setter=setBillingAddressLine1:) NSString* billingAddressLine1;

- (NSString*)billingAddressLine1;
- (void)setBillingAddressLine1 :(NSString*)newBillingAddressLine1;

@property (nonatomic,readwrite,assign,getter=billingAddressLine2,setter=setBillingAddressLine2:) NSString* billingAddressLine2;

- (NSString*)billingAddressLine2;
- (void)setBillingAddressLine2 :(NSString*)newBillingAddressLine2;

@property (nonatomic,readwrite,assign,getter=billingAddressLine3,setter=setBillingAddressLine3:) NSString* billingAddressLine3;

- (NSString*)billingAddressLine3;
- (void)setBillingAddressLine3 :(NSString*)newBillingAddressLine3;

@property (nonatomic,readwrite,assign,getter=billingAddressPostalCode,setter=setBillingAddressPostalCode:) NSString* billingAddressPostalCode;

- (NSString*)billingAddressPostalCode;
- (void)setBillingAddressPostalCode :(NSString*)newBillingAddressPostalCode;

@property (nonatomic,readwrite,assign,getter=billingAddressState,setter=setBillingAddressState:) NSString* billingAddressState;

- (NSString*)billingAddressState;
- (void)setBillingAddressState :(NSString*)newBillingAddressState;

 

Default Value

""

Remarks

This property specifies details about the customer's billing address. This should be set before calling SendAuthRequest.

This property is read-only.

BrowserAcceptHeader Property (Server Module)

HTTP accept header sent from the cardholder's browser.

Syntax

• Swift
• Objective-C

public var browserAcceptHeader: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserAcceptHeader,setter=setBrowserAcceptHeader:) NSString* browserAcceptHeader;

- (NSString*)browserAcceptHeader;
- (void)setBrowserAcceptHeader :(NSString*)newBrowserAcceptHeader;

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.

BrowserIPAddress Property (Server Module)

IP address of the cardholder's browser.

Syntax

• Swift
• Objective-C

public var browserIPAddress: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserIPAddress,setter=setBrowserIPAddress:) NSString* browserIPAddress;

- (NSString*)browserIPAddress;
- (void)setBrowserIPAddress :(NSString*)newBrowserIPAddress;

Default Value

""

Remarks

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

BrowserJavaEnabledVal Property (Server Module)

Ability of the cardholder's browser to execute Java.

Syntax

• Swift
• Objective-C

public var browserJavaEnabledVal: ServerBrowserJavaEnabledVals {
  get {...}
  set {...}
}

public enum ServerBrowserJavaEnabledVals: Int32 {
  case jeNotPresent = 0
  case jeTrue = 1
  case jeFalse = 2
}

@property (nonatomic,readwrite,assign,getter=browserJavaEnabledVal,setter=setBrowserJavaEnabledVal:) int browserJavaEnabledVal;

- (int)browserJavaEnabledVal;
- (void)setBrowserJavaEnabledVal :(int)newBrowserJavaEnabledVal;

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:

BrowserJavaScriptEnabledVal Property (Server Module)

Ability of the cardholder's browser to execute JavaScript.

Syntax

• Swift
• Objective-C

public var browserJavaScriptEnabledVal: ServerBrowserJavaScriptEnabledVals {
  get {...}
  set {...}
}

public enum ServerBrowserJavaScriptEnabledVals: Int32 {
  case bjeNotPresent = 0
  case bjeTrue = 1
  case bjeFalse = 2
}

@property (nonatomic,readwrite,assign,getter=browserJavaScriptEnabledVal,setter=setBrowserJavaScriptEnabledVal:) int browserJavaScriptEnabledVal;

- (int)browserJavaScriptEnabledVal;
- (void)setBrowserJavaScriptEnabledVal :(int)newBrowserJavaScriptEnabledVal;

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:

BrowserLanguage Property (Server Module)

The cardholder's browser language.

Syntax

• Swift
• Objective-C

public var browserLanguage: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserLanguage,setter=setBrowserLanguage:) NSString* browserLanguage;

- (NSString*)browserLanguage;
- (void)setBrowserLanguage :(NSString*)newBrowserLanguage;

Default Value

""

Remarks

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

BrowserScreenColorDepth Property (Server Module)

The screen color depth of the cardholder's browser.

Syntax

• Swift
• Objective-C

public var browserScreenColorDepth: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserScreenColorDepth,setter=setBrowserScreenColorDepth:) NSString* browserScreenColorDepth;

- (NSString*)browserScreenColorDepth;
- (void)setBrowserScreenColorDepth :(NSString*)newBrowserScreenColorDepth;

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.

BrowserScreenHeight Property (Server Module)

The screen height of the cardholder's browser.

Syntax

• Swift
• Objective-C

public var browserScreenHeight: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserScreenHeight,setter=setBrowserScreenHeight:) NSString* browserScreenHeight;

- (NSString*)browserScreenHeight;
- (void)setBrowserScreenHeight :(NSString*)newBrowserScreenHeight;

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.

BrowserScreenWidth Property (Server Module)

The screen width of the cardholder's browser.

Syntax

• Swift
• Objective-C

public var browserScreenWidth: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserScreenWidth,setter=setBrowserScreenWidth:) NSString* browserScreenWidth;

- (NSString*)browserScreenWidth;
- (void)setBrowserScreenWidth :(NSString*)newBrowserScreenWidth;

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.

BrowserTimeZone Property (Server Module)

The timezone offset of the cardholder's browser.

Syntax

• Swift
• Objective-C

public var browserTimeZone: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserTimeZone,setter=setBrowserTimeZone:) NSString* browserTimeZone;

- (NSString*)browserTimeZone;
- (void)setBrowserTimeZone :(NSString*)newBrowserTimeZone;

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.

BrowserUserAgent Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var browserUserAgent: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=browserUserAgent,setter=setBrowserUserAgent:) NSString* browserUserAgent;

- (NSString*)browserUserAgent;
- (void)setBrowserUserAgent :(NSString*)newBrowserUserAgent;

Default Value

""

Remarks

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

CardExpDate Property (Server Module)

Expiration date of the PAN or Token.

Syntax

• Swift
• Objective-C

public var cardExpDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardExpDate,setter=setCardExpDate:) NSString* cardExpDate;

- (NSString*)cardExpDate;
- (void)setCardExpDate :(NSString*)newCardExpDate;

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.

CardholderEmail Property (Server Module)

The cardholder email address.

Syntax

• Swift
• Objective-C

public var cardholderEmail: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardholderEmail,setter=setCardholderEmail:) NSString* cardholderEmail;

- (NSString*)cardholderEmail;
- (void)setCardholderEmail :(NSString*)newCardholderEmail;

Default Value

""

Remarks

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

CardholderHomePhone Property (Server Module)

The cardholder home phone number.

Syntax

• Swift
• Objective-C

public var cardholderHomePhone: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardholderHomePhone,setter=setCardholderHomePhone:) NSString* cardholderHomePhone;

- (NSString*)cardholderHomePhone;
- (void)setCardholderHomePhone :(NSString*)newCardholderHomePhone;

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"
  }

CardholderMobilePhone Property (Server Module)

The cardholder mobile phone number.

Syntax

• Swift
• Objective-C

public var cardholderMobilePhone: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardholderMobilePhone,setter=setCardholderMobilePhone:) NSString* cardholderMobilePhone;

- (NSString*)cardholderMobilePhone;
- (void)setCardholderMobilePhone :(NSString*)newCardholderMobilePhone;

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"
  }

CardholderName Property (Server Module)

Name of the cardholder.

Syntax

• Swift
• Objective-C

public var cardholderName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardholderName,setter=setCardholderName:) NSString* cardholderName;

- (NSString*)cardholderName;
- (void)setCardholderName :(NSString*)newCardholderName;

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.

CardholderWorkPhone Property (Server Module)

The cardholder work phone number.

Syntax

• Swift
• Objective-C

public var cardholderWorkPhone: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardholderWorkPhone,setter=setCardholderWorkPhone:) NSString* cardholderWorkPhone;

- (NSString*)cardholderWorkPhone;
- (void)setCardholderWorkPhone :(NSString*)newCardholderWorkPhone;

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"
  }

CardNumber Property (Server Module)

Customer's account number that will be authenticated.

Syntax

• Swift
• Objective-C

public var cardNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardNumber,setter=setCardNumber:) NSString* cardNumber;

- (NSString*)cardNumber;
- (void)setCardNumber :(NSString*)newCardNumber;

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.

CardRanges Property (Server Module)

A collection of card ranges to be added to or removed from the cache.

Syntax

• Swift
• Objective-C

public var cardRanges: Array<CardRangeInfo> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=cardRangeCount) int cardRangeCount;

- (int)cardRangeCount;

- (NSString*)cardRangeACSEndProtocolVersion:(int)cardRangeIndex;

- (NSString*)cardRangeACSInformationIndicator:(int)cardRangeIndex;

- (NSString*)cardRangeACSStartProtocolVersion:(int)cardRangeIndex;

- (NSString*)cardRangeAction:(int)cardRangeIndex;

- (NSString*)cardRangeDSEndProtocolVersion:(int)cardRangeIndex;

- (NSString*)cardRangeDSStartProtocolVersion:(int)cardRangeIndex;

- (NSString*)cardRangeEnd:(int)cardRangeIndex;

- (NSString*)cardRangeMethodURL:(int)cardRangeIndex;

- (NSString*)cardRangeStart:(int)cardRangeIndex;

Default Value

""

Remarks

Card ranges may be returned from the directory server in the Preparation Response Message when the RequestCardRanges method is called. This collection will contain this information.

This property is read-only.

ChallengeWindowSize Property (Server Module)

Challenge window size.

Syntax

• Swift
• Objective-C

public var challengeWindowSize: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=challengeWindowSize,setter=setChallengeWindowSize:) int challengeWindowSize;

- (int)challengeWindowSize;
- (void)setChallengeWindowSize :(int)newChallengeWindowSize;

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.

ClientAuthRequest Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var clientAuthRequest: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=clientAuthRequest,setter=setClientAuthRequest:) NSString* clientAuthRequest;

- (NSString*)clientAuthRequest;
- (void)setClientAuthRequest :(NSString*)newClientAuthRequest;

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.

ClientAuthResponse Property (Server Module)

The authentication response for an app-based flow.

Syntax

• Swift
• Objective-C

public var clientAuthResponse: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=clientAuthResponse) NSString* clientAuthResponse;

- (NSString*)clientAuthResponse;

Default Value

""

Remarks

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

See SendAuthRequest for more details about handling the response.

This property is read-only.

DataPacketOut Property (Server Module)

Contains the data packet sent to the server.

Syntax

• Swift
• Objective-C

public var dataPacketOut: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=dataPacketOut) NSString* dataPacketOut;

- (NSString*)dataPacketOut;

Default Value

""

Remarks

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

This property is read-only.

DeviceChannel Property (Server Module)

Device channel.

Syntax

• Swift
• Objective-C

public var deviceChannel: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=deviceChannel,setter=setDeviceChannel:) NSString* deviceChannel;

- (NSString*)deviceChannel;
- (void)setDeviceChannel :(NSString*)newDeviceChannel;

Default Value

"02"

Remarks

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

Possible values include:

DirectoryServerURL Property (Server Module)

The address of the Directory Server.

Syntax

• Swift
• Objective-C

public var directoryServerURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=directoryServerURL,setter=setDirectoryServerURL:) NSString* directoryServerURL;

- (NSString*)directoryServerURL;
- (void)setDirectoryServerURL :(NSString*)newDirectoryServerURL;

Default Value

""

Remarks

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

DSSupportedProtocols Property (Server Module)

Protocol Versions supported by the DS.

Syntax

• Swift
• Objective-C

public var dsSupportedProtocols: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=DSSupportedProtocols,setter=setDSSupportedProtocols:) int DSSupportedProtocols;

- (int)DSSupportedProtocols;
- (void)setDSSupportedProtocols :(int)newDSSupportedProtocols;

Default Value

0

Remarks

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

DSURLs Property (Server Module)

A collection of Directory Server URLs to which the 3DS Server will send the AReq message.

Syntax

• Swift
• Objective-C

public var dsurLs: Array<DSURL> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=DSURLCount) int DSURLCount;

- (int)DSURLCount;

- (NSString*)DSURLCountryCode:(int)dSURLIndex;

- (NSString*)DSURLThreeDSServerToDsUrl:(int)dSURLIndex;

Default Value

""

Remarks

A list of Directory Server URLs that may be returend when retrieving card ranges using the RequestCardRanges method. These URLs may optionally be provided in case there are preferred DS URLs for some countries.

This field is only applicable when MessageVersion is 2.3.1.

This property is read-only.

ErrorPacket Property (Server Module)

The error packet.

Syntax

• Swift
• Objective-C

public var errorPacket: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=errorPacket) NSString* errorPacket;

- (NSString*)errorPacket;

Default Value

""

Remarks

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

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

This property is read-only.

Extensions Property (Server Module)

Extensions to be included in the next outgoing packet.

Syntax

• Swift
• Objective-C

public var extensions: Array<Extension> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=extensionCount,setter=setExtensionCount:) int extensionCount;

- (int)extensionCount;
- (void)setExtensionCount :(int)newExtensionCount;

- (BOOL)extensionCritical:(int)extensionIndex;
- (void)setExtensionCritical:(int)extensionIndex :(BOOL)newExtensionCritical;

- (NSString*)extensionData:(int)extensionIndex;
- (void)setExtensionData:(int)extensionIndex :(NSString*)newExtensionData;

- (NSString*)extensionId:(int)extensionIndex;
- (void)setExtensionId:(int)extensionIndex :(NSString*)newExtensionId;

- (NSString*)extensionName:(int)extensionIndex;
- (void)setExtensionName:(int)extensionIndex :(NSString*)newExtensionName;

Default Value

""

Remarks

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

Note: The maximum number of extensions is 10.

This property is read-only.

MerchantCategoryCode Property (Server Module)

Merchant category code.

Syntax

• Swift
• Objective-C

public var merchantCategoryCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantCategoryCode,setter=setMerchantCategoryCode:) NSString* merchantCategoryCode;

- (NSString*)merchantCategoryCode;
- (void)setMerchantCategoryCode :(NSString*)newMerchantCategoryCode;

Default Value

""

Remarks

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

MerchantCountryCode Property (Server Module)

Country code of the merchant.

Syntax

• Swift
• Objective-C

public var merchantCountryCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantCountryCode,setter=setMerchantCountryCode:) NSString* merchantCountryCode;

- (NSString*)merchantCountryCode;
- (void)setMerchantCountryCode :(NSString*)newMerchantCountryCode;

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.

MerchantName Property (Server Module)

Merchant name.

Syntax

• Swift
• Objective-C

public var merchantName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantName,setter=setMerchantName:) NSString* merchantName;

- (NSString*)merchantName;
- (void)setMerchantName :(NSString*)newMerchantName;

Default Value

""

Remarks

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

MessageCategory Property (Server Module)

The category of the message.

Syntax

• Swift
• Objective-C

public var messageCategory: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageCategory,setter=setMessageCategory:) NSString* messageCategory;

- (NSString*)messageCategory;
- (void)setMessageCategory :(NSString*)newMessageCategory;

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:

MessageVersion Property (Server Module)

Protocol version identifier.

Syntax

• Swift
• Objective-C

public var messageVersion: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageVersion,setter=setMessageVersion:) NSString* messageVersion;

- (NSString*)messageVersion;
- (void)setMessageVersion :(NSString*)newMessageVersion;

Default Value

"2.1.0"

Remarks

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

Possible values are:

MethodNotificationURL Property (Server Module)

The URL to which the method notification will be posted.

Syntax

• Swift
• Objective-C

public var methodNotificationURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=methodNotificationURL,setter=setMethodNotificationURL:) NSString* methodNotificationURL;

- (NSString*)methodNotificationURL;
- (void)setMethodNotificationURL :(NSString*)newMethodNotificationURL;

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.

NotificationURL Property (Server Module)

The notification URL to which the challenge response is sent.

Syntax

• Swift
• Objective-C

public var notificationURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=notificationURL,setter=setNotificationURL:) NSString* notificationURL;

- (NSString*)notificationURL;
- (void)setNotificationURL :(NSString*)newNotificationURL;

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.

Operation Property (Server Module)

Contains details received from an Operation Request Message sent from a Directory Server.

Syntax

• Swift
• Objective-C

public var operation: OperationInfo {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=operationInfoCategory) NSString* operationInfoCategory;

- (NSString*)operationInfoCategory;

@property (nonatomic,readonly,assign,getter=operationInfoDescription) NSString* operationInfoDescription;

- (NSString*)operationInfoDescription;

@property (nonatomic,readonly,assign,getter=operationInfoExpirationDate) NSString* operationInfoExpirationDate;

- (NSString*)operationInfoExpirationDate;

@property (nonatomic,readwrite,assign,getter=operationInfoMessageStatus,setter=setOperationInfoMessageStatus:) NSString* operationInfoMessageStatus;

- (NSString*)operationInfoMessageStatus;
- (void)setOperationInfoMessageStatus :(NSString*)newOperationInfoMessageStatus;

@property (nonatomic,readonly,assign,getter=operationInfoPriorTransactionId) NSString* operationInfoPriorTransactionId;

- (NSString*)operationInfoPriorTransactionId;

@property (nonatomic,readonly,assign,getter=operationInfoPriorTransactionIdType) int operationInfoPriorTransactionIdType;

- (int)operationInfoPriorTransactionIdType;

@property (nonatomic,readonly,assign,getter=operationInfoSequenceId) NSString* operationInfoSequenceId;

- (NSString*)operationInfoSequenceId;

@property (nonatomic,readwrite,assign,getter=operationInfoSequenceNumber,setter=setOperationInfoSequenceNumber:) int operationInfoSequenceNumber;

- (int)operationInfoSequenceNumber;
- (void)setOperationInfoSequenceNumber :(int)newOperationInfoSequenceNumber;

@property (nonatomic,readonly,assign,getter=operationInfoSequenceTotal) int operationInfoSequenceTotal;

- (int)operationInfoSequenceTotal;

@property (nonatomic,readonly,assign,getter=operationInfoSeverity) NSString* operationInfoSeverity;

- (NSString*)operationInfoSeverity;

 

Default Value

""

Remarks

This type contains details received from an Operation Request Message sent from a Directory Server after parsing with CheckResponse. See CheckResponse and GetOperationResponse for details on how to process a received OReq message.

This property is read-only.

Proxy Property (Server Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

This property is read-only.

PurchaseAmount Property (Server Module)

Purchase amount to be authorized.

Syntax

• Swift
• Objective-C

public var purchaseAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=purchaseAmount,setter=setPurchaseAmount:) NSString* purchaseAmount;

- (NSString*)purchaseAmount;
- (void)setPurchaseAmount :(NSString*)newPurchaseAmount;

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.

PurchaseCurrency Property (Server Module)

Identifies the type of currency used by the merchant.

Syntax

• Swift
• Objective-C

public var purchaseCurrency: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=purchaseCurrency,setter=setPurchaseCurrency:) NSString* purchaseCurrency;

- (NSString*)purchaseCurrency;
- (void)setPurchaseCurrency :(NSString*)newPurchaseCurrency;

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

PurchaseDate Property (Server Module)

The date of the transaction.

Syntax

• Swift
• Objective-C

public var purchaseDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=purchaseDate,setter=setPurchaseDate:) NSString* purchaseDate;

- (NSString*)purchaseDate;
- (void)setPurchaseDate :(NSString*)newPurchaseDate;

Default Value

""

Remarks

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

PurchaseExponent Property (Server Module)

Minor units of currency.

Syntax

• Swift
• Objective-C

public var purchaseExponent: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=purchaseExponent,setter=setPurchaseExponent:) NSString* purchaseExponent;

- (NSString*)purchaseExponent;
- (void)setPurchaseExponent :(NSString*)newPurchaseExponent;

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

Ranges Property (Server Module)

A collection of card ranges associated with the CardRangeData event.

Syntax

• Swift
• Objective-C

public var ranges: Array<Range> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=rangeCount) int rangeCount;

- (int)rangeCount;

- (NSString*)rangeEnd:(int)rangeIndex;

- (NSString*)rangeStart:(int)rangeIndex;

Default Value

""

Remarks

When card ranges are requested using MessageVersion 2.3.1, the CardRangeData event will fire for each card data object received in the Preparation Response Message (PRes). When the event fires, this property will contain the ranges for which the event information applies. Additional ACS information for the ranges will be contained in the ACSProtocolInfos property.

Each Range object includes a Start and End. Multiple card ranges can be associated with the data contained in the CardRangeData event.

This field is only applicable when MessageVersion is 2.3.1.

This property is read-only.

RecurringExpDate Property (Server Module)

Recurring expiration date.

Syntax

• Swift
• Objective-C

public var recurringExpDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recurringExpDate,setter=setRecurringExpDate:) NSString* recurringExpDate;

- (NSString*)recurringExpDate;
- (void)setRecurringExpDate :(NSString*)newRecurringExpDate;

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.

RecurringFrequency Property (Server Module)

The number of days between recurring payments.

Syntax

• Swift
• Objective-C

public var recurringFrequency: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recurringFrequency,setter=setRecurringFrequency:) NSString* recurringFrequency;

- (NSString*)recurringFrequency;
- (void)setRecurringFrequency :(NSString*)newRecurringFrequency;

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.

RequestorId Property (Server Module)

Directory server assigned 3DS Requestor identifier.

Syntax

• Swift
• Objective-C

public var requestorId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestorId,setter=setRequestorId:) NSString* requestorId;

- (NSString*)requestorId;
- (void)setRequestorId :(NSString*)newRequestorId;

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.

RequestorName Property (Server Module)

Directory server assigned 3DS Requestor name.

Syntax

• Swift
• Objective-C

public var requestorName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestorName,setter=setRequestorName:) NSString* requestorName;

- (NSString*)requestorName;
- (void)setRequestorName :(NSString*)newRequestorName;

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.

RequestorURL Property (Server Module)

3DS Requestor website or customer care site.

Syntax

• Swift
• Objective-C

public var requestorURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestorURL,setter=setRequestorURL:) NSString* requestorURL;

- (NSString*)requestorURL;
- (void)setRequestorURL :(NSString*)newRequestorURL;

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.

ResultsStatus Property (Server Module)

The status of the Results Request.

Syntax

• Swift
• Objective-C

public var resultsStatus: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=resultsStatus,setter=setResultsStatus:) int resultsStatus;

- (int)resultsStatus;
- (void)setResultsStatus :(int)newResultsStatus;

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.

ResultsURL Property (Server Module)

3DS Server URL.

Syntax

• Swift
• Objective-C

public var resultsURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=resultsURL,setter=setResultsURL:) NSString* resultsURL;

- (NSString*)resultsURL;
- (void)setResultsURL :(NSString*)newResultsURL;

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.

SDKType Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var sdkType: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SDKType,setter=setSDKType:) NSString* SDKType;

- (NSString*)SDKType;
- (void)setSDKType :(NSString*)newSDKType;

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

SerialNumber Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var serialNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=serialNumber,setter=setSerialNumber:) NSString* serialNumber;

- (NSString*)serialNumber;
- (void)setSerialNumber :(NSString*)newSerialNumber;

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.

ServerTransactionId Property (Server Module)

Server transaction identifier.

Syntax

• Swift
• Objective-C

public var serverTransactionId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=serverTransactionId,setter=setServerTransactionId:) NSString* serverTransactionId;

- (NSString*)serverTransactionId;
- (void)setServerTransactionId :(NSString*)newServerTransactionId;

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.

ShippingAddress Property (Server Module)

The customer's shipping address.

Syntax

• Swift
• Objective-C

public var shippingAddress: AddressInfo {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shippingAddressCity,setter=setShippingAddressCity:) NSString* shippingAddressCity;

- (NSString*)shippingAddressCity;
- (void)setShippingAddressCity :(NSString*)newShippingAddressCity;

@property (nonatomic,readwrite,assign,getter=shippingAddressCountry,setter=setShippingAddressCountry:) NSString* shippingAddressCountry;

- (NSString*)shippingAddressCountry;
- (void)setShippingAddressCountry :(NSString*)newShippingAddressCountry;

@property (nonatomic,readwrite,assign,getter=shippingAddressLine1,setter=setShippingAddressLine1:) NSString* shippingAddressLine1;

- (NSString*)shippingAddressLine1;
- (void)setShippingAddressLine1 :(NSString*)newShippingAddressLine1;

@property (nonatomic,readwrite,assign,getter=shippingAddressLine2,setter=setShippingAddressLine2:) NSString* shippingAddressLine2;

- (NSString*)shippingAddressLine2;
- (void)setShippingAddressLine2 :(NSString*)newShippingAddressLine2;

@property (nonatomic,readwrite,assign,getter=shippingAddressLine3,setter=setShippingAddressLine3:) NSString* shippingAddressLine3;

- (NSString*)shippingAddressLine3;
- (void)setShippingAddressLine3 :(NSString*)newShippingAddressLine3;

@property (nonatomic,readwrite,assign,getter=shippingAddressPostalCode,setter=setShippingAddressPostalCode:) NSString* shippingAddressPostalCode;

- (NSString*)shippingAddressPostalCode;
- (void)setShippingAddressPostalCode :(NSString*)newShippingAddressPostalCode;

@property (nonatomic,readwrite,assign,getter=shippingAddressState,setter=setShippingAddressState:) NSString* shippingAddressState;

- (NSString*)shippingAddressState;
- (void)setShippingAddressState :(NSString*)newShippingAddressState;

 

Default Value

""

Remarks

This property specifies details about the customer's shipping address. This should be set before calling SendAuthRequest.

This property is read-only.

SSLAcceptServerCert Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate;

- (NSString*)SSLAcceptServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate;

- (NSString*)SSLAcceptServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage;

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint;

- (NSString*)SSLAcceptServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1;

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256;

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer;

- (NSString*)SSLAcceptServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey;

- (NSString*)SSLAcceptServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable;

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer;

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey;

- (NSString*)SSLAcceptServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm;

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength;

- (int)SSLAcceptServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber;

- (NSString*)SSLAcceptServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm;

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames;

- (NSString*)SSLAcceptServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5;

- (NSString*)SSLAcceptServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1;

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256;

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage;

- (NSString*)SSLAcceptServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags;

- (int)SSLAcceptServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion;

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
 

Default Value

""

Remarks

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

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

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

This property is read-only.

SSLCert Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
 

Default Value

""

Remarks

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

This property is read-only.

SSLServerCert Property (Server Module)

The server certificate for the last established connection.

Syntax

• Swift
• Objective-C

public var sslServerCert: Certificate {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate;

- (NSString*)SSLServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate;

- (NSString*)SSLServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage;

- (NSString*)SSLServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint;

- (NSString*)SSLServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1;

- (NSString*)SSLServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256;

- (NSString*)SSLServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer;

- (NSString*)SSLServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey;

- (NSString*)SSLServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable;

- (BOOL)SSLServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer;

- (NSString*)SSLServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey;

- (NSString*)SSLServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm;

- (NSString*)SSLServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength;

- (int)SSLServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber;

- (NSString*)SSLServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm;

- (NSString*)SSLServerCertSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore;

- (NSString*)SSLServerCertStore;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB;

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType;

- (int)SSLServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames;

- (NSString*)SSLServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5;

- (NSString*)SSLServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1;

- (NSString*)SSLServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256;

- (NSString*)SSLServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage;

- (NSString*)SSLServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags;

- (int)SSLServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion;

- (NSString*)SSLServerCertVersion;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject;

- (NSString*)SSLServerCertSubject;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;
 

Default Value

""

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (Server Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

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.

TransactionStatus Property (Server Module)

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

Syntax

• Swift
• Objective-C

public var transactionStatus: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=transactionStatus) NSString* transactionStatus;

- (NSString*)transactionStatus;

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.

AddExtension Method (Server Module)

Adds an extension to the collection.

Syntax

• Swift
• Objective-C

public func addExtension(id: String, name: String, critical: Bool, data: String) throws -> Void

- (void)addExtension:(NSString*)id :(NSString*)name :(BOOL)critical :(NSString*)data;

Remarks

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

Note: The maximum number of extensions is 10.

AddRequestField Method (Server Module)

Adds a field to the data in the request.

Syntax

• Swift
• Objective-C

public func addRequestField(name: String, value: String, valueType: Int32) throws -> Void

- (void)addRequestField:(NSString*)name :(NSString*)value :(int)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 (Server Module)

Parses the specified message.

Syntax

• Swift
• Objective-C

public func checkResponse(response: String) throws -> Void

- (void)checkResponse:(NSString*)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 CardRangesMethodURL. 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

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 (Server Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (Server Module)

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

Syntax

• Swift
• Objective-C

public func getChallengeRequest() throws -> String

- (NSString*)getChallengeRequest;

Remarks

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

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

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

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

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

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

Example Form

Response Handling

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

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

GetMethodData Method (Server Module)

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

Syntax

• Swift
• Objective-C

public func getMethodData() throws -> String

- (NSString*)getMethodData;

Remarks

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

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

If the CardRangesMethodURL 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 CardRangesMethodURL.

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 (Server Module)

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

Syntax

• Swift
• Objective-C

public func getOperationResponse() throws -> String

- (NSString*)getOperationResponse;

Remarks

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

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

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

Possible values include:

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 (Server Module)

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

Syntax

• Swift
• Objective-C

public func getResultsResponse() throws -> String

- (NSString*)getResultsResponse;

Remarks

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

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

Possible values include:

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 (Server Module)

Interrupts the current action.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

RequestCardRanges Method (Server Module)

Requests card ranges from the directory server.

Syntax

• Swift
• Objective-C

public func requestCardRanges() throws -> Void

- (void)requestCardRanges;

Remarks

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

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

Results of this method should be cached in order to quickly look up information when processing transactions. It is recommended to call this method once every 24 hours at a minimum, and once per hour as a maximum to refresh the cache. The 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

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 (Server Module)

Clears all properties to their default values.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

ResetTransactionInfo Method (Server Module)

Resets transaction specific information.

Syntax

• Swift
• Objective-C

public func resetTransactionInfo() throws -> Void

- (void)resetTransactionInfo;

Remarks

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

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

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

In 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 (Server Module)

Sends the authentication request to the directory server.

Syntax

• Swift
• Objective-C

public func sendAuthRequest() throws -> Void

- (void)sendAuthRequest;

Remarks

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

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

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

• AcquirerBIN (required)
• AcquirerMerchantId (required)
• CardholderName (required)
• CardNumber (required)
• DirectoryServerURL (required)
• MerchantCategoryCode (required)
• MerchantCountryCode (required)
• MerchantName (required)
• 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 CardRangesMethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.

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

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

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

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

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

Response Handling

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

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

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

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

The following properties are applicable after calling this method:

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

Response Handling - App-Based Flow

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

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

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

Response Handling - Browser-Based Flow

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

See the GetChallengeRequest method for more details.

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

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

SPC-Based Authentication

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

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

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

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

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

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

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

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

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

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

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

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

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

CardRange Event (Server Module)

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

Syntax

• Swift
• Objective-C

func onCardRange(rangeStart: String, rangeEnd: String, rangeAction: String, acsStartProtocolVersion: String, acsEndProtocolVersion: String, dsStartProtocolVersion: String, dsEndProtocolVersion: String, threeDSMethodURL: String, acsInformationIndicator: String, valid: inout Bool)

- (void)onCardRange:(NSString*)rangeStart :(NSString*)rangeEnd :(NSString*)rangeAction :(NSString*)ACSStartProtocolVersion :(NSString*)ACSEndProtocolVersion :(NSString*)DSStartProtocolVersion :(NSString*)DSEndProtocolVersion :(NSString*)threeDSMethodURL :(NSString*)ACSInformationIndicator :(int*)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 CardRangesStart, CardRangesEnd, CardRangesAction, CardRangesACSStartProtocolVersion, CardRangesACSEndProtocolVersion, and CardRangesMethodURL properties.

CardRangeData Event (Server Module)

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

Syntax

• Swift
• Objective-C

func onCardRangeData(rangeAction: String, issuerCountryCode: String, dsProtocolVersions: Int32, status: inout Int32)

- (void)onCardRangeData:(NSString*)rangeAction :(NSString*)issuerCountryCode :(int)DSProtocolVersions :(int*)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.

DataPacketIn Event (Server Module)

Fired when receiving a data packet from the server.

Syntax

• Swift
• Objective-C

func onDataPacketIn(dataPacket: Data)

- (void)onDataPacketIn:(NSData*)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 (Server Module)

Fired when sending a data packet to the server.

Syntax

• Swift
• Objective-C

func onDataPacketOut(dataPacket: Data)

- (void)onDataPacketOut:(NSData*)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 (Server Module)

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

Syntax

• Swift
• Objective-C

func onDSURL(threeDSServerToDsUrl: String, dsCountryCode: String)

- (void)onDSURL:(NSString*)threeDSServerToDsUrl :(NSString*)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 (Server Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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 (Server Module)

Fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

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

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

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

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

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

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

MessageExtension Event (Server Module)

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

Syntax

• Swift
• Objective-C

func onMessageExtension(name: String, id: String, data: String, critical: Bool, recognized: inout Bool)

- (void)onMessageExtension:(NSString*)name :(NSString*)id :(NSString*)data :(BOOL)critical :(int*)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 (Server Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)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 (Server Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

ACSProtocolInfo Type

Contains information from the ACS regarded supported protocol versions and other associated information.

Remarks

Each ACSProtocolInfo object contains any supported . Other fields are optional.

Fields

Constructors

public init()

AddressInfo Type

This type contains address details.

Remarks

This type contains details of the cardholder's address including:

• BillingAddressCity
• BillingAddressCountry
• BillingAddressLine1
• BillingAddressLine2
• BillingAddressLine3
• BillingAddressPostalCode
• BillingAddressState

Fields

Constructors

public init()

CardRangeInfo Type

Contains a range of card numbers to be added to or removed from the cache.

Remarks

Each CardRangeInfo object contains a range of card numbers from to , and an indicating whether the range should be added to or deleted from the cache that the user is maintaining. and ranges returned from the server will always be the same length, for ease of computation. Card ranges must be added to or removed from the cache in the order they were received, otherwise the cache will become out of sync.

Fields

Constructors

public init()

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

DSURL Type

Contains a Directory Server URLs to which the 3DS Server will send the AReq message.

Remarks

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

Fields

Constructors

public init()

Extension Type

This type contains extension details.

Remarks

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

Fields

Constructors

public init()

public init(id: , name: , critical: , data: )

OperationInfo Type

This type contains operation details.

Remarks

This type contains details of the operation received in the OReq packet, including:

• BillingAddressCity

Fields

Constructors

public init()

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

Range Type

A card range associated with the CardRangeData event.

Remarks

Each Range object contains a range of card numbers from includes a to , and provides a card range associated with the current firing of the CardRangeData event. and values returned from the server will always be the same length, for ease of computation.

This property is only applicable when MessageVersion is 2.3.1.

Fields

Constructors

public init()

Config Settings (Server Module)

Server Config Settings