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.

Syntax

dpaymentssdk.Fdmsgiftcard

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 Number and EntryDataSource fields. Otherwise, you should fill the MagneticStripe field 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, Code 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, PreviousBalance and NewBalance 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 Code field, with human-readable text appearing in Text. 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 (FDMSGiftCard Class)

Merchant-designated store or location number.

Syntax

public String getAlternateMerchantId();


public void setAlternateMerchantId(String alternateMerchantId);

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.

ApplicationId Property (FDMSGiftCard Class)

Identifies the merchant application to the Datawire System.

Syntax

public String getApplicationId();


public void setApplicationId(String applicationId);

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.

Card Property (FDMSGiftCard Class)

Contains the customer's credit card information.

Syntax

public CCCard getCard();


public void setCard(CCCard card);

Remarks

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

This property is not available at design time.

ClerkId Property (FDMSGiftCard Class)

Identifies the clerk executing this transaction.

Syntax

public String getClerkId();


public void setClerkId(String clerkId);

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.

DatawireId Property (FDMSGiftCard Class)

Identifies the merchant to the Datawire System.

Syntax

public String getDatawireId();


public void setDatawireId(String datawireId);

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.

LockType Property (FDMSGiftCard Class)

Indicates the type of lock requested by the LockCard method.

Syntax

public int getLockType();


public void setLockType(int lockType);


Enumerated values:
  public final static int ltFullLock = 0;
  public final static int ltPartialLock = 1;

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.

MerchantNumber Property (FDMSGiftCard Class)

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

Syntax

public String getMerchantNumber();


public void setMerchantNumber(String merchantNumber);

Default Value

""

Remarks

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

MerchantTerminalNumber Property (FDMSGiftCard Class)

Used to identify a unique terminal within a merchant location.

Syntax

public String getMerchantTerminalNumber();


public void setMerchantTerminalNumber(String merchantTerminalNumber);

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.

Proxy Property (FDMSGiftCard Class)

This property includes a set of properties related to proxy access.

Syntax

public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

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

RedemptionType Property (FDMSGiftCard Class)

Identifies the type of redemption to execute.

Syntax

public int getRedemptionType();


public void setRedemptionType(int redemptionType);


Enumerated values:
  public final static int rtNormalRedemption = 0;
  public final static int rtPartialRedemption = 1;
  public final static int rtCashOut = 2;
  public final static int rtRedemptionWithUnlock = 3;

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:

ReferenceNumber Property (FDMSGiftCard Class)

Reference number used to identify the transaction.

Syntax

public String getReferenceNumber();


public void setReferenceNumber(String referenceNumber);

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.

Response Property (FDMSGiftCard Class)

Contains the response returned from the FDMS Closed Loop Gift Card system.

Syntax

public FDMSGiftResponse getResponse();

Remarks

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

This property is read-only.

SSLAcceptServerCert Property (FDMSGiftCard Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (FDMSGiftCard Class)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (FDMSGiftCard Class)

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

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

Possible values are:

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (FDMSGiftCard Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

TerminalId Property (FDMSGiftCard Class)

Merchant-generated 4-digit terminal Id.

Syntax

public String getTerminalId();


public void setTerminalId(String terminalId);

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.

Timeout Property (FDMSGiftCard Class)

A timeout for the class.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

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

TransactionAmount Property (FDMSGiftCard Class)

Purchase amount to be authorized.

Syntax

public String getTransactionAmount();


public void setTransactionAmount(String transactionAmount);

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.

TransactionNumber Property (FDMSGiftCard Class)

Uniquely identifies the transaction.

Syntax

public String getTransactionNumber();


public void setTransactionNumber(String transactionNumber);

Default Value

""

Remarks

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

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

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

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

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

URL Property (FDMSGiftCard Class)

Location of the Datawire server to which transactions are sent.

Syntax

public String getURL();


public void setURL(String URL);

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.

VoidType Property (FDMSGiftCard Class)

Identifies the type of void to execute.

Syntax

public int getVoidType();


public void setVoidType(int voidType);


Enumerated values:
  public final static int vtRedemption = 0;
  public final static int vtLoad = 1;
  public final static int vtActivation = 2;

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:

ActivateCard Method (Fdmsgiftcard Class)

Activates a Gift Card.

Syntax

public void activateCard();

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 Response Code and Text fields 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 (Fdmsgiftcard Class)

Retrieves the balance remaining on a gift card.

Syntax

public void balanceInquiry();

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 Response PreviousBalance and NewBalance fields will contain the card's current balance.

The Response Code and Text fields 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 (Fdmsgiftcard Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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 (Fdmsgiftcard Class)

Interrupts the current action.

Syntax

public void interrupt();

Remarks

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

LoadCard Method (Fdmsgiftcard Class)

Adds funds to a gift card.

Syntax

public void loadCard();

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 Response Code and Text fields 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 (Fdmsgiftcard Class)

Locks funds on a gift card.

Syntax

public void lockCard();

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 Response Code and Text fields 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 (Fdmsgiftcard Class)

Removes funds from the gift card for a purchase.

Syntax

public void redeemCard();

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 Response PreviousBalance and NewBalance 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 Response NewBalance will be zero, and the PreviousBalance 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 Response Code and Text fields 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 (Fdmsgiftcard Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

ReverseLastTransaction Method (Fdmsgiftcard Class)

Reverses the last attempted transaction.

Syntax

public void reverseLastTransaction();

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 Response Code 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 Response Code of "33", indicating that no previous transaction was found to reverse.

The Response Code and Text fields indicate whether this transaction was successful.

VoidTransaction Method (Fdmsgiftcard Class)

Voids a previous transaction.

Syntax

public void voidTransaction();

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 Response Code and Text fields 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 (Fdmsgiftcard Class)

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

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void connected(FdmsgiftcardConnectedEvent e) {}
  ...
}

public class FdmsgiftcardConnectedEvent {
  public int statusCode;
  public String 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 (Fdmsgiftcard Class)

Fired when receiving a data packet from the transaction server.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void dataPacketIn(FdmsgiftcardDataPacketInEvent e) {}
  ...
}

public class FdmsgiftcardDataPacketInEvent {
  public byte[] 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 (Fdmsgiftcard Class)

Fired when sending a data packet to the transaction server.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void dataPacketOut(FdmsgiftcardDataPacketOutEvent e) {}
  ...
}

public class FdmsgiftcardDataPacketOutEvent {
  public byte[] 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 (Fdmsgiftcard Class)

This event is fired when a connection is closed.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void disconnected(FdmsgiftcardDisconnectedEvent e) {}
  ...
}

public class FdmsgiftcardDisconnectedEvent {
  public int statusCode;
  public String 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 (Fdmsgiftcard Class)

Information about errors during data delivery.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void error(FdmsgiftcardErrorEvent e) {}
  ...
}

public class FdmsgiftcardErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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

Fired after the server presents its certificate to the client.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void SSLServerAuthentication(FdmsgiftcardSSLServerAuthenticationEvent e) {}
  ...
}

public class FdmsgiftcardSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean 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 (Fdmsgiftcard Class)

Shows the progress of the secure connection.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void SSLStatus(FdmsgiftcardSSLStatusEvent e) {}
  ...
}

public class FdmsgiftcardSSLStatusEvent {
  public String message;
}

Remarks

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

Status Event (Fdmsgiftcard Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

public class DefaultFdmsgiftcardEventListener implements FdmsgiftcardEventListener {
  ...
  public void status(FdmsgiftcardStatusEvent e) {}
  ...
}

public class FdmsgiftcardStatusEvent {
  public String message;
}

Remarks

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

CCCard Type

Contains the customer's credit card information.

Remarks

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

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

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

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

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

Fields

Constructors

public CCCard();

public CCCard( number,  expMonth,  expYear);

public CCCard( magneticStripe,  entryDataSource);

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

FDMSGiftResponse Type

Contains the response to a gift card transaction.

Remarks

This type contains the results of a transaction made with the FDMSGiftCard class. The fields contained by this type are listed below.

Fields

Constructors

public FDMSGiftResponse();

Proxy Type

This is the proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

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

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors