FDMSOmahaECommerce Module

Properties   Methods   Events   Config Settings   Errors  

The FDMSOmahaECommerce module is used to perform Credit card transactions in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet.

Syntax

DPaymentsSDK.Fdmsomahaecommerce

Remarks

This component allows for a connection to the FDMS FDMSOmaha platform via a VPN or PPP (dial-up) connection. This component can be integrated into web pages or stand-alone Point Of Sale applications.

The FDMSOmahaECommerce component makes authorizing Card-Not-Present transactions (where the customer's card is manually entered) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance: FDMSOmahaECommerce.MerchantNumber = "123456789123456" FDMSOmahaECommerce.MerchantTerminalID = "XXX01" FDMSOmahaECommerce.DeviceId = "DID1" // Optional, Merchant-Assigned

Next, set properties that contain details about the transaction. At the minimum, you must set a BatchNumber, TransactionNumber, and TransactionAmount. The TransactionNumber is a sequence number, and should be incremented for each transaction you send. TransactionAmount is the amount of sale formatted with two decimal places. Additionally you can set the DirectMarketingType to specify the transaction type you wish to process. FDMSOmahaECommerce.BatchNumber = 1 FDMSOmahaECommerce.TransactionNumber = 1 FDMSOmahaECommerce.TransactionAmount = "1.00" FDMSOmahaECommerce.DirectMarketingType = dmECommerce

Now set the credit card properties, as well as the card holder's address and zip code (the address and zip code will be checked by the FDMS servers to make sure it matches the customer's billing address). Note: card data must be manually entered. FDMSOmahaECommerce.CardEntryDataSource = edsManualEntryNoCardReader FDMSOmahaECommerce.CardNumber = "4444333322221111" FDMSOmahaECommerce.CardExpMonth = 1 FDMSOmahaECommerce.CardExpYear = 2013 FDMSOmahaECommerce.CardCVVData = "999" FDMSOmahaECommerce.CustomerAddress = "8320 Hightower" FDMSOmahaECommerce.CustomerZip = "85284"

Finally, submit the transaction by calling Sale or AuthOnly. The following code demonstrates a sale: FDMSOmahaECommerce.Sale()

When the component receives a response from the FDMS FDMSOmaha servers, the result of the authorization will be displayed in the Response properties. ResponseSuccess indicates whether the transaction was approved. The remaining properties provide additional information about the transaction.

Once a Sale transaction is approved, the DetailAggregate must be added to the FDMSOmahaBatchMgr component to be used when the batch is closed.

For AuthOnly transactions, they must first be captured via the FDMSOmahaDetailRecord component for the funds to be flagged for transfer. Once captured the DetailAggregate can then be added to the FDMSOmahaBatchMgr component to be used when the batch is closed.

After all the wanted detail records have been added to the FDMSOmahaBatchMgr component, the batch can be closed to start the settlement process and initiate the transfer of the funds.

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 (FDMSOmahaECommerce 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 FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this class.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

BatchNumber Property (FDMSOmahaECommerce Module)

Number identifying the batch (assigned by the POS device).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=batchNumber,setter=setBatchNumber:) int batchNumber;

- (int)batchNumber;
- (void)setBatchNumber :(int)newBatchNumber;

Default Value

0

Remarks

This property is used to specify the number identifying the batch that the transaction will be processed in.

This is a consecutive numbering system assigned by the POS application that identifies a batch of transactions. The batch number must increment each time a batch is successfully closed. When the batch number reaches 9, it is the responsibility of the application to recycle the batch number to 0. The Host will allow a variety of sequencing of the batch number, but you cannot have the same batch number in consecutive batches. For example: The application can close batch 2 and open the next batch with number 5, but you cannot close batch 2 then re-open batch 2 without a different batch number in between. If you should receive a message of "INV BATCH SEQ", this usually indicates the current batch number is the same as the previous batch number closed or there is a batch still open on the Host and the application is trying to process a transaction with a different batch number. If a batch is left open for more than 45 days, (45 days from the open date, not last activity date), the system will automatically purge the batch and it will not be retrievable.

Valid values: 0-9

Card Property (FDMSOmahaECommerce Module)

Contains the customer's credit card information.

Syntax

• Swift
• Objective-C

public var card: CCCard {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardType,setter=setCardType:) int cardType;

- (int)cardType;
- (void)setCardType :(int)newCardType;

@property (nonatomic,readwrite,assign,getter=cardCVVData,setter=setCardCVVData:) NSString* cardCVVData;

- (NSString*)cardCVVData;
- (void)setCardCVVData :(NSString*)newCardCVVData;

@property (nonatomic,readwrite,assign,getter=cardCVVPresence,setter=setCardCVVPresence:) int cardCVVPresence;

- (int)cardCVVPresence;
- (void)setCardCVVPresence :(int)newCardCVVPresence;

@property (nonatomic,readwrite,assign,getter=cardEntryDataSource,setter=setCardEntryDataSource:) int cardEntryDataSource;

- (int)cardEntryDataSource;
- (void)setCardEntryDataSource :(int)newCardEntryDataSource;

@property (nonatomic,readwrite,assign,getter=cardExpMonth,setter=setCardExpMonth:) int cardExpMonth;

- (int)cardExpMonth;
- (void)setCardExpMonth :(int)newCardExpMonth;

@property (nonatomic,readwrite,assign,getter=cardExpYear,setter=setCardExpYear:) int cardExpYear;

- (int)cardExpYear;
- (void)setCardExpYear :(int)newCardExpYear;

@property (nonatomic,readwrite,assign,getter=cardIsEncrypted,setter=setCardIsEncrypted:) BOOL cardIsEncrypted;

- (BOOL)cardIsEncrypted;
- (void)setCardIsEncrypted :(BOOL)newCardIsEncrypted;

@property (nonatomic,readwrite,assign,getter=cardMagneticStripe,setter=setCardMagneticStripe:) NSString* cardMagneticStripe;

- (NSString*)cardMagneticStripe;
- (void)setCardMagneticStripe :(NSString*)newCardMagneticStripe;

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

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

 

Default Value

""

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a for swiped cards, or a , , and for manually entered cards. ( indicates which set of properties will be used). See the CCCard type for more information.

ClientRef Property (FDMSOmahaECommerce Module)

Uniquely identifies the transaction within the Datawire system.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=clientRef,setter=setClientRef:) NSString* clientRef;

- (NSString*)clientRef;
- (void)setClientRef :(NSString*)newClientRef;

Default Value

""

Remarks

The ClientRef (Client Reference Number) 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.

The maximum length of this property is 14 alphanumeric characters.

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

The entire TransactionNumber must be unique within a 24 hour time period.

Note: If a value is not specified, the component will generate a value for you. The transaction id will be generated based on the current time (hour of day and minutes) along with the TransactionNumber specified. The version number is hard-coded based on the current library version which is 16.X.X (016XX0).

CustomerAddress Property (FDMSOmahaECommerce Module)

The customer's street number of the billing address.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=customerAddress,setter=setCustomerAddress:) NSString* customerAddress;

- (NSString*)customerAddress;
- (void)setCustomerAddress :(NSString*)newCustomerAddress;

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street number as it appears on their monthly statement. Only the street number is allowed in this field. Street number, street name, apartment number, city and state are not included, and the zip code is set in the CustomerZip property.

The maximum length of this configuration setting is 5 characters.

CustomerCode Property (FDMSOmahaECommerce Module)

Merchant-assigned customer code.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=customerCode,setter=setCustomerCode:) NSString* customerCode;

- (NSString*)customerCode;
- (void)setCustomerCode :(NSString*)newCustomerCode;

Default Value

""

Remarks

This property is used to specify a merchant-assigned code identifying the customer of the transaction.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

CustomerZipCode Property (FDMSOmahaECommerce Module)

Customer's zip code (or postal code if outside of the USA).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=customerZipCode,setter=setCustomerZipCode:) NSString* customerZipCode;

- (NSString*)customerZipCode;
- (void)setCustomerZipCode :(NSString*)newCustomerZipCode;

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

This field is optional and has a maximum length of 9 characters.

DatawireId Property (FDMSOmahaECommerce 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.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

DeviceId Property (FDMSOmahaECommerce Module)

POS Device Identification.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=deviceId,setter=setDeviceId:) NSString* deviceId;

- (NSString*)deviceId;
- (void)setDeviceId :(NSString*)newDeviceId;

Default Value

""

Remarks

Merchant-assigned code identifying the device at the merchant's location.

This field is required if there is one MerchantNumber assigned to more than one terminal at a merchant's location.

The maximum length of this property is 4 characters.

DirectMarketingType Property (FDMSOmahaECommerce Module)

Specifies the type of transaction to process.

Syntax

• Swift
• Objective-C

public var directMarketingType: FdmsomahaecommerceDirectMarketingTypes {
  get {...}
  set {...}
}

public enum FdmsomahaecommerceDirectMarketingTypes: Int32 {
  case dmECommerce = 0
  case dmMOTO = 1
  case dmRecurring = 2
  case dmInstallment = 3
}

@property (nonatomic,readwrite,assign,getter=directMarketingType,setter=setDirectMarketingType:) int directMarketingType;

- (int)directMarketingType;
- (void)setDirectMarketingType :(int)newDirectMarketingType;

Default Value

0

Remarks

This property is used to specify the type of direct marketing transaction you wish to process.

The following types of transactions are supported by this class:

All of these transactions are card-not-present transactions. If you wish to authorize card-present transactions, you must use the FDMSOmahaRetail class.

Note: For Installment payments, Omaha does not support specifying the Installment Number and Installment Count. Therefore it is up to the merchant to maintain this information internally. Thus the only additional requirement to send an Installment payment is to set DirectMarketingType to dmInstallment.

InvoiceNumber Property (FDMSOmahaECommerce Module)

Merchant-defined invoice number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

Default Value

""

Remarks

This property is used to specify an invoice number as defined by the merchant.

The maximum length of this property is 8 characters.

LocalHost Property (FDMSOmahaECommerce Module)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

LocalPort Property (FDMSOmahaECommerce Module)

The TCP port in the local host where the module binds.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

MerchantNumber Property (FDMSOmahaECommerce Module)

A unique number used to identify the merchant within the FDMS 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 19 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS systems, and is used along with the MerchantTerminalNumber as connection credentials.

MerchantTerminalID Property (FDMSOmahaECommerce Module)

Used to identify a unique terminal within a merchant location.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantTerminalID,setter=setMerchantTerminalID:) NSString* merchantTerminalID;

- (NSString*)merchantTerminalID;
- (void)setMerchantTerminalID :(NSString*)newMerchantTerminalID;

Default Value

""

Remarks

This nine digit property contains an ID assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber as connection credentials.

OperatorID Property (FDMSOmahaECommerce Module)

Merchant-assigned operator code identifying the operator who entered the transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=operatorID,setter=setOperatorID:) NSString* operatorID;

- (NSString*)operatorID;
- (void)setOperatorID :(NSString*)newOperatorID;

Default Value

""

Remarks

This property is used to specify the ID of the operator (such as a cashier or server) who entered the transaction.

The maximum length for this field is 4.

OrderNumber Property (FDMSOmahaECommerce Module)

Merchant-defined number identifying the purchase or service.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=orderNumber,setter=setOrderNumber:) NSString* orderNumber;

- (NSString*)orderNumber;
- (void)setOrderNumber :(NSString*)newOrderNumber;

Default Value

""

Remarks

This property is used to specify an order number to identify the purchase or service.

The maximum length is 25 characters.

Proxy Property (FDMSOmahaECommerce 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.

RemoteHost Property (FDMSOmahaECommerce Module)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=remoteHost,setter=setRemoteHost:) NSString* remoteHost;

- (NSString*)remoteHost;
- (void)setRemoteHost :(NSString*)newRemoteHost;

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

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

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

RemotePort Property (FDMSOmahaECommerce Module)

This property includes the Transmission Control Protocol (TCP) port in the remote host.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=remotePort,setter=setRemotePort:) int remotePort;

- (int)remotePort;
- (void)setRemotePort :(int)newRemotePort;

Default Value

0

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Response Property (FDMSOmahaECommerce Module)

Contains the response to an authorization request.

Syntax

• Swift
• Objective-C

public var response: FDMSOmahaResponse {
  get {...}
}

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

- (NSString*)responseAuthCode;

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

- (NSString*)responseAuthorizedAmount;

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

- (NSString*)responseAVSResult;

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

- (NSString*)responseBalance;

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

- (int)responseBatchNumber;

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

- (int)responseCommercialCard;

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

- (NSString*)responseCVVResult;

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

- (NSString*)responseDebitCardTypeNumber;

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

- (NSString*)responseDebitNetwork;

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

- (NSString*)responseEBTResponseCode;

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

- (NSString*)responseRequestedAmount;

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

- (NSString*)responseReturnedACI;

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

- (int)responseRevisionNumber;

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

- (BOOL)responseSuccess;

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

- (NSString*)responseText;

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

- (NSString*)responseTransactionId;

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

- (int)responseTransactionNumber;

 

Default Value

""

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSOmahaResponse type contains the following fields:

ShipToZipCode Property (FDMSOmahaECommerce Module)

The zip code where the purchased items will be shipped to.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=shipToZipCode,setter=setShipToZipCode:) NSString* shipToZipCode;

- (NSString*)shipToZipCode;
- (void)setShipToZipCode :(NSString*)newShipToZipCode;

Default Value

""

Remarks

This property is used to specify the zip code where the purchased items will be shipped to.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

SSLAcceptServerCertEncoded Property (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum FdmsomahaecommerceSSLCertStoreTypes: 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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

public enum FdmsomahaecommerceSSLProviders: 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 (FDMSOmahaECommerce 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

SurchargeAmount Property (FDMSOmahaECommerce Module)

Dollar-and-cent amount of the charge for the purchase.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=surchargeAmount,setter=setSurchargeAmount:) NSString* surchargeAmount;

- (NSString*)surchargeAmount;
- (void)setSurchargeAmount :(NSString*)newSurchargeAmount;

Default Value

""

Remarks

This property is optional and has a maximum length of 9 characters, the format is as follows: "-99999.99" or "+99999.99". It contains the total dollar-and-cent amount ($$$$$.cc) of the charge that the cardholder paid the merchant for the ability to perform the transaction. Position 1 contains the surcharge prefix. Positions 2-9 contain the surcharge amount.

Note: This is a reporting field only. Therefore the SurchargeAmount must be accounted for within TransactionAmount.

Note: The decimal point is required to be specified within the amount.

TaxAmount Property (FDMSOmahaECommerce Module)

Dollar-and-cent amount of tax for the purchase.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=taxAmount,setter=setTaxAmount:) NSString* taxAmount;

- (NSString*)taxAmount;
- (void)setTaxAmount :(NSString*)newTaxAmount;

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$.cc) of the tax for the purchase.

Note: This is a reporting field only. Therefore the TaxAmount must be accounted for within TransactionAmount.

Note: The decimal point is required to be specified within the amount.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

Timeout Property (FDMSOmahaECommerce 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).

TPPID Property (FDMSOmahaECommerce Module)

Third Party Processor Identifier assigned by FDMS.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=TPPID,setter=setTPPID:) NSString* TPPID;

- (NSString*)TPPID;
- (void)setTPPID :(NSString*)newTPPID;

Default Value

"V4D001"

Remarks

The Third Party Processor Identifier (TPPID. Also sometimes referred to as a "Vendor Id") is assigned by FDMS to each third party who is processing transactions. Each merchant will receive a TPPID from FDMS.

The default value for 4D Payments, Inc. on the Omaha platform is "V4D001".

A VisaIdentifier is also required for Visa transactions.

TransactionAmount Property (FDMSOmahaECommerce Module)

Purchase amount to be charged to the cardholders account.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=transactionAmount,setter=setTransactionAmount:) NSString* transactionAmount;

- (NSString*)transactionAmount;
- (void)setTransactionAmount :(NSString*)newTransactionAmount;

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$$$.cc) to be charged to the cardholders account.

The TransactionAmount should contain all additional amounts (such as taxes, tips, etc.) as those fields are for reporting purposes only and NOT added to the TransactionAmount by the host.

Note: The decimal point is required to be specified within the amount.

TransactionNumber Property (FDMSOmahaECommerce Module)

The transaction number for the current transaction.

Syntax

• Swift
• Objective-C

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

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

- (int)transactionNumber;
- (void)setTransactionNumber :(int)newTransactionNumber;

Default Value

0

Remarks

This property is used to specify the transaction number for the current transaction. The valid values are 0 - 999. A TransactionNumber of 0 is only used and MUST be used for AuthOnly transactions, thus all other transaction types must have a TransactionNumber of 1 or greater. The maximum value of TransactionNumber is 999 (note: closing a batch requires an item number and thus the actual number of transactions in a batch is 998).

If a transaction is unsuccessful the TransactionNumber should be re-used.

For Credit Card transactions, the TransactionNumber starts at 1 (provided it is not an AuthOnly transaction) and must increment with each successful transaction.

For Debit/EBT Card transactions, the TransactionNumber starts at 999 and must decrement with each successful transaction.

Note TransactionNumbers for Credit Card and Debit/EBT cards *cannot* overlap and must be unique. Additionally, there must be an open TransactionNumber for the close batch transaction. For example, you can have 1-454 for Credit Card transactions and 456-999 for Debit/EBT cards but TransactionNumber 455 must be left available for the close batch transaction.

Item numbers do NOT have to be processed in sequence (i.e. 1, 2, 3, etc.). However, when a batch is closed all transactions up to the TransactionNumber specified to close the batch must be accounted for. For example; if a batch is closed using TransactionNumber 5, transactions 1, 2, 3, and 4 MUST be accounted for. Additionally, if the batch is closed using an TransactionNumber that is not one more than the number of items in the batch, the Host will delete all records over the close TransactionNumber. For example; if a batch is closed using TransactionNumber 5, transaction records 5, 6, 7, etc. will be automatically deleted by the system.

Each transaction that posts to the Host with an TransactionNumber must keep that TransactionNumber until the batch is closed. Note: the Host accepts two or more transactions with the same TransactionNumber, but the last transaction will overwrite any previous transactions. For example, if a Sale is performed for TransactionNumber 1 and then a Credit is performed, only the Credit will post to the cardholder's account (it will be as if the Sale transaction never happened, with the exception of the reserved funds).

This property is not applicable for the ottRevise and ottVoid transaction types. Thus when GetDetailAggregate is called, the returned aggregate will contain the TransactionNumber specified within the original transaction.

Below is a table of the various transaction types and how TransactionNumber should be handled for Credit Card transactions. Note that the below table is only applicable to Credit Card transactions.

Debit/EBT cards are always performed online and thus each successful transaction should have their own unique TransactionNumber that starts at 999 and decrements by 1 for each success transaction performed.

URL Property (FDMSOmahaECommerce 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://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister class. Once you Register and Activate the merchant using the FDMSRegister class, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister class.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

VisaIdentifier Property (FDMSOmahaECommerce Module)

Additional merchant identification field used when authorizing Visa transactions.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=visaIdentifier,setter=setVisaIdentifier:) NSString* visaIdentifier;

- (NSString*)visaIdentifier;
- (void)setVisaIdentifier :(NSString*)newVisaIdentifier;

Default Value

""

Remarks

In conjunction with Visa regulatory change(s), First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). This information should be passed for all card types. Each 17-byte Visa Agent Identifier in the chain is composed of the following pieces:

AuthOnly Method (FDMSOmahaECommerce Module)

Sends an Authorization Only request.

Syntax

• Swift
• Objective-C

public func authOnly() throws -> Void

- (void)authOnly;

Remarks

This method sends an authorization only request to the FDMS transaction processor, which reserves funds from the Cardholder's available credit (Open to Buy amount). The CardEntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, ResponseSuccess will be True.

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the OmahaDetailRecord component. You will then need to set the BatchNumber, TransactionNumber, and TransactionType to ttCapture. The DetailAggregate can then be added to the DetailRecords collection of the BatchMgr component to be used when the batch is closed. OmahaRetail.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000" OmahaRetail.CardEntryDataSource = edsTrack1 OmahaRetail.AuthOnly() if (OmahaRetail.ResponseSuccess) { OmahaDetailRecord.ParseAggregate(OmahaRetail.GetDetailAggregate()); OmahaDetailRecord.BatchNumber = 1 OmahaDetailRecord.TransactionNumber = 1 OmahaDetailRecord.TransactionType = ttCapture OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaDetailRecord.GetDetailAggregate())) } Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

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

GetDetailAggregate Method (FDMSOmahaECommerce Module)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

• Swift
• Objective-C

public func getDetailAggregate() throws -> String

- (NSString*)getDetailAggregate;

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSOmahaBatchMgr class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSOmahaDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseSuccess is false) the method .

An example of how this method is used is shown below:

OmahaRetail.AuthOnly() If (OmahaRetail.ResponseSuccess = True) Then OmahaDetailRecord.ParseDetailRecord(OmahaRetail.GetDetailAggregate()) End If

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

OnlineRefund Method (FDMSOmahaECommerce Module)

Sends a Refund request for a Visa/Visa Electron Credit card.

Syntax

• Swift
• Objective-C

public func onlineRefund() throws -> Void

- (void)onlineRefund;

Remarks

This method sends a Visa Credit Card Refund (Return) request to the FDMS transaction processor, which returns funds to a Cardholder's account. If the Refund request was successful, ResponseSuccess will be True.

The CardEntryDataSource property determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. OmahaRetail.TransactionNumber = 999 OmahaRetail.TransactionAmount = "1.00" OmahaRetail.Card.EntryDataSource = edsTrack2 OmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001" OmahaRetail.OnlineRefund() if (OmahaRetail.ResponseSuccess) { OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaRetail.GetDetailAggregate())) } Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

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

Sale Method (FDMSOmahaECommerce Module)

Sends a sale request for Credit, Debit, and EBT cards. Authorizes a credit card using track1, track2, or manually entered card data.

Syntax

• Swift
• Objective-C

public func sale() throws -> Void

- (void)sale;

Remarks

This method sends a sale (authorize and capture) request to the FDMS transaction processor. The CardEntryDataSource property determines whether Track1, Track2, or a manually entered card and expiration date are sent in the request. If the Sale request was successful, ResponseSuccess will be True.

For Debit Card sales, Track2 data will need to be set as well as the DebitKSN and DebitPIN.

For EBT transactions, EBTPaymentType will need to be set as well as the DebitKSN and DebitPIN. For Food Stamp Voucher transactions, you will need to set EBTVoucherCode and EBTVoucherNumber rather than DebitKSN and DebitPIN.

After a successful sale, the DetailAggregate can then be added to the DetailRecords collection of the BatchMgr component to be used when the batch is closed. OmahaRetail.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000" OmahaRetail.CardEntryDataSource = edsTrack1 OmahaRetail.BatchNumber = 1 OmahaRetail.TransactionNumber = 1 OmahaRetail.Sale() if (OmahaRetail.ResponseSuccess) { OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaRetail.GetDetailAggregate())) } Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

SaleVoid Method (FDMSOmahaECommerce Module)

Sends an Online Void request for a previous Credit Card Sale transaction.

Syntax

• Swift
• Objective-C

public func saleVoid(detailAggregate: String) throws -> Void

- (void)saleVoid:(NSString*)detailAggregate;

Remarks

This method is used to do an Online Void of a Credit Card Sale transaction.

DetailAggregate is the full detail aggregate returned by a GetDetailAggregate call for a Credit Card transaction. FDMSOmahaRetail.SaleVoid(FDMSOmahaRetail.GetDetailAggregate())

Connected Event (FDMSOmahaECommerce 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.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

DataPacketIn Event (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

Error Event (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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 (FDMSOmahaECommerce 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.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the to indicate which track is stored in the field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the , , and fields, and must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the to edsManualEntryNoCardReader. If you wish to set any other value for the , you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of . If you set the , , and fields, but is set to edsTrack2, the class will look for data when authorizing the transaction, and will because none is present.

Fields

Constructors

public init()

public init(number: , expMonth: , expYear: )

public init(magneticStripe: , entryDataSource: )

FDMSOmahaResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the FDMSOmahaECommerce, FDMSOmahaRetail or FDMSOmahaRestaurant class. The fields contained by this type are listed below.

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

Config Settings (FDMSOmahaECommerce Module)

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

FDMSOmahaECommerce Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors