Properties   Methods   Events   Configuration Settings  

The PTGiftCard component is used to manipulate funds on Stored Value (Gift) Cards with the Paymentech NetConnect system on the Tampa platform. This component supports card-present gift card transactions, and allows for simple, direct, secure communication to the Paymentech SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand- alone Point Of Sale applications. Because all SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated SSL servers.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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.

There just a few steps to setting up the component and sending transactions. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your PINCapability and CashRegisterId at this time.

After the merchant information is setup, you may enter transaction data. When the Card is Manually Entered, the merchant should fill the Card, Card, and Card properties. Otherwise, you should fill the Card property with the Track 2 data read from the back of the card, and set Card to Track2. These are the only two Entry Data Sources supported for Stored Value (Gift) Cards.

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 AddValue. Activating a new gift card is handled the same way. If the card indicated by Card (or Card) has not yet been activated, calling AddValue will automatically activate it with the amount indicated by TransactionAmount.

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, Response 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 PartialRedemption to True. 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, Response will contain the amount deducted from the Gift Card. The merchant may subtract that from TransactionAmount to determine the difference to charge the customer.

Finally, you may 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.

The status of any of the above transactions will be stored in the Response property, with human-readable text appearing in Response. Like the PTCHARGE component, there are several other Response fields which will contain data that should be logged. However, there are a few new properties specific to the PTGiftCard component: Response will be returned after all transactions except VoidTransaction, and will contain the current balance of the Gift Card. Response will indicate the balance BEFORE the last transaction went through. The Response property is used for tracking after the sale, and must be printed on every customer receipt.

Gift Card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, only the Host Capture settlement mode is supported. At the end of the day you should release the current batch using the PTHOSTSETTLE component (the batch may contain other authorizations that were made using different components from this product. See the documentation for the other components you are using for more information).

Property List

---

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

CardCVVData	Three digit security code on back of card (optional).
CardCVVPresence	Indicates reason CVV value not supplied.
CardEntryDataSource	Determines the manner in which a cardholder's information is being sent to the Host.
CardExpMonth	Expiration month of the credit card specified by Number .
CardExpYear	Expiration year of the credit card specified by Number .
CardMagneticStripe	Track data read off of the card's magnetic stripe.
CardNumber	Customer's credit card number.
CashOutIndicator	Indicates to the host that the customer wants the remainder of the card's value returned as cash.
CashRegisterId	Cash Register transaction identifier.
ClientNumber	Merchant configuration property, assigned by Paymentech.
DuplicateChecking	Indicates whether duplicate checking is enabled.
EmployeeNumber	Identifies the employee making this transaction.
IndustryType	Determines the merchant's industry type.
InvoiceNumber	Merchant-generated invoice number.
MerchantNumber	A unique number used to identify the merchant, assigned by Paymentech.
PartialRedemption	Partial Redemption indicator.
Password	Password for authentication with the NetConnect Server.
PINCapability	Indicates if the terminal device supports a PIN pad.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
ResponseApprovalCode	Contains an authorization code when a transaction has been approved, or an error code.
ResponseAuthorizedAmount	Used for partial authorizations.
ResponseBalance	Balance after this transaction was completed.
ResponseBatchNumber	Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTHOSTSETTLE component, or after a SendSettlement sent using the PTMANUALSETTLE component.
ResponseCashOut	The sum of the TransactionAmount plus the remainder of any value left on the card.
ResponseCode	Indicates the status of the authorization request.
ResponseCVVResult	Contains the returned CVV result code if it was requested.
ResponseData	Contains the entire contents of the Server response.
ResponsePreviousBalance	Balance before this transaction started.
ResponseRetrievalNumber	Reference number returned from the Paymentech host.
ResponseSequenceNumber	SequenceNumber echoed from the authorization.
ResponseText	Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result.
ResponseTrace	Trace number returned for Stored Value transactions.
SequenceNumber	Sequence number of the transaction.
Server	The URL for the PaymenTech NetConnect server.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
TerminalNumber	Terminal number assigned by Paymentech.
Timeout	A timeout for the component.
TransactionAmount	Purchase amount for an authorization.
UserId	UserId for authentication with the NetConnect Server.

Method List

---

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

ActivateCard	Activates a Gift Card.
AddValue	Activates and/or adds funds to a Gift Card.
BalanceInquiry	Retrieves the balance remaining on a gift card.
Config	Sets or retrieves a configuration setting.
DeactivateCard	Deactivates a gift card.
Interrupt	Interrupt the current method.
ReactivateCard	Re-activates Gift Card that has been previously deactivated.
RedeemCard	Deducts funds from a gift card for the purchase of goods or services.
Reset	Clears all properties to their default values.
VoidTransaction	Voids a transaction in the current batch.

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.

Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

---

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

VoiceAuthCode	When VoiceAuthCode contains a value, the component will send a Force transaction to the Paymentech system.
CustomerDefinedData	Additional transaction identification data.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.