FDMSRegister Module

Properties   Methods   Events   Config Settings   Errors  

The FDMSRegister module is a tool used to Register and Activate a merchant account with the Datawire VXN. This allows you to send transactions through the Datawire system to the First Data Merchant Services (FDMS) processor. This module is also used to find the appropriate URLs to which authorizations and settlements will be posted.

Syntax

DPaymentsSDK.Fdmsregister

Remarks

The FDMSRegister class is a tool used to Register and Activate a merchant account with the Datawire VXN. This class communicates with the Datawire VXN transaction transport network, and allows you to set up your account so that credit card transactions made with the FDMSECommerce, FDMSRetail, and FDMSSettle classs will pass through Datawire and ultimately reach the First Data Merchant Services (FDMS) transaction processor. Before you can charge a single credit card, you must Register and Activate your FDMS account, and then run a ServiceDiscovery to find acceptable URLs, which you will ultimately use to send credit card authorizations.

The first thing you must do is Register your merchant account. First Data Merchant Services will provide you with a MerchantNumber and a MerchantTerminalNumber, which are required for registering with Datawire. If you are registering on the Rapid Connect platform you must also set the GroupId configuration setting. In addition, you will need to set the TransactionNumber with a unique value (the TransactionNumber should be incremented for each transaction you send to the Datawire VXN). The example below also sets the URL to point to the Datawire test server.

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" //FDMSRegister.Config("GroupId=FDMS_Assigned_GroupId"); //Rapid Connect Only FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register()

If the registration was successful, the DatawireStatus will contain "OK", and the DatawireId will contain the new Id which you must save and send with every subsequent transaction. The PrimaryDiscoveryURL and SecondaryDiscoveryURL properties will also be filled after a successful authorization. These URLs should be saved for later, and used to perform ServiceDiscovery.

After registering, you must immediately Activate the merchant. If you wait too long, your registration will time out, and you will have to contact Datawire to have them reset your account so that you may register again. When activating the merchant, the same properties are required as for the Register method, with the addition of the DatawireId property. Since the call to Register filled the DatawireId property with the correct value, all we need to do now is:

FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

After registering and activating the account, you may now move on to Service Discovery. The Register method will return both a PrimaryDiscoveryURL and a SecondaryDiscoveryURL. Use these URLs with the ServiceDiscovery method to retrieve a list of valid transaction URLs. For instance:

FDMSRegister.ServiceDiscovery("https://staging1.datawire.net/sd")

After a successful ServiceDiscovery the DatawireStatus will be "OK". The discovered URLs will be listed in the ServiceProviders array property. At this time, you should Ping each of these URLs and sort them in order of fastest to slowest response time. You will use the URL with the fastest response time to authorize transactions with FDMSRetail or FDMSECommerce. If the first URL stops responding, you should remove the URL and switch to the next URL in the list. The following example shows how to ping each of the ServiceProviders (you must save and sort the results yourself).

For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

If your list of servers becomes empty, perform ServiceDiscovery and the subsequent steps to re-populate the list of available servers.

You may now use the DatawireId and the Service Provider URLs retrieved by this class to submit transactions using the FDMSECommerce, FDMSRetail, and FDMSSettle classs.

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.

ApplicationId Property (FDMSRegister Module)

Identifies the merchant application to the Datawire System.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=applicationId,setter=setApplicationId:) NSString* applicationId;

- (NSString*)applicationId;
- (void)setApplicationId :(NSString*)newApplicationId;

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments SDK, and is used for credit card transactions. To provision a merchant on the SVDot Closed Loop Gift Card System, use "IBIZINTGRGIFTXML" instead. You will then be able to use the FDMSGiftCard class to make transactions.

To provision a merchant for the Rapid Connect platform, use "RAPIDCONNECTSRS" instead.

Note, you may be required by FDMS or Datawire to have a new ApplicationId assigned for the software you create with this class.

DatawireId Property (FDMSRegister Module)

Identifies the merchant to the Datawire System.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=datawireId,setter=setDatawireId:) NSString* datawireId;

- (NSString*)datawireId;
- (void)setDatawireId :(NSString*)newDatawireId;

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister class). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

DatawireReturnCode Property (FDMSRegister Module)

Contains an error code providing more details about the DatawireStatus received.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)datawireReturnCode;

Default Value

""

Remarks

When a registration transaction has been successfully processed by the Datawire VXN, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". The following is a list of possible Datawire return codes:

This property is read-only.

DatawireStatus Property (FDMSRegister Module)

Status of the communication with Datawire.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)datawireStatus;

Default Value

""

Remarks

When a registration transaction has been successfully processed by the Datawire VXN, the DatawireStatus will be "OK" and the DatawireReturnCode will be "000". The following is a list of possible Datawire response status codes:

This property is read-only.

FDMSPlatform Property (FDMSRegister Module)

Specifies the FDMS platform that the transactions will be processed on.

Syntax

• Swift
• Objective-C

public var fdmsPlatform: FdmsregisterFDMSPlatforms {
  get {...}
  set {...}
}

public enum FdmsregisterFDMSPlatforms: Int32 {
  case fpNorth = 0
  case fpNashville = 1
  case fpOmaha = 2
  case fpRapidConnect = 3
}

@property (nonatomic,readwrite,assign,getter=FDMSPlatform,setter=setFDMSPlatform:) int FDMSPlatform;

- (int)FDMSPlatform;
- (void)setFDMSPlatform :(int)newFDMSPlatform;

Default Value

0

Remarks

This property is used to identify the FDMS platform that the transactions will be sent to and processed on. The following table lists the platforms supported by this class.

MerchantNumber Property (FDMSRegister Module)

A unique number used to identify the merchant within the FDMS and Datawire systems.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantNumber,setter=setMerchantNumber:) NSString* merchantNumber;

- (NSString*)merchantNumber;
- (void)setMerchantNumber :(NSString*)newMerchantNumber;

Default Value

""

Remarks

This property contains a unique number (typically 12 digits) which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS and Datawire systems, and is used along with the MerchantTerminalNumber and DatawireId as connection credentials.

MerchantTerminalNumber Property (FDMSRegister Module)

Used to identify a unique terminal within a merchant location.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantTerminalNumber,setter=setMerchantTerminalNumber:) NSString* merchantTerminalNumber;

- (NSString*)merchantTerminalNumber;
- (void)setMerchantTerminalNumber :(NSString*)newMerchantTerminalNumber;

Default Value

""

Remarks

This property contains a number (typically 6 digits) assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber and DatawireId as connection credentials.

PingResponseTime Property (FDMSRegister Module)

Returned after calling the Ping method.

Syntax

• Swift
• Objective-C

public var pingResponseTime: Int32 {
  get {...}
}

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

- (int)pingResponseTime;

Default Value

0

Remarks

The PingResponseTime contains the total transaction time, in milliseconds, it took for the transaction to reach the Datawire server identified by the URL passed to the Ping method. This time includes only the time the transaction spent between pinged Datawire server and the FDMS host. This property is filled after calling the Ping method. For instance:

FDMSRegister.ServiceDiscovery("https://staging1.datawire.net/sd") For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

Note: This property does not apply to Rapid Connect implementations.

This property is read-only.

PrimaryDiscoveryURL Property (FDMSRegister Module)

URL to use with the ServiceDiscovery method to retrieve a list of service provider URLs.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)primaryDiscoveryURL;

Default Value

""

Remarks

For the North, Nashville, and Omaha platforms: This property is filled after a successful call to the Register method. This URL should be saved, as it will be needed to perform ServiceDiscovery after you Register and Activate your account. Service Discovery should be tried first with the PrimaryDiscoveryURL. If no response is received or you are unable to connect to the primary URL, you should then attempt Service Discovery with the SecondaryDiscoveryURL instead.

This property is read-only.

Proxy Property (FDMSRegister 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

"https://support.datawire.net/production_expresso/SRS.do"

Remarks

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

SecondaryDiscoveryURL Property (FDMSRegister Module)

URL to use with the ServiceDiscovery method to retrieve a list of service provider URLs.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)secondaryDiscoveryURL;

Default Value

""

Remarks

For the North, Nashville, and Omaha platforms: This property is filled after a successful call to the Register method. This URL should be saved, as it will be needed to perform ServiceDiscovery after you Register and Activate your account. Service Discovery should be tried first with the PrimaryDiscoveryURL. If no response is received or you are unable to connect to the primary URL, you should then attempt Service Discovery with the SecondaryDiscoveryURL instead.

This property is read-only.

ServiceProvidersCount Property (FDMSRegister Module)

The number of records in the ServiceProviders array.

Syntax

• Swift
• Objective-C

public var serviceProvidersCount: Int32 {
  get {...}
}

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

- (int)serviceProvidersCount;

Default Value

0

Remarks

This property is read-only.

ServiceProviders Property (FDMSRegister Module)

Array containing a list of URLs which may be used to send credit card transactions to.

Syntax

• Swift
• Objective-C

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

- (NSString*)serviceProviders:(int)serviceProvidersIndex;

Default Value

"0"

Remarks

For the North, Nashville, and Omaha platforms: This property is populated after a call to the ServiceDiscovery method, and contains a list of Service Provider URLs necessary to transport transactions from the application, through the Datawire VXN, then to the FDMS payment processor and back. You should Ping each of these URLs to determine which one has the shortest PingResponseTime, and use that URL for all subsequent credit card transactions.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

For the Rapid Connect platform: This property is populated after a call to the Register method and contains a list of Service Provider URLs necessary to transport transactions from the application, through the Datawire VXN, then to the FDMS payment processor and back.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

This property is read-only.

SSLAcceptServerCertEncoded Property (FDMSRegister Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

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

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@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

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (FDMSRegister Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

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

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@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 is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (FDMSRegister Module)

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

Syntax

• Swift
• Objective-C

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

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

SSLCertStorePassword Property (FDMSRegister Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

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

Default Value

""

Remarks

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

SSLCertStoreType Property (FDMSRegister Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: FdmsregisterSSLCertStoreTypes {
  get {...}
  set {...}
}

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

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

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (FDMSRegister Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (FDMSRegister Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: FdmsregisterSSLProviders {
  get {...}
  set {...}
}

public enum FdmsregisterSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (FDMSRegister Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

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

public var sslServerCertEncodedB: Data {
  get {...}
}

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

- (NSString*)SSLServerCertEncoded;

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

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (FDMSRegister 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 Timeout is set to a positive value, and an operation cannot be completed immediately, the class will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

TransactionNumber Property (FDMSRegister Module)

Uniquely identifies the transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=transactionNumber,setter=setTransactionNumber:) NSString* transactionNumber;

- (NSString*)transactionNumber;
- (void)setTransactionNumber :(NSString*)newTransactionNumber;

Default Value

""

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

For all classs except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, and nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

URL Property (FDMSRegister Module)

Location of the Datawire server to which transactions are sent.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL;

- (NSString*)URL;
- (void)setURL :(NSString*)newURL;

Default Value

"https://support.datawire.net/production_expresso/SRS.do"

Remarks

This URL is used by the Register and Activate methods to provision the merchant. The following URLs are available for use:

For the Rapid Connect platform, URL will be populated after a successful ServiceDiscovery request.

Activate Method (FDMSRegister Module)

Activates a merchant account on the Datawire VXN.

Syntax

• Swift
• Objective-C

public func activate() throws -> Void

- (void)activate;

Remarks

After you have successfully registered, you will still not be able to send transactions using the Datawire VXN until you activate your account. For the security reasons, a merchant is required to activate within a limited time period after receiving a successful registration response. Otherwise, the Datawire VXN will deactivate the account and you will need to restart the registration process again.

North, Nashville, and Omaha:

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

Rapid Connect:

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

Config Method (FDMSRegister 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.

Interrupt Method (FDMSRegister 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.

Ping Method (FDMSRegister Module)

Used to find the fastest service provider to use to send credit card transactions.

Syntax

• Swift
• Objective-C

public func ping(url: String) throws -> Void

- (void)ping:(NSString*)url;

Remarks

The Ping request is used to determine which one of the ServiceProviders URLs is the most efficient to use for transaction transport. The Ping request verifies that the ServiceProviders URLs are reachable and provides the average transaction time cost for each URL, returned in the PingResponseTime property. You should select the fastest ServiceProviders URL to be the active URL that you will use to process all transactions. You should maintain a list of the other ServiceProviders URLs in a queue from fastest to slowest, in the event that the fastest URL becomes unavailable.

A Ping should be sent for each of the ServiceProviders URLs after every 100 authorizations, to ensure that you're still using the fastest URL. A Ping should be run on the ServiceProviders URLs any time the application is first started.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

Note: This functionaly does not apply to Rapid Connect implementations.

Register Method (FDMSRegister Module)

Registers a merchant account on the Datawire VXN.

Syntax

• Swift
• Objective-C

public func registerUser() throws -> Void

- (void)register;

Remarks

For the North, Nashville, and Omaha platforms: FDMS will supply you with a MerchantNumber, MerchantTerminalNumber, and Datawire will supply the URL to use to register your merchant. After setting the above properties, call the Register method. The Register method will send the registration request to Datawire, and will continue to poll the Datawire servers until a response is received. This may take several seconds, or even several minutes.

When the registration is complete, the registration response returns the merchant's DatawireId, and the PrimaryDiscoveryURL and SecondaryDiscoveryURL needed to perform ServiceDiscovery. Once received, these parameters must be saved permanently so that they can be reloaded and configured when necessary and are never lost due to power outages.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

For the Rapid Connect platform: ServiceDiscovery will need to be performed first. After a successful ServiceDiscovery call, URL will be populated with the URL required to provision your merchant account. Once TransactionNumber and ApplicationId are set, Register can be called. The Register method will send the registration request to Datawire, and will continue to poll the Datawire servers until a response is received. This may take several seconds, or even several minutes.

When the registration is complete, the registration response returns the merchant's DatawireId, and the PrimaryDiscoveryURL and SecondaryDiscoveryURL needed to process transactions. Once received, these parameters must be saved permanently so that they can be reloaded and configured when necessary and are never lost due to power outages.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

Reset Method (FDMSRegister 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.

ServiceDiscovery Method (FDMSRegister Module)

Retrieves transaction URLs from Datawire.

Syntax

• Swift
• Objective-C

public func serviceDiscovery(url: String) throws -> Void

- (void)serviceDiscovery:(NSString*)url;

Remarks

Service Discovery is the means by which you retrieve the actual transaction URLs, used for making credit card authorizations and sending batch settlements.

For the North, Nashville, and Omaha platforms: The response to a successful call to the Register method will return a PrimaryDiscoveryURL and SecondaryDiscoveryURL. After the account has been activated, call the ServiceDiscovery method with either of these URLs as the URL parameter. A successful ServiceDiscovery will provide a list of Service Provider URL's necessary to transport transactions from the application through the Datawire VXN to the FDMS payment processor and back. This list of URL's returned will be stored in the ServiceProviders array property. You should Ping each of these URLs to determine which one has the shortest PingResponseTime, and use that URL for subsequent credit card transactions (note that you should re-Ping each of the URLs received in the ServiceProviders array every 100 transactions, and when first initializing your software).

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.TransactionNumber = "0000001V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do" FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000002V002500" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate() FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL) For i = 0 To FDMSRegister.ServiceProvidersCount - 1 FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]) Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime) Next

For the Rapid Connect platform: ServiceDiscovery will be the first step in provisioning a merchant. FDMS will supply you with a MerchantNumber, MerchantTerminalNumber, and GroupId. After setting these properties, ServiceDiscovery should be called. The default URL, when URL parameter is set to "" (empty string), is "https://prod.dw.us.fdcnet.biz/sd/srsxml.rc". A successful ServiceDiscovery will provide the URL, accessible via URL, necessary to provision a merchant account.

For example:

FDMSRegister.MerchantNumber = "000000999990" FDMSRegister.MerchantTerminalNumber = "555555" FDMSRegister.Config("GroupId=10001") FDMSRegister.TransactionNumber = "0000001VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.ServiceDiscovery("https://prod.dw.us.fdcnet.biz/sd/srsxml.rc") FDMSRegister.ApplicationId = "RAPIDCONNECTSRS" FDMSRegister.TransactionNumber = "0000002VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Register() FDMSRegister.TransactionNumber = "0000003VRC1234" 'any unique number will do; check TransactionNumber property for format FDMSRegister.Activate()

Connected Event (FDMSRegister Module)

This event is fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSRegister Module)

Fired when receiving a data packet from the transaction 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 parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (FDMSRegister Module)

Fired when sending a data packet to the transaction 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 parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (FDMSRegister Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (FDMSRegister Module)

Fired when information is available 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. Normally the class .

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

SSLServerAuthentication Event (FDMSRegister 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 (FDMSRegister 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.

Status Event (FDMSRegister Module)

Shows the progress of the FDMS/Datawire connection.

Syntax

• Swift
• Objective-C

func onStatus(message: String)

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

Remarks

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

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

Config Settings (FDMSRegister Module)

FDMSRegister Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSRegister Module)

FDMSRegister Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors