FDMSOmahaRetail Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSOmahaRetail class is used to perform Credit, Debit, or EBT card transactions in a Retail environment, where the customer is purchasing products or services in person.

Class Name

DPaymentsSDK_FDMSOmahaRetail

Procedural Interface

 dpaymentssdk_fdmsomaharetail_open();
 dpaymentssdk_fdmsomaharetail_close($res);
 dpaymentssdk_fdmsomaharetail_register_callback($res, $id, $function);
 dpaymentssdk_fdmsomaharetail_get_last_error($res);
 dpaymentssdk_fdmsomaharetail_get_last_error_code($res);
 dpaymentssdk_fdmsomaharetail_set($res, $id, $index, $value);
 dpaymentssdk_fdmsomaharetail_get($res, $id, $index);
 dpaymentssdk_fdmsomaharetail_do_authonly($res);
 dpaymentssdk_fdmsomaharetail_do_config($res, $configurationstring);
 dpaymentssdk_fdmsomaharetail_do_debitrefund($res);
 dpaymentssdk_fdmsomaharetail_do_debitvoidtransaction($res, $detailaggregate);
 dpaymentssdk_fdmsomaharetail_do_ebtbalanceinquiry($res);
 dpaymentssdk_fdmsomaharetail_do_ebtcashwithdrawal($res);
 dpaymentssdk_fdmsomaharetail_do_getdetailaggregate($res);
 dpaymentssdk_fdmsomaharetail_do_interrupt($res);
 dpaymentssdk_fdmsomaharetail_do_onlinerefund($res);
 dpaymentssdk_fdmsomaharetail_do_reset($res);
 dpaymentssdk_fdmsomaharetail_do_sale($res);
 dpaymentssdk_fdmsomaharetail_do_salevoid($res, $detailaggregate);

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 FDMSOmahaRetail component makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) 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: FDMSOmahaRetail.MerchantNumber = "123456789123456" FDMSOmahaRetail.MerchantTerminalID = "XXX01" FDMSOmahaRetail.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 Credit Card transactions) or decremented (for Debit/EBT Card transactions) for each transaction you send. TransactionAmount is the amount of sale formatted with two decimal places. FDMSOmahaRetail.BatchNumber = 1 FDMSOmahaRetail.TransactionNumber = 1 FDMSOmahaRetail.TransactionAmount = "1.00"

Now for Credit Card transactions, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing Track1, and for these cards you may use Track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with Track1 data. FDMSOmahaRetail.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?" FDMSOmahaRetail.Card.EntryDataSource = edsTrack1

For Debit Card transactions, set the Track2 Card data along with the DebitPIN and DebitKSN. Additionally you will need to set the TransactionNumber as Debit/EBT transactions start at 999 and decrement after each successful transaction. FDMSOmahaRetail.TransactionNumber = 999 FDMSOmahaRetail.Card.EntryDataSource = edsTrack2 FDMSOmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001" FDMSOmahaRetail.DebitKSN = "876543210A005611119" FDMSOmahaRetail.DebitPIN = "8741F3581F20D1D1"

For EBT Card transactions, first set the EBTPaymentType to the card type being used. Then set the Track2 Card data along with the DebitPIN and DebitKSN. Additionally you will need to set the TransactionNumber as Debit/EBT transactions start at 999 and decrement after each successful transaction. FDMSOmahaRetail.TransactionNumber = 998 FDMSOmahaRetail.EBTPaymentType = etCashBenefits FDMSOmahaRetail.Card.EntryDataSource = edsTrack2 FDMSOmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001" FDMSOmahaRetail.DebitKSN = "876543210A005611119" FDMSOmahaRetail.DebitPIN = "8741F3581F20D1D1"

Finally, submit the transaction by calling Sale. The following code demonstrates a purchase: FDMSOmahaRetail.Sale()

For Credit Card transactions only, you can use the AuthOnly transaction.

For Debit and EBT transactions, the DebitRefund method can also be called.

For EBT transactions only, the EBTBalanceInquiry and EBTCashWithdrawal can be called.

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, DebitRefund, or EBTCashWithdrawal 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ApplicationId Property (DPaymentsSDK_FDMSOmahaRetail Class)

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();


public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 1 );


dpaymentssdk_fdmsomaharetail_set($res, 1, $value );

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

Data Type

String

BatchNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getBatchNumber();


public function setBatchNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 2 );


dpaymentssdk_fdmsomaharetail_set($res, 2, $value );

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

Data Type

Integer

CardType Property (DPaymentsSDK_FDMSOmahaRetail Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 3 );


dpaymentssdk_fdmsomaharetail_set($res, 3, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_FDMSOmahaRetail Class)

Three digit security code on back of card (optional).

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 4 );


dpaymentssdk_fdmsomaharetail_set($res, 4, $value );

Default Value

''

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_FDMSOmahaRetail Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 5 );


dpaymentssdk_fdmsomaharetail_set($res, 5, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_FDMSOmahaRetail Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 6 );


dpaymentssdk_fdmsomaharetail_set($res, 6, $value );

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_FDMSOmahaRetail Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 7 );


dpaymentssdk_fdmsomaharetail_set($res, 7, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_FDMSOmahaRetail Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 8 );


dpaymentssdk_fdmsomaharetail_set($res, 8, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_FDMSOmahaRetail Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface

public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 9 );


dpaymentssdk_fdmsomaharetail_set($res, 9, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_FDMSOmahaRetail Class)

Track data read off of the card's magnetic stripe.

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 10 );


dpaymentssdk_fdmsomaharetail_set($res, 10, $value );

Default Value

''

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

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.

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 11 );


dpaymentssdk_fdmsomaharetail_set($res, 11, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

ClientRef Property (DPaymentsSDK_FDMSOmahaRetail Class)

Uniquely identifies the transaction within the Datawire system.

Object Oriented Interface

public function getClientRef();


public function setClientRef($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 12 );


dpaymentssdk_fdmsomaharetail_set($res, 12, $value );

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

Data Type

String

CustomerCode Property (DPaymentsSDK_FDMSOmahaRetail Class)

Merchant-assigned customer code.

Object Oriented Interface

public function getCustomerCode();


public function setCustomerCode($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 13 );


dpaymentssdk_fdmsomaharetail_set($res, 13, $value );

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.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSOmahaRetail Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();


public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 14 );


dpaymentssdk_fdmsomaharetail_set($res, 14, $value );

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

Data Type

String

DebitCashBackAmount Property (DPaymentsSDK_FDMSOmahaRetail Class)

Optional cash back amount to return to the customer.

Object Oriented Interface

public function getDebitCashBackAmount();


public function setDebitCashBackAmount($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 15 );


dpaymentssdk_fdmsomaharetail_set($res, 15, $value );

Default Value

''

Remarks

This property contains the total dollar-and-cent amount ($$$.��) of cash back to return to the customer. This value is only used for Debit and EBT transactions.

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

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

Data Type

String

DebitKSN Property (DPaymentsSDK_FDMSOmahaRetail Class)

Clear-text Key Sequence Number, used for Debit and EBT transactions.

Object Oriented Interface

public function getDebitKSN();


public function setDebitKSN($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 16 );


dpaymentssdk_fdmsomaharetail_set($res, 16, $value );

Default Value

''

Remarks

A 19 or 20-byte Key Sequence Number (KSN) and associated DebitPIN are required for all Debit Sale and DebitRefund transactions. These values must be retrieved from a certified DUKPT DES pin pad device. A 20-byte Key Sequence Number consists of a 1-byte pad character ('F'), a 9-byte Base Derivation Key Id (BDK ID), a 5-byte device Id, and a 5-byte transaction counter. If this property is set with a Key Sequence Number less than 20 bytes in length, the class will pad it on the left with 'F' characters.

The DebitPIN and DebitKSN are not used for Food Stamp Voucher transactions.

Data Type

String

DebitPIN Property (DPaymentsSDK_FDMSOmahaRetail Class)

DUKPT DES encrypted PIN block, used for Debit and EBT transactions.

Object Oriented Interface

public function getDebitPIN();


public function setDebitPIN($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 17 );


dpaymentssdk_fdmsomaharetail_set($res, 17, $value );

Default Value

''

Remarks

A 16-byte encrypted PIN block and associated DebitKSN are required for all Debit Sale and DebitRefund transactions. The value of this property must be retrieved from a certified DUKPT DES pin pad device.

The DebitPIN and DebitKSN are not used for Food Stamp Voucher transactions.

Data Type

String

DeviceId Property (DPaymentsSDK_FDMSOmahaRetail Class)

POS Device Identification.

Object Oriented Interface

public function getDeviceId();


public function setDeviceId($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 18 );


dpaymentssdk_fdmsomaharetail_set($res, 18, $value );

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.

Data Type

String

EBTPaymentType Property (DPaymentsSDK_FDMSOmahaRetail Class)

Indicates the type of EBT transaction to process.

Object Oriented Interface

public function getEBTPaymentType();


public function setEBTPaymentType($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 19 );


dpaymentssdk_fdmsomaharetail_set($res, 19, $value );

Default Value

0

Remarks

This property is used to specify the type of EBT transaction to send.

The default value is etNotApplicable which is used for Credit or Debit card purchases.

Data Type

Integer

EBTVoucherCode Property (DPaymentsSDK_FDMSOmahaRetail Class)

Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.

Object Oriented Interface

public function getEBTVoucherCode();


public function setEBTVoucherCode($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 20 );


dpaymentssdk_fdmsomaharetail_set($res, 20, $value );

Default Value

''

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by FDMS or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear, just send a normal Sale or Credit transaction with the EBTVoucherCode and EBTVoucherNumber properties set.

Note: Voucher transactions are only sent because of a POS System or EBT Network unavailable condition.

Data Type

String

EBTVoucherNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.

Object Oriented Interface

public function getEBTVoucherNumber();


public function setEBTVoucherNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 21 );


dpaymentssdk_fdmsomaharetail_set($res, 21, $value );

Default Value

''

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by FDMS or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear, just send a normal Sale or Credit transaction with the EBTVoucherCode and EBTVoucherNumber properties set.

Note: Voucher transactions are only sent because of a POS System or EBT Network unavailable condition.

Data Type

String

InvoiceNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Merchant-defined invoice number.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 22 );


dpaymentssdk_fdmsomaharetail_set($res, 22, $value );

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.

Data Type

String

LocalHost Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 23 );


dpaymentssdk_fdmsomaharetail_set($res, 23, $value );

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

Data Type

String

LocalPort Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 24 );


dpaymentssdk_fdmsomaharetail_set($res, 24, $value );

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

Data Type

Integer

MerchantNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getMerchantNumber();


public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 25 );


dpaymentssdk_fdmsomaharetail_set($res, 25, $value );

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.

Data Type

String

MerchantTerminalID Property (DPaymentsSDK_FDMSOmahaRetail Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalID();


public function setMerchantTerminalID($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 26 );


dpaymentssdk_fdmsomaharetail_set($res, 26, $value );

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.

Data Type

String

OperatorID Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getOperatorID();


public function setOperatorID($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 27 );


dpaymentssdk_fdmsomaharetail_set($res, 27, $value );

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.

Data Type

String

OrderNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Merchant-defined number identifying the purchase or service.

Object Oriented Interface

public function getOrderNumber();


public function setOrderNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 28 );


dpaymentssdk_fdmsomaharetail_set($res, 28, $value );

Default Value

''

Remarks

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

The maximum length is 25 characters.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 29 );


dpaymentssdk_fdmsomaharetail_set($res, 29, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 30 );


dpaymentssdk_fdmsomaharetail_set($res, 30, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 31 );


dpaymentssdk_fdmsomaharetail_set($res, 31, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 32 );


dpaymentssdk_fdmsomaharetail_set($res, 32, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 33 );


dpaymentssdk_fdmsomaharetail_set($res, 33, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 34 );


dpaymentssdk_fdmsomaharetail_set($res, 34, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 35 );


dpaymentssdk_fdmsomaharetail_set($res, 35, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

RemoteHost Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getRemoteHost();


public function setRemoteHost($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 36 );


dpaymentssdk_fdmsomaharetail_set($res, 36, $value );

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

Data Type

String

RemotePort Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getRemotePort();


public function setRemotePort($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 37 );


dpaymentssdk_fdmsomaharetail_set($res, 37, $value );

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

Data Type

Integer

ResponseAuthCode Property (DPaymentsSDK_FDMSOmahaRetail Class)

The Authorization Code returned from the server after a successful transaction authorization.

Object Oriented Interface

public function getResponseAuthCode();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 38 );

Default Value

''

Remarks

The Authorization Code returned from the server after a successful transaction authorization.

Note: The value in this field is parsed from ResponseText.

The value returned in this field is required to perform a Capture or when performing an AuthOnly VoidTransaction request.

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

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_FDMSOmahaRetail Class)

When supporting partial authorizations, this is the amount actually charged to the credit card.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 39 );

Default Value

''

Remarks

When supporting partial authorizations, this is the amount actually charged to the credit card.

This is only used when supporting partial authorizations. This will be less than the original TransactionAmount. You must collect the remainder via another form of payment, or Void the authorization if the customer does not have an additional form of payment.

This property is read-only.

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_FDMSOmahaRetail Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 40 );

Default Value

''

Remarks

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below.

Valid AVS Codes:

If supporting international transactions, six additional International Address Verification Service (IAVS) codes are introduced:

This property is read-only.

Data Type

String

ResponseBalance Property (DPaymentsSDK_FDMSOmahaRetail Class)

Contains the remaining available balance left on the card.

Object Oriented Interface

public function getResponseBalance();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 41 );

Default Value

''

Remarks

Contains the remaining available balance left on the card.

The balance amount is returned by the Issuer when AllowPartialAuths is set to '1' or '3' for Sale transactions.

In the case that the balance is negative, the balance amount will contain a "-" character.

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

Data Type

String

ResponseBatchNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Number identifying the batch assigned by the POS device.

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 42 );

Default Value

0

Remarks

Number identifying the batch assigned by the POS device.

This property is read-only.

Data Type

Integer

ResponseCommercialCard Property (DPaymentsSDK_FDMSOmahaRetail Class)

Indicates whether the credit card charged is a corporate commercial card.

Object Oriented Interface

public function getResponseCommercialCard();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 43 );

Default Value

0

Remarks

Indicates whether the credit card charged is a corporate commercial card. In some cases, additional data is required to be sent for the transaction to be processed as a commercial card.

The available values are:

Note when a octReviseTax, octReviseCode, or octReviseTaxCode response is received, the transaction must be revised specifying the requested information (either Sales Tax, Customer Code, or both) to qualify as a Level 2 transaction. Revising a transaction is accomplished via the FDMSOmahaDetailRecord component and setting the TransactionType to ottRevise.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (DPaymentsSDK_FDMSOmahaRetail Class)

Contains the returned CVV result code (if CVV data was sent in the request).

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 44 );

Default Value

''

Remarks

Contains the returned CVV result code (if CVV data was sent in the request).

If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDebitCardTypeNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

The number of the debit network through which the debit card was processed.

Object Oriented Interface

public function getResponseDebitCardTypeNumber();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 45 );

Default Value

''

Remarks

The number of the debit network through which the debit card was processed.

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

Data Type

String

ResponseDebitNetwork Property (DPaymentsSDK_FDMSOmahaRetail Class)

The name of the network through which the debit card was processed.

Object Oriented Interface

public function getResponseDebitNetwork();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 46 );

Default Value

''

Remarks

The name of the network through which the debit card was processed.

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

Data Type

String

ResponseEBTResponseCode Property (DPaymentsSDK_FDMSOmahaRetail Class)

The response code sent by the network that processed the transaction.

Object Oriented Interface

public function getResponseEBTResponseCode();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 47 );

Default Value

''

Remarks

The response code sent by the network that processed the transaction.

This field will contain the response code sent by the network that processed the EBT transaction.

The available response codes are:

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

Data Type

String

ResponseRequestedAmount Property (DPaymentsSDK_FDMSOmahaRetail Class)

The amount entered at the Point of Sale device to be authorized.

Object Oriented Interface

public function getResponseRequestedAmount();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 48 );

Default Value

''

Remarks

The amount entered at the Point of Sale device to be authorized.

This property is read-only.

Data Type

String

ResponseReturnedACI Property (DPaymentsSDK_FDMSOmahaRetail Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 49 );

Default Value

''

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status.

The following is a list of all returned ACI values. Please note that many of these return values result from features not available in any of the currently supported Industry Types.

This property is read-only.

Data Type

String

ResponseRevisionNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Revision number of the online transaction.

Object Oriented Interface

public function getResponseRevisionNumber();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 50 );

Default Value

0

Remarks

Revision number of the online transaction.

This property is read-only.

Data Type

Integer

ResponseSuccess Property (DPaymentsSDK_FDMSOmahaRetail Class)

Determines whether the transaction was successful.

Object Oriented Interface

public function getResponseSuccess();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 51 );

Default Value

false

Remarks

Determines whether the transaction was successful.

This field can be queried to determine whether the transaction was successful.

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

Data Type

Boolean

ResponseText Property (DPaymentsSDK_FDMSOmahaRetail Class)

Message from the Host describing the transaction.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 52 );

Default Value

''

Remarks

Message from the Host describing the transaction.

Below are some of the common message responses from the Host.

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

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_FDMSOmahaRetail Class)

Contains the Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 53 );

Default Value

''

Remarks

Contains the Transaction Identifier or MasterCard Reference Number.

This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.

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

Data Type

String

ResponseTransactionNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

Number of the transaction in the batch as specified by the Point of Sale device.

Object Oriented Interface

public function getResponseTransactionNumber();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 54 );

Default Value

0

Remarks

Number of the transaction in the batch as specified by the Point of Sale device.

This property is read-only.

Data Type

Integer

ShipToZipCode Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getShipToZipCode();


public function setShipToZipCode($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 55 );


dpaymentssdk_fdmsomaharetail_set($res, 55, $value );

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.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSOmahaRetail Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 57 );


dpaymentssdk_fdmsomaharetail_set($res, 57, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_FDMSOmahaRetail Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 85 );


dpaymentssdk_fdmsomaharetail_set($res, 85, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 101 );


dpaymentssdk_fdmsomaharetail_set($res, 101, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

The following 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).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 102 );


dpaymentssdk_fdmsomaharetail_set($res, 102, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_FDMSOmahaRetail Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 103 );


dpaymentssdk_fdmsomaharetail_set($res, 103, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 104 );


dpaymentssdk_fdmsomaharetail_set($res, 104, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DPaymentsSDK_FDMSOmahaRetail Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 112 );


dpaymentssdk_fdmsomaharetail_set($res, 112, $value );

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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_FDMSOmahaRetail Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 114 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

SurchargeAmount Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getSurchargeAmount();


public function setSurchargeAmount($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 141 );


dpaymentssdk_fdmsomaharetail_set($res, 141, $value );

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.

Data Type

String

TaxAmount Property (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function getTaxAmount();


public function setTaxAmount($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 142 );


dpaymentssdk_fdmsomaharetail_set($res, 142, $value );

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.

Data Type

String

Timeout Property (DPaymentsSDK_FDMSOmahaRetail Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 143 );


dpaymentssdk_fdmsomaharetail_set($res, 143, $value );

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

Data Type

Integer

TPPID Property (DPaymentsSDK_FDMSOmahaRetail Class)

Third Party Processor Identifier assigned by FDMS.

Object Oriented Interface

public function getTPPID();


public function setTPPID($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 144 );


dpaymentssdk_fdmsomaharetail_set($res, 144, $value );

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.

Data Type

String

TransactionAmount Property (DPaymentsSDK_FDMSOmahaRetail Class)

Purchase amount to be charged to the cardholders account.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 145 );


dpaymentssdk_fdmsomaharetail_set($res, 145, $value );

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.

Data Type

String

TransactionNumber Property (DPaymentsSDK_FDMSOmahaRetail Class)

The transaction number for the current transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 146 );


dpaymentssdk_fdmsomaharetail_set($res, 146, $value );

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.

Data Type

Integer

URL Property (DPaymentsSDK_FDMSOmahaRetail Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 147 );


dpaymentssdk_fdmsomaharetail_set($res, 147, $value );

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

Data Type

String

VisaIdentifier Property (DPaymentsSDK_FDMSOmahaRetail Class)

Additional merchant identification field used when authorizing Visa transactions.

Object Oriented Interface

public function getVisaIdentifier();


public function setVisaIdentifier($value);

Procedural Interface

dpaymentssdk_fdmsomaharetail_get($res, 148 );


dpaymentssdk_fdmsomaharetail_set($res, 148, $value );

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:

Data Type

String

AuthOnly Method (DPaymentsSDK_FDMSOmahaRetail Class)

Sends an Authorization Only request.

Object Oriented Interface

public function doAuthOnly();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_authonly($res);

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DebitRefund Method (DPaymentsSDK_FDMSOmahaRetail Class)

Sends a Refund request for a Debit or EBT card.

Object Oriented Interface

public function doDebitRefund();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_debitrefund($res);

Remarks

This method sends a Debit/EBT 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.

For Debit Card refunds, 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 Track2 card data or card number, DebitKSN and DebitPIN. For Food Stamp Voucher transactions, you will need to set EBTVoucherCode and EBTVoucherNumber rather than DebitKSN and DebitPIN. OmahaRetail.TransactionNumber = 999 OmahaRetail.TransactionAmount = "1.00" OmahaRetail.Card.EntryDataSource = edsTrack2 OmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001" OmahaRetail.DebitKSN = "876543210A005611119" OmahaRetail.DebitPIN = "8741F3581F20D1D1" OmahaRetail.DebitRefund() 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.

DebitVoidTransaction Method (DPaymentsSDK_FDMSOmahaRetail Class)

Sends a void request for a previous debit card transaction.

Object Oriented Interface

public function doDebitVoidTransaction($detailaggregate);

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_debitvoidtransaction($res, $detailaggregate);

Remarks

This method is used to void a Debit Card transaction.

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

EBTBalanceInquiry Method (DPaymentsSDK_FDMSOmahaRetail Class)

Sends a Balance Inquiry request for EBT.

Object Oriented Interface

public function doEBTBalanceInquiry();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_ebtbalanceinquiry($res);

Remarks

This method sends an EBT Balance Inquiry request to the FDMS transaction processor, which returns the account balance via ResponseBalance. If the Balance Inquiry request was successful, ResponseSuccess will be True.

OmahaRetail.Card.EntryDataSource = edsManualEntryTrack2Capable OmahaRetail.Card.Number = "5076899999999999" OmahaRetail.Card.ExpMonth = 12 OmahaRetail.Card.ExpYear = 2049 OmahaRetail.DebitKSN = "876543210A005611119" OmahaRetail.DebitPIN = "8741F3581F20D1D1" OmahaRetail.EBTBalanceInquiry()

EBTCashWithdrawal Method (DPaymentsSDK_FDMSOmahaRetail Class)

Sends a withdrawal request for EBT Cash Benefit cards.

Object Oriented Interface

public function doEBTCashWithdrawal();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_ebtcashwithdrawal($res);

Remarks

This method sends a withdrawal (cash only) request to the FDMS transaction processor for the amount specified within DebitCashBackAmount. This method is only available for EBT Cash Benefit cards (when EBTPaymentType is set to etCashBenefits). If the Cash Withdrawal request was successful, ResponseSuccess will be True. OmahaRetail.EBTPaymentType = etCashBenefits OmahaRetail.Card.EntryDataSource = edsManualEntryTrack2Capable OmahaRetail.Card.Number = "5076899999999999" OmahaRetail.Card.ExpMonth = 12 OmahaRetail.Card.ExpYear = 2049 OmahaRetail.DebitKSN = "876543210A005611119" OmahaRetail.DebitPIN = "8741F3581F20D1D1" OmahaRetail.TransactionAmount = "5.00" OmahaRetail.EBTCashWithdrawal()

GetDetailAggregate Method (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_getdetailaggregate($res);

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 fails with an error.

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

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_interrupt($res);

Remarks

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

OnlineRefund Method (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function doOnlineRefund();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_onlinerefund($res);

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

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_reset($res);

Remarks

This method clears all properties to their default values.

Sale Method (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_sale($res);

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

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

Object Oriented Interface

public function doSaleVoid($detailaggregate);

Procedural Interface

dpaymentssdk_fdmsomaharetail_do_salevoid($res, $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 (DPaymentsSDK_FDMSOmahaRetail Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 '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 (DPaymentsSDK_FDMSOmahaRetail Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 2, array($this, 'fireDataPacketIn'));

Parameter List

 'datapacket'

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (DPaymentsSDK_FDMSOmahaRetail Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 3, array($this, 'fireDataPacketOut'));

Parameter List

 'datapacket'

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the 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 (DPaymentsSDK_FDMSOmahaRetail Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 '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 (DPaymentsSDK_FDMSOmahaRetail Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (DPaymentsSDK_FDMSOmahaRetail Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_FDMSOmahaRetail Class)

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_fdmsomaharetail_register_callback($res, 8, array($this, 'fireStatus'));

Parameter List

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

Config Settings (FDMSOmahaRetail Class)

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

FDMSOmahaRetail Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors