FDMSGiftCard Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSGiftCard class is used to manipulate funds on Stored Value (Gift) Cards with the FDMS Closed Loop Gift Card System. This class supports both card-present and card-not-present gift card transactions, and allows for simple, direct, secure communication to the Datawire gateway to FDMS through a standard Internet connection. This class can be integrated into web pages or stand- alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Class Name

DPaymentsSDK_FDMSGiftCard

Procedural Interface

 dpaymentssdk_fdmsgiftcard_open();
 dpaymentssdk_fdmsgiftcard_close($res);
 dpaymentssdk_fdmsgiftcard_register_callback($res, $id, $function);
 dpaymentssdk_fdmsgiftcard_get_last_error($res);
 dpaymentssdk_fdmsgiftcard_get_last_error_code($res);
 dpaymentssdk_fdmsgiftcard_set($res, $id, $index, $value);
 dpaymentssdk_fdmsgiftcard_get($res, $id, $index);
 dpaymentssdk_fdmsgiftcard_do_activatecard($res);
 dpaymentssdk_fdmsgiftcard_do_balanceinquiry($res);
 dpaymentssdk_fdmsgiftcard_do_config($res, $configurationstring);
 dpaymentssdk_fdmsgiftcard_do_interrupt($res);
 dpaymentssdk_fdmsgiftcard_do_loadcard($res);
 dpaymentssdk_fdmsgiftcard_do_lockcard($res);
 dpaymentssdk_fdmsgiftcard_do_redeemcard($res);
 dpaymentssdk_fdmsgiftcard_do_reset($res);
 dpaymentssdk_fdmsgiftcard_do_reverselasttransaction($res);
 dpaymentssdk_fdmsgiftcard_do_voidtransaction($res);

Remarks

A Stored Value Card (or Gift Card as they are commonly called) is a not actually a type of credit or debit card. Simply put, a Stored Value Card is a card with a magnetic strip on the back that holds information about monies that have been "pre-paid" into an account for the purpose of making financial transactions. Examples include a retailer's gift card, a prepaid telephone card, a college campus meal plan card, a reloadable subway pass, etcetera. Not included are government income-support cards, otherwise known as EBT cards or electronic food stamps.

The FDMSGiftCard class makes gift card 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:

First, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSRegister class to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId 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 Service Discovery.

FDMSGiftCard.MerchantNumber = "57111111111"; // Supplied by FDMS/Datawire FDMSGiftCard.MerchantTerminalNumber = "00000000001"; // Supplied by FDMS/Datawire FDMSGiftCard.DatawireId = "00010388888888888878"; // Retrieved with the FDMSRegister class.

After the merchant information is setup, you may enter transaction data. When the card is Manually Entered, the merchant should fill the CardNumber and CardEntryDataSource properties. Otherwise, you should fill the CardMagneticStripe property with the Track 2 data read from the back of the card.

FDMSGiftCard.Card.MagneticStripe = "6010567008288444=00010004000070771026"; FDMSGiftCard.Card.EntryDataSource = edsTrack2;

Then set additional information about the transaction, including any merchant-designated tracking information, such as the Id of the employee making the transaction, the terminal where the transaction is taking place, any alternate identification for the merchant location, and transaction and reference numbers. FDMSGiftCard.TransactionNumber = "0000001V000003"; FDMSGiftCard.ClerkId = "123"; FDMSGiftCard.ReferenceNumber = "555523"; FDMSGiftCard.AlternateMerchantId = "132123"; FDMSGiftCard.TerminalId = "1234"; Now you must choose what transaction you wish to make. Adding Value to a card, Redeeming a card, voiding a previous transaction, or retrieving the card's current balance.

To add funds to an existing Gift Card, simply set the TransactionAmount with the amount to add to the card, and then call LoadCard. Activating a new gift card is handled similarly, by calling ActivateCard instead.

To redeem funds from a Gift Card due to a customer purchase, set TransactionAmount to the total for the purchase and call RedeemCard. If the Gift Card account contains enough funds, ResponseCode will indicate the card was approved. If there are not enough funds available on the card to cover the TransactionAmount, normally the transaction will be declined. However, the merchant may set RedemptionType to rtPartialRedemption. This allows the customer to split the cost of the purchase between the Gift Card and another form of payment. Instead of declining the Gift Card, ResponsePreviousBalance and ResponseNewBalance can be used to deduce the amount removed from the Gift Card. The merchant may subtract that from the requested TransactionAmount to determine the difference to charge the customer.

You may also inquire as to the total funds contained on the card by calling BalanceInquiry. This will not effect the amount of funds contained on the card in any way.

You also have the ability to lock funds on a card with the LockCard method, so that they may not be used for any other purchase until first unlocked. Previous transactions may be voided with VoidTransaction, and any transactions for which you did not receive a response (due to network issues), should be immediately reversed using the ReverseLastTransaction method.

The status of any of the above transactions will be stored in the ResponseCode property, with human-readable text appearing in ResponseText. Like the FDMSRetail class, there are several other Response fields which will contain data that should be logged.

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.

AlternateMerchantId Property (DPaymentsSDK_FDMSGiftCard Class)

Merchant-designated store or location number.

Object Oriented Interface

public function getAlternateMerchantId();


public function setAlternateMerchantId($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 1 );


dpaymentssdk_fdmsgiftcard_set($res, 1, $value );

Default Value

''

Remarks

Unlike the MerchantNumber property, the AlternateMerchantId is not used by FDMS or Datawire as connection credentials. This number is for the merchant's internal use. The maximum length of this property is 11 digits, and it may only contain numeric data.

Data Type

String

ApplicationId Property (DPaymentsSDK_FDMSGiftCard Class)

Identifies the merchant application to the Datawire System.

Object Oriented Interface

public function getApplicationId();


public function setApplicationId($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 2 );


dpaymentssdk_fdmsgiftcard_set($res, 2, $value );

Default Value

'NSFTDIRCTGFTXML'

Remarks

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

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this class.

Data Type

String

CardType Property (DPaymentsSDK_FDMSGiftCard Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();


public function setCardType($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 3 );


dpaymentssdk_fdmsgiftcard_set($res, 3, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_FDMSGiftCard Class)

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

Object Oriented Interface

public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 4 );


dpaymentssdk_fdmsgiftcard_set($res, 4, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_FDMSGiftCard Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 5 );


dpaymentssdk_fdmsgiftcard_set($res, 5, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 6 );


dpaymentssdk_fdmsgiftcard_set($res, 6, $value );

Default Value

0

Remarks

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

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

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

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

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

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

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

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_FDMSGiftCard Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 7 );


dpaymentssdk_fdmsgiftcard_set($res, 7, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_FDMSGiftCard Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 8 );


dpaymentssdk_fdmsgiftcard_set($res, 8, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 9 );


dpaymentssdk_fdmsgiftcard_set($res, 9, $value );

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_FDMSGiftCard Class)

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

Object Oriented Interface

public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 10 );


dpaymentssdk_fdmsgiftcard_set($res, 10, $value );

Default Value

''

Remarks

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

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

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

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

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_FDMSGiftCard Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();


public function setCardNumber($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 11 );


dpaymentssdk_fdmsgiftcard_set($res, 11, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

ClerkId Property (DPaymentsSDK_FDMSGiftCard Class)

Identifies the clerk executing this transaction.

Object Oriented Interface

public function getClerkId();


public function setClerkId($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 12 );


dpaymentssdk_fdmsgiftcard_set($res, 12, $value );

Default Value

''

Remarks

This contains a merchant-generated code used to identify an individual clerk in the merchant's system. Each clerk within a merchant's location should have their own unique identifier, to help determine which employee has performed operations on a gift card. This may be a maximum of 8 characters in length, and may only contain alphanumeric data. This can be used in conjunction with the TerminalId to determine the location a transaction was made and the employee who made it.

Data Type

String

DatawireId Property (DPaymentsSDK_FDMSGiftCard Class)

Identifies the merchant to the Datawire System.

Object Oriented Interface

public function getDatawireId();


public function setDatawireId($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 13 );


dpaymentssdk_fdmsgiftcard_set($res, 13, $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

LockType Property (DPaymentsSDK_FDMSGiftCard Class)

Indicates the type of lock requested by the LockCard method.

Object Oriented Interface

public function getLockType();


public function setLockType($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 14 );


dpaymentssdk_fdmsgiftcard_set($res, 14, $value );

Default Value

0

Remarks

This property is only used when locking funds on a card. If set to ltFullLock (default), the full balance on the gift card will be locked, and the customer will be unable to use funds on the card until the card is unlocked by setting RedemptionType to rtRedemptionWithUnlock and calling RedeemCard.

If set to ltPartialLock, only the amount indicated by the TransactionAmount property is locked. Any remaining funds on the card may be used for other purchases.

Data Type

Integer

MerchantNumber Property (DPaymentsSDK_FDMSGiftCard Class)

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

Object Oriented Interface

public function getMerchantNumber();


public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 15 );


dpaymentssdk_fdmsgiftcard_set($res, 15, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_FDMSGiftCard Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();


public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 16 );


dpaymentssdk_fdmsgiftcard_set($res, 16, $value );

Default Value

''

Remarks

This property contains a number assigned by FDMS to uniquely identify a terminal within a merchant's location, and is used along with the MerchantNumber and DatawireId as Datawire connection credentials. This number differs from the TerminalId number, which is a 4-digit merchant-generated id used along with the ClerkId to identify where and who executed the transaction.

The maximum length of the MerchantTerminalNumber is 11 digits, and it may only contain numeric data.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 17 );


dpaymentssdk_fdmsgiftcard_set($res, 17, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 18 );


dpaymentssdk_fdmsgiftcard_set($res, 18, $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_FDMSGiftCard 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_fdmsgiftcard_get($res, 19 );


dpaymentssdk_fdmsgiftcard_set($res, 19, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 20 );


dpaymentssdk_fdmsgiftcard_set($res, 20, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 21 );


dpaymentssdk_fdmsgiftcard_set($res, 21, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 22 );


dpaymentssdk_fdmsgiftcard_set($res, 22, $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_FDMSGiftCard Class)

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 23 );


dpaymentssdk_fdmsgiftcard_set($res, 23, $value );

Default Value

''

Remarks

This property contains a user name, if authentication is to be used for the proxy.

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

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

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

Data Type

String

RedemptionType Property (DPaymentsSDK_FDMSGiftCard Class)

Identifies the type of redemption to execute.

Object Oriented Interface

public function getRedemptionType();


public function setRedemptionType($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 24 );


dpaymentssdk_fdmsgiftcard_set($res, 24, $value );

Default Value

0

Remarks

This property is used by the RedeemCard method to indicate the type of charge to make against the gift card account. The valid redemption types include:

Data Type

Integer

ReferenceNumber Property (DPaymentsSDK_FDMSGiftCard Class)

Reference number used to identify the transaction.

Object Oriented Interface

public function getReferenceNumber();


public function setReferenceNumber($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 25 );


dpaymentssdk_fdmsgiftcard_set($res, 25, $value );

Default Value

''

Remarks

The merchant may optionally specify up to 16 characters of alphanumeric data in this property. The ReferenceNumber should not contain any leading or trailing whitespace, or any spaces between characters.

This property is for tracking and logging purposes only, and is not validated by the FDMS Closed Loop Gift Card system.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_FDMSGiftCard Class)

Contains an authorization code if the transaction has been approved.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 26 );

Default Value

''

Remarks

Contains an authorization code if the transaction has been approved.

This property is returned in response to all approved gift card transactions, and will contain an authorization code used for tracking within the FDMS Closed Loop Gift Card System. Depending on the merchant's setup, this property will contain either 6 digit numeric or 8 character alphanumeric data for the approval code. If the transaction was declined this property will be empty.

The contents of this property should not be used to determine the status of a transaction. The ResponseCode property will indicate whether the transaction was approved or declined.

This property is read-only.

Data Type

String

ResponseCardClass Property (DPaymentsSDK_FDMSGiftCard Class)

Identifies the class of the gift card used in the transaction.

Object Oriented Interface

public function getResponseCardClass();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 27 );

Default Value

''

Remarks

Identifies the class of the gift card used in the transaction.

The First Data Closed Loop Gift Card database may contain a list of merchant-defined card classes. If using card classes, it is the merchant's responsibility to interpret the value of this property. A value of "0" indicates the card does not belong to any card class. Contact your First Data Closed Loop Gift Card representative if you wish to assign card classes to use in your solution.

This property is read-only.

Data Type

String

ResponseCardExpDate Property (DPaymentsSDK_FDMSGiftCard Class)

Contains the expiration date of the gift card.

Object Oriented Interface

public function getResponseCardExpDate();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 28 );

Default Value

''

Remarks

Contains the expiration date of the gift card.

The account's expiration date is returned on approved transactions and on declined transactions that are declined due to the card being expired. The expiration date will be an 8-digit string in the format "MMDDYYYY". Accounts with no expiration date will return a year (YYYY) greater than 3000.

This property is read-only.

Data Type

String

ResponseCashBack Property (DPaymentsSDK_FDMSGiftCard Class)

Indicates the amount of cash to return to the customer.

Object Oriented Interface

public function getResponseCashBack();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 29 );

Default Value

''

Remarks

Indicates the amount of cash to return to the customer.

This property may be used at the point of sale to indicate the amount that needs to be tendered to a customer to remove the remaining balance from the card. It will bring the account balance to zero and close the account as defined by the merchant's configuration with First Data. For example, if $10.00 is remaining on a gift card and a purchase of $9.70 is made, the gift card system may put $.30 in this property. The response ResponseNewBalance will indicate that the card is now empty, and the merchant should give the $.30 change to the customer.

This property is read-only.

Data Type

String

ResponseCode Property (DPaymentsSDK_FDMSGiftCard Class)

Indicates the status of the authorization request.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 30 );

Default Value

''

Remarks

Indicates the status of the authorization request.

This property will contain a two character response code indicating the status of the transaction request sent to the FDMS Closed Loop Gift Card system. The merchant must evaluate this response code and not the ResponseText or ResponseApprovalCode to determine the nature of a response message. A response code of "00" represents a successful transaction. All other response codes represent non-approved requests. All non-approved response codes should NOT be assumed to be "DECLINED" as an error condition may be present.

A list of valid result codes is:

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (DPaymentsSDK_FDMSGiftCard Class)

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

Object Oriented Interface

public function getResponseDatawireReturnCode();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 31 );

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 ResponseCaptureFlag and ResponseApprovalCode properties contain 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_FDMSGiftCard Class)

Status of the communication with Datawire.

Object Oriented Interface

public function getResponseDatawireStatus();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 32 );

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 ResponseCaptureFlag and ResponseApprovalCode properties 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

ResponseLockAmount Property (DPaymentsSDK_FDMSGiftCard Class)

Contains the amount that is locked and cannot be used.

Object Oriented Interface

public function getResponseLockAmount();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 33 );

Default Value

''

Remarks

Contains the amount that is locked and cannot be used.

If the gift card has previously been locked via the LockCard method, this property will reflect the balance that is locked and cannot be used for purchases.

This property is read-only.

Data Type

String

ResponseNewBalance Property (DPaymentsSDK_FDMSGiftCard Class)

Contains the balance on the card reflected immediately after this transaction.

Object Oriented Interface

public function getResponseNewBalance();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 34 );

Default Value

''

Remarks

Contains the balance on the card reflected immediately after this transaction.

This property contains the balance of funds left on the card after the transaction was applied. When redeeming a card with the RedeemCard method and RedemptionType set to rtPartialRedemption, the merchant must use the ResponseNewBalance and ResponsePreviousBalance propertiesto determine if full amount was authorized, or if an additional amount needs to be tendered by the customer. (via cash, credit, another gift card, etc).

Note that ResponseNewBalance and ResponsePreviousBalance will display the same value in response to a call a Balance Inquiry or Lock Card transaction.

This property is read-only.

Data Type

String

ResponsePreviousBalance Property (DPaymentsSDK_FDMSGiftCard Class)

Contains the balance that was on the gift card before this transaction was completed.

Object Oriented Interface

public function getResponsePreviousBalance();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 35 );

Default Value

''

Remarks

Contains the balance that was on the gift card before this transaction was completed.

This property contains the balance of funds that was on the card immediately before the transaction that was just authorized. When redeeming a card with the RedeemCard method and RedemptionType set to rtPartialRedemption, the merchant must use the ResponseNewBalance and ResponsePreviousBalance propertiesto determine if full amount was authorized, or if an additional amount needs to be tendered by the customer. (via cash, credit, another gift card, etc).

Note that ResponseNewBalance and ResponsePreviousBalance will display the same value in response to a call a Balance Inquiry or Lock Card transaction.

This property is read-only.

Data Type

String

ResponseReferenceNumber Property (DPaymentsSDK_FDMSGiftCard Class)

Contains the reference or customer number that was submitted in the request.

Object Oriented Interface

public function getResponseReferenceNumber();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 36 );

Default Value

''

Remarks

Contains the reference or customer number that was submitted in the request.

If supported by your merchant setup, this property will contain a reference or customer number that will match the number submitted in the request. This can be used to match up responses with requests, or for other logging and reporting purposes.

This property is read-only.

Data Type

String

ResponseSystemTrace Property (DPaymentsSDK_FDMSGiftCard Class)

Contains a number used to trace the transaction.

Object Oriented Interface

public function getResponseSystemTrace();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 37 );

Default Value

''

Remarks

Contains a number used to trace the transaction.

This number is generated by the FDMS Closed Loop Gift Card system and should be logged and kept with the transaction for the duration of the transaction's life cycle. The merchant should not attempt to interpret the contents of this property.

This property is read-only.

Data Type

String

ResponseText Property (DPaymentsSDK_FDMSGiftCard Class)

Contains a human-readable description of the response Code .

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 38 );

Default Value

''

Remarks

Contains a human-readable description of the response ResponseCode.

This property will contain a description of the response code returned in the ResponseCode property. The ResponseText property may be displayed to the sales clerk or customer to explain why the transaction was declined, but it should not be used by the merchant application to determine the success or failure of the transaction. To determine this status use the ResponseCode property instead. See the table of contents for a list of response codes and their meanings.

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_FDMSGiftCard Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 40 );


dpaymentssdk_fdmsgiftcard_set($res, 40, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_FDMSGiftCard Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 68 );


dpaymentssdk_fdmsgiftcard_set($res, 68, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 84 );


dpaymentssdk_fdmsgiftcard_set($res, 84, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

The following are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_FDMSGiftCard 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_fdmsgiftcard_get($res, 85 );


dpaymentssdk_fdmsgiftcard_set($res, 85, $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_FDMSGiftCard Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 86 );


dpaymentssdk_fdmsgiftcard_set($res, 86, $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_FDMSGiftCard 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_fdmsgiftcard_get($res, 87 );


dpaymentssdk_fdmsgiftcard_set($res, 87, $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 displayed below.

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

Data Type

String

SSLProvider Property (DPaymentsSDK_FDMSGiftCard Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 95 );


dpaymentssdk_fdmsgiftcard_set($res, 95, $value );

Default Value

0

Remarks

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

Possible values are:

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_FDMSGiftCard Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 97 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

TerminalId Property (DPaymentsSDK_FDMSGiftCard Class)

Merchant-generated 4-digit terminal Id.

Object Oriented Interface

public function getTerminalId();


public function setTerminalId($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 124 );


dpaymentssdk_fdmsgiftcard_set($res, 124, $value );

Default Value

''

Remarks

This terminal number is created by the merchant, and is used to identify the terminal or register where the transaction is taking place. This can be used in conjunction with the ClerkId to determine the location and employee who initiated the transaction. This number differs from the MerchantTerminalNumber, which is an 11-digit number specified by FDMS and used as Datawire connection credentials.

Data Type

String

Timeout Property (DPaymentsSDK_FDMSGiftCard Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 125 );


dpaymentssdk_fdmsgiftcard_set($res, 125, $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

TransactionAmount Property (DPaymentsSDK_FDMSGiftCard Class)

Purchase amount to be authorized.

Object Oriented Interface

public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 126 );


dpaymentssdk_fdmsgiftcard_set($res, 126, $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 allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (DPaymentsSDK_FDMSGiftCard Class)

Uniquely identifies the transaction.

Object Oriented Interface

public function getTransactionNumber();


public function setTransactionNumber($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 127 );


dpaymentssdk_fdmsgiftcard_set($res, 127, $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_FDMSGiftCard Class)

Location of the Datawire server to which transactions are sent.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 128 );


dpaymentssdk_fdmsgiftcard_set($res, 128, $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

VoidType Property (DPaymentsSDK_FDMSGiftCard Class)

Identifies the type of void to execute.

Object Oriented Interface

public function getVoidType();


public function setVoidType($value);

Procedural Interface

dpaymentssdk_fdmsgiftcard_get($res, 129 );


dpaymentssdk_fdmsgiftcard_set($res, 129, $value );

Default Value

0

Remarks

This property is used by the VoidTransaction method to indicate the type of transaction which is to be voided. Valid void types include:

Data Type

Integer

ActivateCard Method (DPaymentsSDK_FDMSGiftCard Class)

Activates a Gift Card.

Object Oriented Interface

public function doActivateCard();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_activatecard($res);

Remarks

Stored value Activation transactions provide merchants the ability to activate a new stored value card on the FDMS Closed Loop Gift Card System. Activation transactions can only be performed on cards that have not been previously activated. Merchants have the ability to activate stored value cards with a host configured pre-denominated TransactionAmount or activate non-denominated cards with a flexible TransactionAmount. With pre-denominated cards, the stored value host will either approve the transaction for the amount on the face of the card (regardless of the amount specified in TransactionAmount), or decline the transaction if the TransactionAmount doesn't match the amount printed on the card. This is dependent on individual merchant setup.

The ResponseCode and ResponseText properties indicate whether this 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).

BalanceInquiry Method (DPaymentsSDK_FDMSGiftCard Class)

Retrieves the balance remaining on a gift card.

Object Oriented Interface

public function doBalanceInquiry();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_balanceinquiry($res);

Remarks

A BalanceInquiry transaction requests that the FDMS Closed Loop Gift Card system return the amount of funds remaining on the customer's Stored Value (Gift) Card. No charge is made to the customer's gift card. The ResponsePreviousBalance and ResponseNewBalance properties will contain the card's current balance.

The ResponseCode and ResponseText properties indicate whether this 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).

Config Method (DPaymentsSDK_FDMSGiftCard Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Interrupt Method (DPaymentsSDK_FDMSGiftCard Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_interrupt($res);

Remarks

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

LoadCard Method (DPaymentsSDK_FDMSGiftCard Class)

Adds funds to a gift card.

Object Oriented Interface

public function doLoadCard();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_loadcard($res);

Remarks

This method adds funds to a gift card. The gift card must have been previously activated using the ActivateCard method. ActivateCard is used when the card is originally purchased. LoadCard should be used when a customer wishes to add funds onto his card, to give the customer a refund, etc.

The ResponseCode and ResponseText properties indicate whether this 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).

LockCard Method (DPaymentsSDK_FDMSGiftCard Class)

Locks funds on a gift card.

Object Oriented Interface

public function doLockCard();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_lockcard($res);

Remarks

This transaction will lock funds on a gift card. The LockType property determines if you want to lock the full amount on the card, or a lesser amount indicated by the TransactionAmount you specify. If you lock the full amount the customer will be unable to use the card until the funds are unlocked. If you request a partial lock, the customer will still be able to make purchases on the card, unless a purchase would cause the balance on the card to drop below the locked amount. For example, if a customer uses a gift card at a restaurant, you do not know the gratuity beforehand, so you may wish to lock the amount of the bill plus 20% for any tip he might leave.

Use the RedeemCard method with the RedemptionType set to rtRedemptionWithUnlock, to unlock the card. If you made a partial lock, the TransactionAmount for this redemption must be less than or equal to the locked amount, or the transaction will be declined.

Note: A full lock also requires the TransactionAmount property to be sent in the request. If the gift card balance is less than the requested TransactionAmount, the lock transaction will be declined.

The ResponseCode and ResponseText properties indicate whether this 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).

RedeemCard Method (DPaymentsSDK_FDMSGiftCard Class)

Removes funds from the gift card for a purchase.

Object Oriented Interface

public function doRedeemCard();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_redeemcard($res);

Remarks

A Redemption transaction is the process of deducting value from the Gift Card, and is very similar to a Credit Card Sale transaction, except that funds are immediately removed from the balance of the gift card. There are four types of redemptions that can be made with this method, depending on the value of the RedemptionType.

Regular redemptions can be made with TransactionAmounts up to the balance on the card. Attempting to redeem a card for more than the current balance will result in a decline for insufficient funds.

In the case that the customer's gift card does not have enough funds to cover the entire TransactionAmount, the merchant may request that the host perform a Partial Redemption. With the RedemptionType set to rtPartialRedemption, the point of sale is capable of processing a Redemption transaction for more than the card balance, and still receive an approval. All of the funds remaining on the gift card will be put towards the TransactionAmount, and the merchant will be required to obtain an additional form of payment for the remaining balance. The ResponsePreviousBalance and ResponseNewBalance can then be used to calculate the amount actually removed from the card, and the amount the customer still needs to tender (via cash, credit card, etc).

If the merchant allows it, a customer may Cash Out his gift card, and receive the remainder of the gift card's stored value as cash. To cash out a gift card, clear the TransactionAmount and set the RedemptionType to rtCashOut before calling RedeemCard. If successful, the ResponseNewBalance will be zero, and the ResponsePreviousBalance will indicate the total amount removed from the card, which should be given to the customer as cash.

Finally, you can send a Redemption Unlock transaction, which redeems the card and removes a lock that was previously made with the LockCard method.

The ResponseCode and ResponseText properties indicate whether this 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).

Reset Method (DPaymentsSDK_FDMSGiftCard Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_reset($res);

Remarks

This method clears all properties to their default values.

ReverseLastTransaction Method (DPaymentsSDK_FDMSGiftCard Class)

Reverses the last attempted transaction.

Object Oriented Interface

public function doReverseLastTransaction();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_reverselasttransaction($res);

Remarks

If a transaction times out or you are otherwise unsure if it completed successfully, immediately use this method to reverse it. If the transaction had gone through successfully, the ResponseCode will be "00" and the other Response properties will show the results of the reversal. If the transaction was never actually received by the FDMS Closed Loop Gift Card System you will get a ResponseCode of "33", indicating that no previous transaction was found to reverse.

The ResponseCode and ResponseText properties indicate whether this transaction was successful.

VoidTransaction Method (DPaymentsSDK_FDMSGiftCard Class)

Voids a previous transaction.

Object Oriented Interface

public function doVoidTransaction();

Procedural Interface

dpaymentssdk_fdmsgiftcard_do_voidtransaction($res);

Remarks

This method is used to void a transaction previously made with the RedeemCard, LoadCard, or ActivateCard methods. The VoidType property indicates the type of transaction you wish to void. Voiding a redemption adds the TransactionAmount back onto the gift card. Voiding a Load removes the TransactionAmount from the card. Voiding an Activation removes the TransactionAmount from the card and resets the state of the card to unactivated. However, Activations can only be voided if any subsequent transactions after the initial activation are voided first. See the VoidType property for more information.

The ResponseCode and ResponseText properties indicate whether this 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).

Connected Event (DPaymentsSDK_FDMSGiftCard Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dpaymentssdk_fdmsgiftcard_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_FDMSGiftCard Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_fdmsgiftcard_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_FDMSGiftCard Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_fdmsgiftcard_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_FDMSGiftCard Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dpaymentssdk_fdmsgiftcard_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_FDMSGiftCard Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

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

SSLServerAuthentication Event (DPaymentsSDK_FDMSGiftCard Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_FDMSGiftCard Class)

Shows the progress of the FDMS/Datawire connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_fdmsgiftcard_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 (FDMSGiftCard Class)

FDMSGiftCard Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSGiftCard Class)

FDMSGiftCard Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors