FDMSRcECommerce Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSRcECommerce class is an advanced tool used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This class makes authorizing these types of transactions very easy.

Class Name

DPaymentsSDK_FDMSRcECommerce

Procedural Interface

 dpaymentssdk_fdmsrcecommerce_open();
 dpaymentssdk_fdmsrcecommerce_close($res);
 dpaymentssdk_fdmsrcecommerce_register_callback($res, $id, $function);
 dpaymentssdk_fdmsrcecommerce_get_last_error($res);
 dpaymentssdk_fdmsrcecommerce_get_last_error_code($res);
 dpaymentssdk_fdmsrcecommerce_set($res, $id, $index, $value);
 dpaymentssdk_fdmsrcecommerce_get($res, $id, $index);
 dpaymentssdk_fdmsrcecommerce_do_authonly($res);
 dpaymentssdk_fdmsrcecommerce_do_capture($res);
 dpaymentssdk_fdmsrcecommerce_do_config($res, $configurationstring);
 dpaymentssdk_fdmsrcecommerce_do_credit($res);
 dpaymentssdk_fdmsrcecommerce_do_getdetailaggregate($res);
 dpaymentssdk_fdmsrcecommerce_do_hosttotals($res);
 dpaymentssdk_fdmsrcecommerce_do_interrupt($res);
 dpaymentssdk_fdmsrcecommerce_do_reset($res);
 dpaymentssdk_fdmsrcecommerce_do_reverse($res);
 dpaymentssdk_fdmsrcecommerce_do_sale($res);
 dpaymentssdk_fdmsrcecommerce_do_setdetailaggregate($res, $aggregate);
 dpaymentssdk_fdmsrcecommerce_do_verifycard($res);

Remarks

This class connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these classs go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the class. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated SSL servers.

The FDMSRcECommerce class makes authorizing Card-Not-Present Mail Order and E-Commerce transactions 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 class and authorizing a transaction are outlined below:

Datawire Setup

First, you must register and activate your account with Datawire. FDMS Rapid Connect will provide you with the following values:

• MerchantId
• MerchantTerminalNumber
• GroupId

The FDMSRegister class must be used to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through ServiceDiscovery, you may begin to authorize transactions. For instance:

FDMSRegister.FDMSPlatform = FdmsregisterFDMSPlatforms.fpRapidConnect; FDMSRegister.MerchantNumber = "000000999990"; FDMSRegister.MerchantTerminalNumber = "555555"; FDMSRegister.Config("GroupId=20001"); //Required for Rapid Connect FDMSRegister.TransactionNumber = "1"; //any unique number will do. FDMSRegister.URL = "https://stagingsupport.datawire.net/staging_expresso/SRS.do"; FDMSRegister.Register(); FDMSRegister.TransactionNumber = FDMSRegister.TransactionNumber + 1; FDMSRegister.Activate(); FDMSRegister.ServiceDiscovery(FDMSRegister.PrimaryDiscoveryURL); for (int i = 0; i < FDMSRegister.ServiceProviders.Length; i++) { FDMSRegister.Ping(FDMSRegister.ServiceProviders[i]); Console.WriteLine(FDMSRegister.ServiceProviders[i] + " = " + FDMSRegister.PingResponseTime); }

To authorize a credit, debit, ebt or FSA/HSA card set the MerchantId, MerchantTerminalNumber, and GroupId properties with the values supplied by FDMS Rapid Connect. Set the DatawireId property with the value retrieved by the FDMSRegister class after activating your merchant account. Set the URL property with one of the URLs you retrieved during ServiceDiscovery.

Transaction Processing

To being processing transactions first set the required merchant values. For instance: fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.MerchantURL = "mywebsite"; //Required for ECommerce transactions fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc";

Next specify transaction specific information. These values uniquely identify the transaction to Datawire and FDMS. fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "120013"; fdmsrcecommerce.OrderNumber = "12000503"; fdmsrcecommerce.ReferenceNumber = "123"; Then specify customer card and address information along with the transaction amount: fdmsrcecommerce.Card.Number = "36185900055556"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.Card.CVVData = "123"; fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road"; fdmsrcecommerce.CustomerZip = "11747"; fdmsrcecommerce.TransactionAmount = "1200"; //$12.00

Finally, submit the transaction by calling the Sale method.

fdmsrcecommerce.Sale();

The ResponseCode property indicates the result of the transaction. A code of 000 indicates success. For all other values please see the Response Codes section. Additional Response properties such as ResponseApprovalCode, ResponseAuthorizedAmount, ResponseText, ResponseAVSResult, ResponseCVVResult, and more, provide further details about the transaction response.

To perform subsequent operations on a transaction, such as calling Reverse to reverse a Sale, or calling Capture to capture a previous AuthOnly transaction the GetDetailAggregate method must be used to get details about the original transaction. This aggregate must be stored securely, it will contain cardholder information that is required for subsequent transactions. For instance:

fdmsrcecommerce.AuthOnly(); //Save the detail aggregate to use with Capture string aggregate = fdmsrcecommerce.GetDetailAggregate(); //The aggregate must then be stored securely. //At a later time the aggregate is retrieved in order to perform a capture. //Capture fdmsrcecommerce = new Fdmsrcecommerce(); ... //Specify the detail aggregate from the original transaction fdmsrcecommerce.SetDetailAggregate(aggregate); fdmsrcecommerce.Capture();

Transaction Types

In addition to a basic sale transaction, additional transaction types exist for other common operations. Not all transaction types are applicable for all classs. Check the method list for applicable transaction types.

Note: FDMS Rapid Connect is a host capture system. No explicit calls are needed to settle or otherwise manage the batch.

Level 2 Transactions

The values required for Level 2 transaction depend on the card type. The following tables indicate which properties are valid for what card type:

American Express

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DestinationPostalCode (required)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2ProductDescription (required)
• Level2PurchaseIdentifier (required)
• Level2MerchantTaxId
• Level2ShipFromPostalCode
• Level2TaxAmount
• Level2TaxIndicator

Visa

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode
• Level2MerchantTaxId

MasterCard

• Level2CustomerReferenceNumber (required if Level2TaxAmount specified)
• Level2DiscountAmount (required if discount applied)
• Level2DutyAmount (required if duty amount applied)
• Level2FreightAmount (required if freight amount applied)
• Level2MerchantTaxId (required)
• Level2PurchaseIdentifier (required)
• Level2TaxAmount (required if Level2TaxIndicator indicates tax is applied)
• Level2TaxIndicator (required)
• Level2DestinationPostalCode
• Level2ShipFromPostalCode

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

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();


public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 1 );


dpaymentssdk_fdmsrcecommerce_set($res, 1, $value );

Default Value

'NSOFTDIRECTPXML'

Remarks

The Application Id identifies the application that has generated and is sending the transaction. This is a 15 character alphanumeric code that identifies each application and is provided by the Datawire Secure Transport Vendor Integration Team

This property may be validated along with the DatawireId as connection credentials.

The default value of this property is a value used for testing with Rapid Connect. You may be required to have a new ApplicationId assigned for the software you create with this class.

Data Type

String

InstallmentDescription Property (DPaymentsSDK_FDMSRcECommerce Class)

The merchant's description of an Installment Bill Payment Transaction.

Object Oriented Interface

public function getInstallmentDescription();


public function setInstallmentDescription($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 2 );


dpaymentssdk_fdmsrcecommerce_set($res, 2, $value );

Default Value

''

Remarks

The merchant's description of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 15 characters.

Data Type

String

InstallmentInvoiceNumber Property (DPaymentsSDK_FDMSRcECommerce Class)

The Invoice Number of an Installment Bill Payment Transaction.

Object Oriented Interface

public function getInstallmentInvoiceNumber();


public function setInstallmentInvoiceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 3 );


dpaymentssdk_fdmsrcecommerce_set($res, 3, $value );

Default Value

''

Remarks

The Invoice Number of an Installment Bill Payment Transaction.

This field is only sent in an 'Installment' or 'Recurring' transaction.

The maximum length of this field is 12 characters.

Data Type

String

InstallmentType Property (DPaymentsSDK_FDMSRcECommerce Class)

The type of the Installment payment.

Object Oriented Interface

public function getInstallmentType();


public function setInstallmentType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 4 );


dpaymentssdk_fdmsrcecommerce_set($res, 4, $value );

Default Value

0

Remarks

The type of the Installment payment.

This field is required for all Discover, Diners (including JCB - US Domestic) Installment transactions TransactionIndicator value 3 (tiInstallment) and it is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

Data Type

Integer

MerchantAdviceCode Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

Object Oriented Interface

public function getMerchantAdviceCode();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 5 );

Default Value

''

Remarks

This field contains a code which may be returned by the issuer to provide additional information for a card not present transaction.

The following values are defined:

This property is read-only.

Data Type

String

MITAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

The amount of the Recurring or Installment payment.

Object Oriented Interface

public function getMITAmount();


public function setMITAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 6 );


dpaymentssdk_fdmsrcecommerce_set($res, 6, $value );

Default Value

''

Remarks

The amount of the Recurring or Installment payment.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

MITAmountType Property (DPaymentsSDK_FDMSRcECommerce Class)

Identifies the type of the Recurring or Installment Payment amount.

Object Oriented Interface

public function getMITAmountType();


public function setMITAmountType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 7 );


dpaymentssdk_fdmsrcecommerce_set($res, 7, $value );

Default Value

0

Remarks

Identifies the type of the Recurring or Installment Payment amount.

The following values are defined:

Data Type

Integer

MITFrequency Property (DPaymentsSDK_FDMSRcECommerce Class)

This property indicates the frequency of a Recurring or Installment payment.

Object Oriented Interface

public function getMITFrequency();


public function setMITFrequency($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 8 );


dpaymentssdk_fdmsrcecommerce_set($res, 8, $value );

Default Value

0

Remarks

This field indicates the frequency of a Recurring or Installment payment.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

When the Card Type is 'Discover', 'JCB', or 'Diners', the valid values are 1, 2, 3, 4, 5, 6, 7, or 8.

For Visa Recurring transactions, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12.

For Visa Installment transactions, valid values are 2, 3, or 4.

Data Type

Integer

MITPaymentCurrency Property (DPaymentsSDK_FDMSRcECommerce Class)

Contains the Installment Payment Currency represented as a 3 digit value.

Object Oriented Interface

public function getMITPaymentCurrency();


public function setMITPaymentCurrency($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 9 );


dpaymentssdk_fdmsrcecommerce_set($res, 9, $value );

Default Value

'840'

Remarks

Contains the Installment Payment Currency represented as a 3 digit value.

This field is only applicable when Card Type is 'Visa'. For US Dollars, use "840".

Data Type

String

MITRecurringPaymentType Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the type of Recurring Payment.

Object Oriented Interface

public function getMITRecurringPaymentType();


public function setMITRecurringPaymentType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 10 );


dpaymentssdk_fdmsrcecommerce_set($res, 10, $value );

Default Value

0

Remarks

This field contains the type of Recurring Payment.

This field is only applicable when Card Type is 'Visa'. The following values are defined:

Data Type

Integer

MITRegistrationRefNum Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains a unique Reference Number for the Recurring Payment transaction.

Object Oriented Interface

public function getMITRegistrationRefNum();


public function setMITRegistrationRefNum($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 11 );


dpaymentssdk_fdmsrcecommerce_set($res, 11, $value );

Default Value

''

Remarks

This field contains a unique Reference Number for the Recurring Payment transaction.

This field is only applicable when Card Type is 'Visa'.

The maximum length of this field is 35 characters.

Data Type

String

MITSequenceIndicator Property (DPaymentsSDK_FDMSRcECommerce Class)

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

Object Oriented Interface

public function getMITSequenceIndicator();


public function setMITSequenceIndicator($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 12 );


dpaymentssdk_fdmsrcecommerce_set($res, 12, $value );

Default Value

0

Remarks

Identifies the sequence of the transactions when multiple Installment payments will be submitted.

This field should be populated in ascending order and is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

Valid values for this field are numbers from 0 to 99.

Data Type

Integer

MITTotalPaymentAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the Total Installment Amount.

Object Oriented Interface

public function getMITTotalPaymentAmount();


public function setMITTotalPaymentAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 13 );


dpaymentssdk_fdmsrcecommerce_set($res, 13, $value );

Default Value

''

Remarks

This field contains the Total Installment Amount.

This field is only applicable for Visa Installment transactions. Note : The total amount cannot exceed USD 500,000.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

MITTotalPaymentCount Property (DPaymentsSDK_FDMSRcECommerce Class)

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

Object Oriented Interface

public function getMITTotalPaymentCount();


public function setMITTotalPaymentCount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 14 );


dpaymentssdk_fdmsrcecommerce_set($res, 14, $value );

Default Value

''

Remarks

The number of Recurring payments or Installments per the Cardholder agreement with the Merchant.

The following values are defined:

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'. For Discover, the valid values should be from 02 to 99, UD and UC. For Visa, the valid values should be from 01 to 99. Note: For Visa recurring payments, value of '99' means that recurring payments are authorized until canceled or that the Number of Recurring Payments is not defined.

When this field is sent for Visa or Discover (including JCB - US Domestic Only and Diners), the Bill Payment Transaction Indicator must be present with the value of 'Recurring' or 'Installment'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field can only be sent when the Installment Type field contains the value of 'Merchant' or 'ThirdParty'. For Discover (including JCB - US Domestic Only and Diners) installment transactions, this field must be sent for ALL Installment transactions for a series of payments, and the original CIT transaction must be initiated with 3DS.

The maximum length of this field is 2 characters.

Data Type

String

MITUniqueID Property (DPaymentsSDK_FDMSRcECommerce Class)

This property is used to uniquely identify each of the Recurring or Installment Payment.

Object Oriented Interface

public function getMITUniqueID();


public function setMITUniqueID($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 15 );


dpaymentssdk_fdmsrcecommerce_set($res, 15, $value );

Default Value

''

Remarks

This field is used to uniquely identify each of the Recurring or Installment Payment. This ID is used to reference authorization transactions.

This field is only applicable when Card Type is 'Discover', 'JCB' or 'Diners'.

The maximum length of this field is 14 characters.

Data Type

String

MITValidationFlag Property (DPaymentsSDK_FDMSRcECommerce Class)

Indicates the validation source for the validity of a transaction.

Object Oriented Interface

public function getMITValidationFlag();


public function setMITValidationFlag($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 16 );


dpaymentssdk_fdmsrcecommerce_set($res, 16, $value );

Default Value

0

Remarks

Indicates the validation source for the validity of a transaction.

This field is only applicable when Card Type is 'Visa', 'Discover', 'JCB', or 'Diners'.

The following values are defined:

Data Type

Integer

MITValidationRef Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

Object Oriented Interface

public function getMITValidationRef();


public function setMITValidationRef($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 17 );


dpaymentssdk_fdmsrcecommerce_set($res, 17, $value );

Default Value

''

Remarks

This field contains a cryptogram generated by the validation source for each cardholder account, for an Issuer to validate a transaction.

This field is only applicable when Card Type is 'Discover', 'JCB', or 'Diners'.

The maximum length of this field is 20 characters.

Data Type

String

TransactionIndicator Property (DPaymentsSDK_FDMSRcECommerce Class)

Specifies the type of Bill Payment being made.

Object Oriented Interface

public function getTransactionIndicator();


public function setTransactionIndicator($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 18 );


dpaymentssdk_fdmsrcecommerce_set($res, 18, $value );

Default Value

0

Remarks

Specifies the type of Bill Payment being made.

This property contains the type of bill payment being made. This is applicable to ECommerce, MOTO, and Retail transactions. Possible values are:

To settle an Installment transaction, you must use the FDMSRcDetailrecord class to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

FDMSRcECommerce.Config("BillPaymentType=3") // 3=Installment FDMSRcECommerce.TransactionAmount = "1995" FDMSRcECommerce.AuthOnly() FDMSRcDetailRecord.ParseAggregate(FDMSRcECommerce.GetDetailAggregate()) FDMSRcDetailRecord.InstallmentCount = 3 FDMSRcDetailRecord.InstallmentNumber = 1 FDMSRcSettle.DetailRecordAggregate(5) = FDMSRcDetailRecord.GetDetailAggregate()

Data Type

Integer

CardType Property (DPaymentsSDK_FDMSRcECommerce Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 19 );


dpaymentssdk_fdmsrcecommerce_set($res, 19, $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 Number 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_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 20 );


dpaymentssdk_fdmsrcecommerce_set($res, 20, $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 CVVData 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, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_FDMSRcECommerce Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 21 );


dpaymentssdk_fdmsrcecommerce_set($res, 21, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CVVData.

The class will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence 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_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 22 );


dpaymentssdk_fdmsrcecommerce_set($res, 22, $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_FDMSRcECommerce Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 23 );


dpaymentssdk_fdmsrcecommerce_set($res, 23, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in Number.

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

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 24 );


dpaymentssdk_fdmsrcecommerce_set($res, 24, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in Number.

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_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 25 );


dpaymentssdk_fdmsrcecommerce_set($res, 25, $value );

Default Value

false

Remarks

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

By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. 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 Number or MagneticStripe 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_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 26 );


dpaymentssdk_fdmsrcecommerce_set($res, 26, $value );

Default Value

''

Remarks

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

If EntryDataSource 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 EntryDataSource property to indicate which track you are sending.

The following example shows how to set the MagneticStripe and EntryDataSource 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_FDMSRcECommerce Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 27 );


dpaymentssdk_fdmsrcecommerce_set($res, 27, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

CustomerAddress Property (DPaymentsSDK_FDMSRcECommerce Class)

The customer's billing address.

Object Oriented Interface

public function getCustomerAddress();


public function setCustomerAddress($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 28 );


dpaymentssdk_fdmsrcecommerce_set($res, 28, $value );

Default Value

''

Remarks

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

The maximum length of this property is 30 characters.

If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

Data Type

String

CustomerZip Property (DPaymentsSDK_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getCustomerZip();


public function setCustomerZip($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 29 );


dpaymentssdk_fdmsrcecommerce_set($res, 29, $value );

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.

The maximum length of this property is 9 characters.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSRcECommerce Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();


public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 30 );


dpaymentssdk_fdmsrcecommerce_set($res, 30, $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.

Data Type

String

GroupId Property (DPaymentsSDK_FDMSRcECommerce Class)

The Id assigned by FDMS to identify the merchant or group of merchants.

Object Oriented Interface

public function getGroupId();


public function setGroupId($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 31 );


dpaymentssdk_fdmsrcecommerce_set($res, 31, $value );

Default Value

''

Remarks

This property specifies the FDMS assigned group Id. This Id identifies the merchant or group of merchants. This property is required.

Data Type

String

IndustryType Property (DPaymentsSDK_FDMSRcECommerce Class)

The merchant's industry type.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 32 );


dpaymentssdk_fdmsrcecommerce_set($res, 32, $value );

Default Value

0

Remarks

The merchant's industry type. Possible values are:

NOTE: TransactionType of dmtMOTO(1) cannot be used in feitEcommerce(0) IndustryType. Likewise TransactionType of dmtECommerce(0) cannot be used in feitMOTO(1) IndustryType.

Data Type

Integer

Level2CustomerReferenceNumber Property (DPaymentsSDK_FDMSRcECommerce Class)

The reference number or order number to be reported as part of the Purchase Card data.

Object Oriented Interface

public function getLevel2CustomerReferenceNumber();


public function setLevel2CustomerReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 33 );


dpaymentssdk_fdmsrcecommerce_set($res, 33, $value );

Default Value

''

Remarks

The reference number or order number to be reported as part of the Purchase Card data.

If Level2TaxAmount is specified this property is required.

The value may be up to 17 characters in length.

Data Type

String

Level2DestinationCountryCode Property (DPaymentsSDK_FDMSRcECommerce Class)

This property represents the country code of the location the items in this purchase are being delivered to.

Object Oriented Interface

public function getLevel2DestinationCountryCode();


public function setLevel2DestinationCountryCode($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 34 );


dpaymentssdk_fdmsrcecommerce_set($res, 34, $value );

Default Value

''

Remarks

This field represents the country code of the location the items in this purchase are being delivered to.

This value is the ISO 3166 three digit numeric identifier.

Data Type

String

Level2DestinationPostalCode Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

Object Oriented Interface

public function getLevel2DestinationPostalCode();


public function setLevel2DestinationPostalCode($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 35 );


dpaymentssdk_fdmsrcecommerce_set($res, 35, $value );

Default Value

''

Remarks

This property contains the postal or zip code of the location the item(s) in this purchase are being delivered to.

This property is required for American Express purchase card transactions. This is the same as the Level2ShipFromPostalCode when the customer takes possession of the items at the merchant location.

The value may be up to 9 characters.

Data Type

String

Level2DiscountAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the discount amount for the purchase.

Object Oriented Interface

public function getLevel2DiscountAmount();


public function setLevel2DiscountAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 36 );


dpaymentssdk_fdmsrcecommerce_set($res, 36, $value );

Default Value

''

Remarks

This property contains the discount amount for the purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a discount has been applied.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

Level2DutyAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the duty amount for this purchase.

Object Oriented Interface

public function getLevel2DutyAmount();


public function setLevel2DutyAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 37 );


dpaymentssdk_fdmsrcecommerce_set($res, 37, $value );

Default Value

''

Remarks

This property contains the duty amount for this purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a duty amount has been applied.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

Level2FreightAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the amount for freight included in this purchase.

Object Oriented Interface

public function getLevel2FreightAmount();


public function setLevel2FreightAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 38 );


dpaymentssdk_fdmsrcecommerce_set($res, 38, $value );

Default Value

''

Remarks

This property contains the amount for freight included in this purchase.

This property is required for Visa, MasterCard, and American Express purchase card transactions when a freight amount has been applied.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

Level2MerchantTaxId Property (DPaymentsSDK_FDMSRcECommerce Class)

This property should contain the Tax Id collected by the merchant for this transaction.

Object Oriented Interface

public function getLevel2MerchantTaxId();


public function setLevel2MerchantTaxId($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 39 );


dpaymentssdk_fdmsrcecommerce_set($res, 39, $value );

Default Value

''

Remarks

This property should contain the Tax Id collected by the merchant for this transaction.

This property is required for MasterCard purchase card transactions.

The value may be up to 15 characters in length.

Data Type

String

Level2ProductDescription Property (DPaymentsSDK_FDMSRcECommerce Class)

This property should contain a description of an item purchased with this card.

Object Oriented Interface

public function getLevel2ProductDescription();


public function setLevel2ProductDescription($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 40 );


dpaymentssdk_fdmsrcecommerce_set($res, 40, $value );

Default Value

''

Remarks

This property should contain a description of an item purchased with this card.

This property is required for American Express purchase card transactions and not applicable to other card types.

The value may be up to 40 characters in length.

Data Type

String

Level2PurchaseIdentifier Property (DPaymentsSDK_FDMSRcECommerce Class)

This property represents the data used by the merchant or customer to identify the purchase.

Object Oriented Interface

public function getLevel2PurchaseIdentifier();


public function setLevel2PurchaseIdentifier($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 41 );


dpaymentssdk_fdmsrcecommerce_set($res, 41, $value );

Default Value

''

Remarks

This property represents the data used by the merchant or customer to identify the purchase. This can be a SKU, code, or reference number.

This property is required for Visa, MasterCard, and American Express purchase card transactions.

The value may be up to 25 characters in length.

Data Type

String

Level2ShipFromPostalCode Property (DPaymentsSDK_FDMSRcECommerce Class)

The postal or zip code the item(s) in this purchase are to be shipped from.

Object Oriented Interface

public function getLevel2ShipFromPostalCode();


public function setLevel2ShipFromPostalCode($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 42 );


dpaymentssdk_fdmsrcecommerce_set($res, 42, $value );

Default Value

''

Remarks

The postal or zip code the item(s) in this purchase are to be shipped from.

The value may be up to 9 characters.

Data Type

String

Level2TaxAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

This property contains the portion of the transaction amount that represents the tax.

Object Oriented Interface

public function getLevel2TaxAmount();


public function setLevel2TaxAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 43 );


dpaymentssdk_fdmsrcecommerce_set($res, 43, $value );

Default Value

''

Remarks

This property contains the portion of the transaction amount that represents the tax.

This property is required when Level2TaxIndicator is set to 2 (tiProvided).

For Visa this is the amount of state or provincial tax included in the TransactionAmount. The tax amount must be within 0.1 % and 22% of the pre-tax transaction amount.

For MasterCard the total amount of sales tax on the total purchase must be between 0.1% and 30 % of the total pre-tax transaction amount; zeros indicate that the card acceptor is capable of transmitting the tax amount and the tax amount is zero.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

Level2TaxIndicator Property (DPaymentsSDK_FDMSRcECommerce Class)

This property indicates the taxable status of the transaction.

Object Oriented Interface

public function getLevel2TaxIndicator();


public function setLevel2TaxIndicator($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 44 );


dpaymentssdk_fdmsrcecommerce_set($res, 44, $value );

Default Value

0

Remarks

This field indicates the taxable status of the transaction. Possible values are:

Data Type

Integer

MerchantId Property (DPaymentsSDK_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getMerchantId();


public function setMerchantId($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 45 );


dpaymentssdk_fdmsrcecommerce_set($res, 45, $value );

Default Value

''

Remarks

This property holds the Merchant Id assigned by FDMS. The value is an alphanumeric value up to 16 characters in length.

This property is required.

Data Type

String

MerchantServicePhone Property (DPaymentsSDK_FDMSRcECommerce Class)

The merchant's phone number, used to assist cardholders.

Object Oriented Interface

public function getMerchantServicePhone();


public function setMerchantServicePhone($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 46 );


dpaymentssdk_fdmsrcecommerce_set($res, 46, $value );

Default Value

''

Remarks

This property specifies a 10 digit phone number which cardholders can call for assistance.

This value is required for MOTO transactions. It is recommended but not required for ecommerce and hotel transactions.

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_FDMSRcECommerce Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();


public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 47 );


dpaymentssdk_fdmsrcecommerce_set($res, 47, $value );

Default Value

''

Remarks

This property contains a number assigned by FDMS to uniquely identify a terminal within a merchant location. The value is numeric and may be up to 8 digits in length.

This property is required.

Data Type

String

MerchantURL Property (DPaymentsSDK_FDMSRcECommerce Class)

The URL of the site performing the ECommerce transaction.

Object Oriented Interface

public function getMerchantURL();


public function setMerchantURL($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 48 );


dpaymentssdk_fdmsrcecommerce_set($res, 48, $value );

Default Value

''

Remarks

This property specifies the URL of the merchant's site. This value is required for ECommerce and Hotel AuthOnly, Sale, Capture, and Credit transactions.

For Visa and Discover transactions this value is limited to 13 characters. For all other card types this value is limited to 32 characters.

Data Type

String

OrderNumber Property (DPaymentsSDK_FDMSRcECommerce Class)

A merchant assigned order number to uniquely reference the transaction.

Object Oriented Interface

public function getOrderNumber();


public function setOrderNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 49 );


dpaymentssdk_fdmsrcecommerce_set($res, 49, $value );

Default Value

''

Remarks

This property holds a merchant assigned order number that uniquely identifies the transaction. This must hold a numeric value up to 8 digits in length. This value cannot be all zeros.

This value is required for ECommerce and MOTO transactions. This value is optional for Retail transactions.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 50 );


dpaymentssdk_fdmsrcecommerce_set($res, 50, $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 User and Password properties are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.

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

If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of User and Password.

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 51 );


dpaymentssdk_fdmsrcecommerce_set($res, 51, $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_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 52 );


dpaymentssdk_fdmsrcecommerce_set($res, 52, $value );

Default Value

''

Remarks

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

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

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 53 );


dpaymentssdk_fdmsrcecommerce_set($res, 53, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 54 );


dpaymentssdk_fdmsrcecommerce_set($res, 54, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 55 );


dpaymentssdk_fdmsrcecommerce_set($res, 55, $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_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 56 );


dpaymentssdk_fdmsrcecommerce_set($res, 56, $value );

Default Value

''

Remarks

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

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

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

ReferenceNumber Property (DPaymentsSDK_FDMSRcECommerce Class)

A value assigned by the merchant to uniquely reference a transaction and any subsequent related transactions.

Object Oriented Interface

public function getReferenceNumber();


public function setReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 57 );


dpaymentssdk_fdmsrcecommerce_set($res, 57, $value );

Default Value

''

Remarks

This value is a merchant assigned 12 digit value. The value must be unique within a day for a given merchant id and terminal id. When performing a Capture or Reverse transaction this must be the same as the original transaction.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_FDMSRcECommerce Class)

The Approval Code returned from the server after a successful authorization.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 58 );

Default Value

''

Remarks

The Approval Code returned from the server after a successful authorization.

This value holds the approval code returned by the authorizer. This value will contain up to 8 characters. Only alphanumeric characters and spaces will be returned.

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

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

The amount actually charged to the card.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 59 );

Default Value

''

Remarks

The amount actually charged to the card.

This value holds the amount charged to the card. In the case of a partial authorization this will be different than the amount specified in TransactionAmount.

You must collect the remainder via another form of payment, or Reverse the authorization if the customer does not have an additional form of payment.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkId Property (DPaymentsSDK_FDMSRcECommerce Class)

This property indicates the network Id as returned by the host, if available.

Object Oriented Interface

public function getResponseAuthorizingNetworkId();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 60 );

Default Value

''

Remarks

This field indicates the network Id as returned by the host, if available.

This value is up to 3 alphanumeric characters.

This property is read-only.

Data Type

String

ResponseAuthorizingNetworkName Property (DPaymentsSDK_FDMSRcECommerce Class)

This property indicates the authorizing network name as returned by the host, when available.

Object Oriented Interface

public function getResponseAuthorizingNetworkName();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 61 );

Default Value

''

Remarks

This field indicates the authorizing network name as returned by the host, when available.

This property is read-only.

Data Type

String

ResponseAVSResult Property (DPaymentsSDK_FDMSRcECommerce Class)

Contains the Address Verification System result code.

Object Oriented Interface

public function getResponseAVSResult();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 62 );

Default Value

''

Remarks

Contains the Address Verification System result code.

This one character field contains the Address Verification System (AVS) result code. This property is populated if a value is present in the response. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. Possible AVS codes are listed in the table below.

Visa Card AVS Codes

MasterCard AVS Codes

Amex AVS Codes

Discover or JCB

This property is read-only.

Data Type

String

ResponseBalance Property (DPaymentsSDK_FDMSRcECommerce Class)

Contains the remaining available balance left on the card.

Object Oriented Interface

public function getResponseBalance();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 63 );

Default Value

''

Remarks

Contains the remaining available balance left on the card.

This balance amount will only be returned for prepaid cards.

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

Data Type

String

ResponseCardLevelResult Property (DPaymentsSDK_FDMSRcECommerce Class)

This property is only applicable to Visa card.

Object Oriented Interface

public function getResponseCardLevelResult();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 64 );

Default Value

''

Remarks

This property is only applicable to Visa card. This property holds a two character value returned by Visa to designate the type of card product used to process the transaction.

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

Data Type

String

ResponseCode Property (DPaymentsSDK_FDMSRcECommerce Class)

Contains the 3 digit response code indicating success or reason of failure.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 65 );

Default Value

''

Remarks

Contains the 3 digit response code indicating success or reason of failure.

This property contains a 3 digit code indicating success or the reason of failure. A value of 000 indicates approval. For all other values please see the Response Codes section.

This property is read-only.

Data Type

String

ResponseCommercialCard Property (DPaymentsSDK_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getResponseCommercialCard();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 66 );

Default Value

0

Remarks

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

This is only applicable to Visa cards. Visa Business, corporate, and purchasing cards are subsets of commercial cards. Therefore, the user should send Level 2 (and possibly Level 3) data when calling Capture when this property indicates a commercial card was used. The following table indicates the type of commercial card:

Note: Tax amounts should be included with the Level2 or Level3 data when calling Capture in order to receive the best interchange rate.

This property is read-only.

Data Type

Integer

ResponseCVVResult Property (DPaymentsSDK_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getResponseCVVResult();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 67 );

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. This property is populated if a value is present in the response. The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (DPaymentsSDK_FDMSRcECommerce Class)

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

Object Oriented Interface

public function getResponseDatawireReturnCode();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 68 );

Default Value

''

Remarks

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

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseApprovalCode contains the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (DPaymentsSDK_FDMSRcECommerce Class)

Status of the communication with Datawire.

Object Oriented Interface

public function getResponseDatawireStatus();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 69 );

Default Value

''

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseApprovalCode contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

ResponsePOSData Property (DPaymentsSDK_FDMSRcECommerce Class)

This property holds transaction specific information returned by the issuer (if any).

Object Oriented Interface

public function getResponsePOSData();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 71 );

Default Value

''

Remarks

This property holds transaction specific information returned by the issuer (if any). This is only applicable to MasterCard, Discover, and AmEx card transactions.

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

Data Type

String

ResponseReturnedACI Property (DPaymentsSDK_FDMSRcECommerce Class)

Returned Authorization Characteristics Indicator contains CPS qualification status.

Object Oriented Interface

public function getResponseReturnedACI();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 72 );

Default Value

''

Remarks

Returned Authorization Characteristics Indicator contains CPS qualification status.

This one character field contains the returned Authorization Characteristics Indicator (ACI) for Visa transactions. This value provides information concerning the transaction's Customer Payment Service (CPS) qualification status. It is not recommended that the Point of Sale (POS) system attempt to interpret the meaning of this value.

Possible returned ACI values are:

This property is read-only.

Data Type

String

ResponseRoutingIndicator Property (DPaymentsSDK_FDMSRcECommerce Class)

Indicates whether the transaction was processed as Credit or Debit.

Object Oriented Interface

public function getResponseRoutingIndicator();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 73 );

Default Value

''

Remarks

Indicates whether the transaction was processed as Credit or Debit. Possible values are:

This property is read-only.

Data Type

String

ResponseSettlementDate Property (DPaymentsSDK_FDMSRcECommerce Class)

The date the transaction will be settled in the format MMDD.

Object Oriented Interface

public function getResponseSettlementDate();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 74 );

Default Value

''

Remarks

The date the transaction will be settled in the format MMDD.

This property is read-only.

Data Type

String

ResponseText Property (DPaymentsSDK_FDMSRcECommerce Class)

This property may hold additional text which describes the reason for a decline, the property in error, etc.

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 75 );

Default Value

''

Remarks

This property may hold additional text which describes the reason for a decline, the field in error, etc. Applications should not be coded to the text in this property as it is subject to change.

This property is read-only.

Data Type

String

ResponseTransactionDate Property (DPaymentsSDK_FDMSRcECommerce Class)

The transaction date returned from the server in yyyyMMddHHmmss format.

Object Oriented Interface

public function getResponseTransactionDate();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 76 );

Default Value

''

Remarks

The transaction date returned from the server in yyyyMMddHHmmss format.

This 15 digit field contains the transaction date and time returned by the Rapid Connect system. This is not a local datetime, it is the time according the Rapid Connect system.

This property is read-only.

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_FDMSRcECommerce Class)

Card issuer's Transaction Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 77 );

Default Value

''

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet data, American Express Transaction Id, or Discover Network Result Indicator (NRID). If returned in the response, this property should be printed on the receipt.

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

Data Type

String

ReversalTransactionType Property (DPaymentsSDK_FDMSRcECommerce Class)

The type of transaction to reverse.

Object Oriented Interface

public function getReversalTransactionType();


public function setReversalTransactionType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 78 );


dpaymentssdk_fdmsrcecommerce_set($res, 78, $value );

Default Value

0

Remarks

This property specifies the type of transaction to reverse. Possible values are:

Data Type

Integer

ReversalType Property (DPaymentsSDK_FDMSRcECommerce Class)

The type of reversal.

Object Oriented Interface

public function getReversalType();


public function setReversalType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 79 );


dpaymentssdk_fdmsrcecommerce_set($res, 79, $value );

Default Value

0

Remarks

This property specifies the type of reversal. Possible values are:

Timeout Reversals are applicable to the following transaction types:

• AuthOnly
• Capture
• Credit
• Sale

Full Reversals are applicable to the following transaction types:

• AuthOnly
• Sale

Data Type

Integer

SettlementMode Property (DPaymentsSDK_FDMSRcECommerce Class)

Indicates whether the class uses Host Capture (0) or Terminal Capture (1) system.

Object Oriented Interface

public function getSettlementMode();


public function setSettlementMode($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 80 );


dpaymentssdk_fdmsrcecommerce_set($res, 80, $value );

Default Value

0

Remarks

Possible values are:

Host-Capture means that you authorize your transactions using the AuthOnly or Sale methods, and you process refunds and capture outstanding authorizations with the Credit and Capture methods. FDMS Rapid Connect handles all batch management.

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging IndustryType, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types may be processed in Terminal Capture mode. However, Hotel/Lodging transactions MUST be authorized and settled in Terminal Capture mode. Attempting to authorize a Hotel/Lodging transaction with the Host Capture mode will cause the class fails with an error.

Data Type

Integer

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSRcECommerce Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 82 );


dpaymentssdk_fdmsrcecommerce_set($res, 82, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_FDMSRcECommerce Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 110 );


dpaymentssdk_fdmsrcecommerce_set($res, 110, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 126 );


dpaymentssdk_fdmsrcecommerce_set($res, 126, $value );

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject 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_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 127 );


dpaymentssdk_fdmsrcecommerce_set($res, 127, $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_FDMSRcECommerce Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 128 );


dpaymentssdk_fdmsrcecommerce_set($res, 128, $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_FDMSRcECommerce 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_fdmsrcecommerce_get($res, 129 );


dpaymentssdk_fdmsrcecommerce_set($res, 129, $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_FDMSRcECommerce Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 137 );


dpaymentssdk_fdmsrcecommerce_set($res, 137, $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:

Additional Notes

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

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 139 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

STAN Property (DPaymentsSDK_FDMSRcECommerce Class)

The merchant assigned System Trace Audit Number(STAN).

Object Oriented Interface

public function getSTAN();


public function setSTAN($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 166 );


dpaymentssdk_fdmsrcecommerce_set($res, 166, $value );

Default Value

''

Remarks

This property represents a six digit number assigned by the merchant to uniquely reference the transaction. This number must be unique within a day per Merchant ID and Terminal ID.

Valid values are from 000001 to 999999 inclusive.

Data Type

String

Timeout Property (DPaymentsSDK_FDMSRcECommerce Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 167 );


dpaymentssdk_fdmsrcecommerce_set($res, 167, $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_FDMSRcECommerce Class)

Third Party Processor Identifier assigned by FDMS.

Object Oriented Interface

public function getTPPID();


public function setTPPID($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 168 );


dpaymentssdk_fdmsrcecommerce_set($res, 168, $value );

Default Value

''

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 is "" (empty string). This should be set to the FDMS assigned TPPID.

A VisaIdentifier is also required for Visa transactions.

Data Type

String

TransactionAmount Property (DPaymentsSDK_FDMSRcECommerce Class)

The transaction amount to be authorized.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 169 );


dpaymentssdk_fdmsrcecommerce_set($res, 169, $value );

Default Value

''

Remarks

This property contains the transaction amount to be authorized.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The positioning of any implied decimal point is dictated by the CurrencyCode. The default currency code is for the United States.

The maximum number of digits allowed is 12 regardless of the position of the implied decimal point. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (DPaymentsSDK_FDMSRcECommerce Class)

Uniquely identifies the transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 170 );


dpaymentssdk_fdmsrcecommerce_set($res, 170, $value );

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

URL Property (DPaymentsSDK_FDMSRcECommerce Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 171 );


dpaymentssdk_fdmsrcecommerce_set($res, 171, $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.

Data Type

String

VisaIdentifier Property (DPaymentsSDK_FDMSRcECommerce Class)

Additional merchant identification field used when authorizing Visa transactions.

Object Oriented Interface

public function getVisaIdentifier();


public function setVisaIdentifier($value);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_get($res, 172 );


dpaymentssdk_fdmsrcecommerce_set($res, 172, $value );

Default Value

''

Remarks

First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). Each Visa Agent Identifier in the chain is composed of the following pieces:

If there are multiple visa identifiers they may be added by setting VisaIdentifier with a comma-delimited list. There can be a maximum of three entries in this list.

A VisaIdentifier (Agent Identification Service - AUAR) is required for Visa transactions. A VisaIdentifier value is assigned by Visa as part of their Trusted Agent Program (TAP). Therefore it is suggested that you contact your FDMS certification analyst as they should be able to provide you with further information and put you in contact with the required party at Visa. Unfortunately more specific information on this matter cannot be provided as we do not handle live customer data and thus are not required to register in this particular program. However below is some additional information in regards to the requirements of a Visa Identifier.

Any merchant that transmits, processes, or stores cardholder data on server(s) that you own, manage, or operate on behalf of your clients (who are other merchant account holders) must meet the PCI Data Security Standard and follow additional steps to register as a service provider. Applicable services commonly include webhosting, software as a service, or collecting payment on behalf of a client. Any company providing these services must register with Visa's Third Party Agent (TAP) program.

You can register for the Visa Third Party Agent Program at http://usa.visa.com/merchants/risk_management/third-party-registration.html

If you find that you are not required to register with this program you can send all spaces for the BID and all zeros for the AUAR for instance: " 000000000000"

Data Type

String

AuthOnly Method (DPaymentsSDK_FDMSRcECommerce Class)

Performs an authorization request.

Object Oriented Interface

public function doAuthOnly();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_authonly($res);

Remarks

This method performs an authorization request. This transaction places a hold on the funds. To capture the funds the Capture method must be called.

After calling this method call GetDetailAggregate to generate a detail aggregate. The detail aggregate should be saved for use with Capture or Reverse later.

When ready to Capture or Reverse the transaction call SetDetailAggregate to the previously stored detail aggregate before calling the method.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

ECommerce AuthOnly Code Example fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "120013"; fdmsrcecommerce.OrderNumber = "12000503"; fdmsrcecommerce.ReferenceNumber = "123"; fdmsrcecommerce.Card.Number = "36185900055556"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.Card.CVVData = "123"; fdmsrcecommerce.TransactionAmount = "272000"; fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road"; fdmsrcecommerce.CustomerZip = "11747"; fdmsrcecommerce.AuthOnly(); //Save the detail aggregate to use with Capture or Reverse later string aggregate = fdmsrcecommerce.GetDetailAggregate();

Capture Method (DPaymentsSDK_FDMSRcECommerce Class)

Captures a previously authorized transaction.

Object Oriented Interface

public function doCapture();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_capture($res);

Remarks

This method captures a previously authorized transaction. Before calling this method call SetDetailAggregate to specify the detail aggregate from the original AuthOnly transaction.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

FDMS Recommendations:

Vendors/Gateways, who systematically send all Capture transactions during their end of day processing or at a specific time for their entire chain, must configure/program their systems to send the Capture transactions for all locations or merchants varying times of day based on the MerchantId or MerchantTerminalNumber (whichever provides a more random value).

To assist with implementing this logic, FDMS Rapid Connect recommends sending the Capture transactions based on the MerchantTerminalNumber in each location. For example If the last digit of the MerchantTerminalNumber is 0, set the time for the Capture transactions to be sent as xx:00 (xx=hh:00=mm). The time for the MerchantTerminalNumber ending with 1 would be xx:05. The time for the MerchantTerminalNumber ending with 2 would be xx:10. All remaining MerchantTerminalNumbers would follow this same logic. This logic would be applied across the entire chain or merchant base, to ensure that all Captures for all merchants are not systematically sent to First Data at the same time. FDMS recommends that the software calculate the offset of time based on the MerchantId or MerchantTerminalNumber, and not rely on a user to specify the time as noted above.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

ECommerce AuthOnly and Capture Code Example fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.MerchantURL = "mywebsite"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "120013"; fdmsrcecommerce.OrderNumber = "12000503"; fdmsrcecommerce.ReferenceNumber = "123"; fdmsrcecommerce.Card.Number = "36185900055556"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.Card.CVVData = "123"; fdmsrcecommerce.TransactionAmount = "272000"; fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road"; fdmsrcecommerce.CustomerZip = "11747"; fdmsrcecommerce.AuthOnly(); //Save the detail aggregate to use with Capture string aggregate = fdmsrcecommerce.GetDetailAggregate(); //Capture fdmsrcecommerce = new Fdmsrcecommerce(); fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.MerchantURL = "4dpayments"; //Required for capture fdmsrcecommerce.STAN = "113"; fdmsrcecommerce.TransactionNumber = "120014"; fdmsrcecommerce.SetDetailAggregate(aggregate); fdmsrcecommerce.Capture();

Config Method (DPaymentsSDK_FDMSRcECommerce Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Credit Method (DPaymentsSDK_FDMSRcECommerce Class)

Submits a credit transaction.

Object Oriented Interface

public function doCredit();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_credit($res);

Remarks

This method credits funds to the card. This is not based on a previous transaction. This may be used to return funds to a card if a previous transaction has already been settled. To void or cancel a transaction before it has been settled call Reverse instead.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

ECommerce Credit Code Example fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "120013"; fdmsrcecommerce.OrderNumber = "12000503"; fdmsrcecommerce.ReferenceNumber = "123"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "123"; fdmsrcecommerce.ReferenceNumber = "123456"; fdmsrcecommerce.OrderNumber = "1234"; fdmsrcecommerce.Card.Number = "36185900055556"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.TransactionAmount = "1200"; fdmsrcecommerce.Credit(); ;

GetDetailAggregate Method (DPaymentsSDK_FDMSRcECommerce Class)

Returns a detail aggregate containing details of this transaction, which is used for Capture or Reverse transactions or settlement when using Terminal Capture mode.

Object Oriented Interface

public function doGetDetailAggregate();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_getdetailaggregate($res);

Remarks

This method will return a detail aggregate representing the transaction. After calling AuthOnly or Sale call this method to obtain a detail aggregate. The aggregate will be required when calling Capture or Reverse.

When using Terminal Capture Settlement Mode this aggregate must be passed to the FDMSRcSettle 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 FDMSRcDetailrecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

To set the aggregate before calling Capture Reverse or SendSettlement call SetDetailAggregate. Save this aggregate in a secure location.

HostTotals Method (DPaymentsSDK_FDMSRcECommerce Class)

Performs a Host Totals request.

Object Oriented Interface

public function doHostTotals();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_hosttotals($res);

Remarks

This method performs a Host Totals transaction submitted to request a Host Totals Report for a particular day.

You need to set the required merchant password and report type fields using the HostTotalsPassword and HostTotalsType configuration settings, respectively.

ECommerce HostTotals Code Example fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "120013"; fdmsrcecommerce.Config("CurrencyCode=840"); fdmsrcecommerce.Config("HostTotalsType=0"); fdmsrcecommerce.Config("HostTotalsPassword=111111"); fdmsrcecommerce.HostTotals();

Interrupt Method (DPaymentsSDK_FDMSRcECommerce Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_FDMSRcECommerce Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_reset($res);

Remarks

This method clears all properties to their default values.

Reverse Method (DPaymentsSDK_FDMSRcECommerce Class)

Reverses a transaction.

Object Oriented Interface

public function doReverse();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_reverse($res);

Remarks

This method reverses a transaction that has not been settled.

To void/reverse a Sale or AuthOnly transaction first set ReversalTransactionType to specify the type of original transaction that is being reversed. Next set ReversalType to frtFullReversal and call this method.

If the previous transaction did not receive a response and the state of the transaction is uncertain you may perform a Timeout Reversal. To perform a timeout reversal set ReversalTransactionType to specify the type of original transaction that is being reversed. Next set ReversalType to frtTimeoutReversal and call this method.

Timeout Reversals are applicable to the following transaction types:

• AuthOnly
• Capture
• Credit
• Sale

Full Reversals are applicable to the following transaction types:

• AuthOnly
• Sale

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

ECommerce Sale and Reverse Code Example fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.MerchantURL = "mywebsite"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "123"; fdmsrcecommerce.ReferenceNumber = "123456"; fdmsrcecommerce.OrderNumber = "1234"; fdmsrcecommerce.Card.Number = "36185900055556"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.Card.CVVData = "123"; fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road"; fdmsrcecommerce.CustomerZip = "11747"; fdmsrcecommerce.TransactionAmount = "1200"; fdmsrcecommerce.Sale(); string aggregate = fdmsrcecommerce.GetDetailAggregate(); //Reverse fdmsrcecommerce = new Fdmsrcecommerce(); fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "123"; fdmsrcecommerce.ReferenceNumber = "123456"; fdmsrcecommerce.OrderNumber = "1234"; //Provide the detail aggregate from the sale. fdmsrcecommerce.SetDetailAggregate(aggregate); fdmsrcecommerce.ReversalTransactionType = FdmsrcecommerceReversalTransactionTypes.frttSale; fdmsrcecommerce.ReversalType = FdmsrcecommerceReversalTypes.fertFullReversal; fdmsrcecommerce.Reverse();

Sale Method (DPaymentsSDK_FDMSRcECommerce Class)

Performs a sale transaction.

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_sale($res);

Remarks

This method performs a sale transaction. Once a sale is performed no further action is needed, the funds will automatically be captured by FDMS.

After this method returns check the value of ResponseCode to determine if the transaction was successful.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

ECommerce Sale Code Example fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.MerchantURL = "mywebsite"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "120013"; fdmsrcecommerce.OrderNumber = "12000503"; fdmsrcecommerce.ReferenceNumber = "123"; fdmsrcecommerce.Card.Number = "36185900055556"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.Card.CVVData = "123"; fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road"; fdmsrcecommerce.CustomerZip = "11747"; fdmsrcecommerce.TransactionAmount = "1200"; fdmsrcecommerce.Sale(); //Save the detail aggregate to use with Capture or Reverse later string aggregate = fdmsrcecommerce.GetDetailAggregate();

SetDetailAggregate Method (DPaymentsSDK_FDMSRcECommerce Class)

Specifies the detail aggregate before calling Capture or Reverse.

Object Oriented Interface

public function doSetDetailAggregate($aggregate);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_setdetailaggregate($res, $aggregate);

Remarks

This method specifies the detail aggregate from the original AuthOnly or Sale transaction. This must be set before calling Capture or Reverse.

The aggregate specified here should have been obtained from the GetDetailAggregate method after the original AuthOnly or Sale transaction.

VerifyCard Method (DPaymentsSDK_FDMSRcECommerce Class)

Performs a zero dollar verification of the card.

Object Oriented Interface

public function doVerifyCard();

Procedural Interface

dpaymentssdk_fdmsrcecommerce_do_verifycard($res);

Remarks

This method performs a card verification without charging any funds. This can be used to simply verify if the card is valid, or perform AVS and CVV checks without actually charging any funds to the card.

When calling this method TransactionAmount must be set to 0. Set either CustomerAddress or CustomerZip to perform AVS checks. Set CardCVVData to perform CVV checks.

The following combinations are supported:

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister class. (You may update your list of service provider URLs with the FDMSRegister class's ServiceDiscovery method).

ECommerce VerifyCard Code Example fdmsrcecommerce.IndustryType = FdmsrcecommerceIndustryTypes.feitEcommerce; fdmsrcecommerce.TPPID = "AAA000"; fdmsrcecommerce.MerchantTerminalNumber = "00000001"; fdmsrcecommerce.MerchantId = "1234"; fdmsrcecommerce.GroupId = "20001"; fdmsrcecommerce.DatawireId = "00011122233344455566"; fdmsrcecommerce.ApplicationId = "RAPIDCONNECTVXN"; fdmsrcecommerce.URL = "https://stg.dw.us.fdcnet.biz/rc"; fdmsrcecommerce.STAN = "112"; fdmsrcecommerce.TransactionNumber = "1234"; fdmsrcecommerce.ReferenceNumber = "1212"; fdmsrcecommerce.OrderNumber = "123"; fdmsrcecommerce.Card.Number = "5424181111112236"; fdmsrcecommerce.Card.ExpMonth = 4; fdmsrcecommerce.Card.ExpYear = 2016; fdmsrcecommerce.Card.CVVData = "123"; fdmsrcecommerce.TransactionAmount = "0"; fdmsrcecommerce.CustomerAddress = "1307 Broad Hollow Road"; fdmsrcecommerce.CustomerZip = "11747"; fdmsrcecommerce.VerifyCard();

Connected Event (DPaymentsSDK_FDMSRcECommerce Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

DataPacketIn Event (DPaymentsSDK_FDMSRcECommerce Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_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_FDMSRcECommerce Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_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_FDMSRcECommerce Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

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

Error Event (DPaymentsSDK_FDMSRcECommerce Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_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_FDMSRcECommerce Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_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_FDMSRcECommerce Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_fdmsrcecommerce_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_FDMSRcECommerce Class)

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

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

Config Settings (FDMSRcECommerce Class)

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

FDMSRcECommerce Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSRcECommerce Class)

FDMSRcECommerce Errors

	432   Invalid index.
	501   Invalid length for this property.
	502   Invalid data format for this property.
	503   Value is out of range.
	504   Credit card digit check failed.
	505   Card date invalid.
	506   Card expired.
	519   Corrupt response.
	520   Response payload empty.
	521   Response truncated.
	526   Invalid timeout value.
	593   A property required for this transaction is missing.
	529   Error in XML response.
	530   Status code received in response indicates an error condition.
	531   Return code received in response indicates an error condition.
	532   Cannot generate detail aggregate - this transaction was not successfully authorized.
	533   Internal error constructing payload.

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

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).