FDMSGiftCard Component

Properties   Methods   Events   Config Settings   Errors  

The FDMSGiftCard component is used to manipulate funds on Stored Value (Gift) Cards with the FDMS Closed Loop Gift Card System. This component 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 component can be integrated into web pages or stand- alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

TibcFDMSGiftCard

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

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 properties. Otherwise, you should fill the MagneticStripe 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, 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 property, with human-readable text appearing in Text. Like the FDMSRetail component, 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AlternateMerchantId Property (FDMSGiftCard Component)

Merchant-designated store or location number.

Syntax

property AlternateMerchantId: String read get_AlternateMerchantId write set_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 Component)

Identifies the merchant application to the Datawire System.

Syntax

property ApplicationId: String read get_ApplicationId write set_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 component.

Card Property (FDMSGiftCard Component)

Contains the customer's credit card information.

Syntax

property Card: TibcCCCard read get_Card write set_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 Component)

Identifies the clerk executing this transaction.

Syntax

property ClerkId: String read get_ClerkId write set_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 Component)

Identifies the merchant to the Datawire System.

Syntax

property DatawireId: String read get_DatawireId write set_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 component). 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 Component)

Indicates the type of lock requested by the LockCard method.

Syntax

property LockType: TibcFDMSLockTypes read get_LockType write set_LockType;

TibcFDMSLockTypes = (
  ltFullLock,
  ltPartialLock
);

Default Value

ltFullLock

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

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

Syntax

property MerchantNumber: String read get_MerchantNumber write set_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 Component)

Used to identify a unique terminal within a merchant location.

Syntax

property MerchantTerminalNumber: String read get_MerchantTerminalNumber write set_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 Component)

A set of properties related to proxy access.

Syntax

property Proxy: TibcProxy read get_Proxy write set_Proxy;

Remarks

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

RedemptionType Property (FDMSGiftCard Component)

Identifies the type of redemption to execute.

Syntax

property RedemptionType: TibcFDMSRedemptionTypes read get_RedemptionType write set_RedemptionType;

TibcFDMSRedemptionTypes = (
  rtNormalRedemption,
  rtPartialRedemption,
  rtCashOut,
  rtRedemptionWithUnlock
);

Default Value

rtNormalRedemption

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

Reference number used to identify the transaction.

Syntax

property ReferenceNumber: String read get_ReferenceNumber write set_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 Component)

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

Syntax

property Response: TibcFDMSGiftResponse read get_Response;

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.

SSLAcceptServerCertEncoded Property (FDMSGiftCard Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded;
property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertEncoded Property (FDMSGiftCard Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded;
property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertStore Property (FDMSGiftCard Component)

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

Syntax

property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore;
property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

SSLCertStorePassword Property (FDMSGiftCard Component)

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

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

Default Value

''

Remarks

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

SSLCertStoreType Property (FDMSGiftCard Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibcCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

TibcCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (FDMSGiftCard Component)

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

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

Default Value

''

Remarks

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

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

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

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

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

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

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

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

SSLProvider Property (FDMSGiftCard Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibcTSSLProviders read get_SSLProvider write set_SSLProvider;

TibcTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

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

SSLServerCertEncoded Property (FDMSGiftCard Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLServerCertEncoded: String read get_SSLServerCertEncoded;
property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;

Default Value

''

Remarks

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

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

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

TerminalId Property (FDMSGiftCard Component)

Merchant-generated 4-digit terminal Id.

Syntax

property TerminalId: String read get_TerminalId write set_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 Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the component will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

TransactionAmount Property (FDMSGiftCard Component)

Purchase amount to be authorized.

Syntax

property TransactionAmount: String read get_TransactionAmount write set_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 Component)

Uniquely identifies the transaction.

Syntax

property TransactionNumber: String read get_TransactionNumber write set_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 components 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 Component)

Location of the Datawire server to which transactions are sent.

Syntax

property URL: String read get_URL write set_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 component. Once you Register and Activate the merchant using the FDMSRegister component, 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 component.

VoidType Property (FDMSGiftCard Component)

Identifies the type of void to execute.

Syntax

property VoidType: TibcFDMSVoidTypes read get_VoidType write set_VoidType;

TibcFDMSVoidTypes = (
  vtRedemption,
  vtLoad,
  vtActivation
);

Default Value

vtRedemption

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

Activates a Gift Card.

Syntax

procedure 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 Code and Text 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

BalanceInquiry Method (FDMSGiftCard Component)

Retrieves the balance remaining on a gift card.

Syntax

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

The Code and Text 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Config Method (FDMSGiftCard Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Interrupts the current action.

Syntax

procedure Interrupt();

Remarks

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

LoadCard Method (FDMSGiftCard Component)

Adds funds to a gift card.

Syntax

procedure 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 Code and Text 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

LockCard Method (FDMSGiftCard Component)

Locks funds on a gift card.

Syntax

procedure 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 Code and Text 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

RedeemCard Method (FDMSGiftCard Component)

Removes funds from the gift card for a purchase.

Syntax

procedure 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 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 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 Code and Text 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Reset Method (FDMSGiftCard Component)

Clears all properties to their default values.

Syntax

procedure Reset();

Remarks

This method clears all properties to their default values.

ReverseLastTransaction Method (FDMSGiftCard Component)

Reverses the last attempted transaction.

Syntax

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

The Code and Text properties indicate whether this transaction was successful.

VoidTransaction Method (FDMSGiftCard Component)

Voids a previous transaction.

Syntax

procedure 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 Code and Text 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Connected Event (FDMSGiftCard Component)

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

Syntax

type TConnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

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

Fired when receiving a data packet from the transaction server.

Syntax

type TDataPacketInEvent = procedure (
  Sender: TObject;
  DataPacket: String;
  DataPacketB: TBytes
) of Object;

property OnDataPacketIn: TDataPacketInEvent read FOnDataPacketIn write FOnDataPacketIn;

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

DataPacketOut Event (FDMSGiftCard Component)

Fired when sending a data packet to the transaction server.

Syntax

type TDataPacketOutEvent = procedure (
  Sender: TObject;
  DataPacket: String;
  DataPacketB: TBytes
) of Object;

property OnDataPacketOut: TDataPacketOutEvent read FOnDataPacketOut write FOnDataPacketOut;

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

Disconnected Event (FDMSGiftCard Component)

This event is fired when a connection is closed.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

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

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

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

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

SSLServerAuthentication Event (FDMSGiftCard Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  CertEncoded: String;
  CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

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

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

SSLStatus Event (FDMSGiftCard Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

Status Event (FDMSGiftCard Component)

Shows the progress of the FDMS/Datawire connection.

Syntax

type TStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnStatus: TStatusEvent read FOnStatus write FOnStatus;

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 component are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the component will look for MagneticStripe data when authorizing the transaction, and will raises an exception because none is present.

Fields

Constructors

constructor Create();

constructor Create(valNumber: String; valExpMonth: Integer; valExpYear: Integer);

constructor Create(valMagneticStripe: String; valEntryDataSource: TibcEntryDataSources);

FDMSGiftResponse Type

Contains the response to a gift card transaction.

Remarks

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

Fields

Constructors

constructor Create();

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

Config Settings (FDMSGiftCard Component)

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

FDMSGiftCard Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors