PTechGiftCard Component
Properties Methods Events Configuration Settings Errors
The PTechGiftCard 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 TLS/SSL gateway 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
nsoftware.InPayDirect.Ptechgiftcard
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 EntryDataSource is Manually Entered, the merchant should fill the Number, ExpMonth, and ExpYear fields. Otherwise, you should fill the MagneticStripe field with the Track 2 data read from the back of the card, and set EntryDataSource 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 MagneticStripe (or Number) 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, 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 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, AuthorizedAmount 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 Code field, with human-readable text appearing in Text. Like the PTechCharge component, there are several other Response fields which will contain data that should be logged. However, there are a few new fields specific to the PTechGiftCard component: Balance will be returned after all transactions except VoidTransaction, and will contain the current balance of the Gift Card. PreviousBalance will indicate the balance BEFORE the last transaction went through. The Trace field 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 PTechHostSettle 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.
Card | Contains the customer's credit card information. |
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. |
Proxy | A set of properties related to proxy access. |
Response | Contains the response to the authorization. |
SequenceNumber | Sequence number of the transaction. |
Server | The URL for the PaymenTech NetConnect server. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
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.
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
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. |
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. |
SystemInformation | System Information field for Batch Inquiry and Release transactions. |
SettlementMode | Indicates whether the component uses Paymentech's Host Capture or Terminal Capture system. |
ResponsePOSRetrievalNumber | POS Retrieval Number sent in the request, echoed back in the response. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
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. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
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. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
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). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
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. |