CCGiftCard Component [TSYS Integrator V6]
Properties
Methods
Events
Configuration Settings
The CCGiftCard component is used to manipulate funds on Gift and Prepaid Cards using the Vital/TSYS payment
system. This component supports card-present gift card
transactions, and allows for simple, direct, secure communication to the Vital/TSYS 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
This component supports two different kinds of Stored Value cards. Gift Cards and Prepaid Cards.
Gift Cards support only the Fifth/Third and Stored Value Systems (SVS) ReceivingInstitutions,
and a merchant must have software (such as this component) to authorize gift card Purchase
(redemption) transactions. On the other hand, Prepaid cards (once activated) authorize exactly like
credit cards, and can be used at any store. Examples of gift and cards include a retailer's gift card,
a prepaid telephone card, and a reloadable subway pass. Examples of prepaid cards would be the prepaid
cards purchased at shopping malls, or sometimes given away as promotional gimmicks. Not included in either
of these are government income-support cards, otherwise known as EBT cards or electronic food stamps.
(Use the CCBENEFIT component for EBT cards).
The CCGiftCard component makes these 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, SSL handshakes, or data
packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:
First, set the merchant properties with setup information acquired from your member bank or processor. For instance:
CCGiftCard1.MerchantBankId = "999995"
CCGiftCard1.MerchantNumber = "888000002447"
CCGiftCard1.MerchantName = "TEST_MERCHANT"
CCGiftCard1.MerchantTerminalNumber = "1515"
CCGiftCard1.MerchantStoreNumber = "5999"
CCGiftCard1.MerchantCategoryCode = "5999"
CCGiftCard1.MerchantCity = "Durham"
CCGiftCard1.MerchantState = "NC"
CCGiftCard1.MerchantZip = "27713"
CCGiftCard1.MerchantTimeZone = "705"
CCGiftCard1.MerchantABANumber = "123456789"
CCGiftCard1.MerchantSettlementAgent = "V123"
CCGiftCard1.AgentBankNumber = "000000"
CCGiftCard1.AgentChainNumber = "111111"
CCGiftCard1.IndustryType = itRetail
CCGiftCard1.ReceivingInstitution = riFifthThird
Next, set properties that contain details about the transaction. The TransactionNumber is a sequence number,
and should be incremented for each transaction you send. TransactionAmount is the amount of sale, plus any
CashBackAmount returned to the customer, formatted with an implicit decimal place (CashBackAmount is
only applicable to the ttGiftCardPurchase TransactionType). The Card data
for Prepaid cards can be either track1 or track2, but Gift cards support only the dsTrack2 Card.
Both types support manual entry via the Card, Card, and Card
properties.
In addition, you are also be required to set an EmployeeId and BatchNumber for Gift Card transactions.
(These are ignored for Prepaid transactions). Even though Gift Card transactions are not submitted for
settlement, the BatchNumber should reflect the batch sequence number
of the current batch. The EmployeeId is a unique number used to identify the employee
operating the terminal being used to issue gift cards. For example:
CCGiftCard1.TransactionNumber = 1
CCGiftCard1.BatchNumber = 123
CCGiftCard1.EmployeeId = "12345678"
CCGiftCard1.TransactionAmount = "1000"
CCGiftCard1.CashBackAmount = "300"
CCGiftCard1.CardTrack2Data = "9999999800002773=09121015432112345678"
The CCGiftCard component supports both Gift Card and Prepaid Cards, so you should make sure to choose the correct TransactionType for the type of card you are using. Then call the Authorize method to submit the transaction.
CCGiftCard1.TransactionType = ttGiftCardPurchase
CCGiftCard1.Authorize()
When the component receives a response from the Vital/TSYS servers, the result of the authorization will be
displayed in several Response properties. The Response indicates whether the transaction was approved,
and the remaining properties provide additional information about the transaction.
Note that Gift Card and Prepaid Card transactions, with the exception of the ttPrepaidCardPurchase
TransactionType are real-time transactions, and cannot be settled with the CCSETTLE component.
ttPrepaidCardPurchase is identical to a credit card purchase made with the CCRETAIL component, so it
must be settled with the CCSETTLE component. However, using this component to authorize Prepaid card
transactions allows you to retrieve balance information and allow partial authorizations.
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.
| |
| Authorize | Sends a Gift Card transaction. |
| Config | Sets or retrieves a configuration setting. |
| GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
| Interrupt | Interrupts the current action. |
| Reset | Clears all properties to their default values. |
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.
| |
| Connected | Fired immediately after a connection completes (or fails). |
| DataPacketIn | Fired when receiving a data packet from the transaction server. |
| DataPacketOut | Fired when sending a data packet to the transaction server. |
| Disconnected | Fired when a connection is closed. |
| 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.
| |
| DeveloperId | Number that indicates the software's origin to the TSYS network. |
| Retry | Set this to retry a failed transaction. |
| VersionId | Indicates the software's version to the Vital network. |
| ResponseStoreNumber | Check this field against the original Merchant StoreNumber. |
| ResponseTerminalNumber | Check this field against the original Merchant TerminalNumber. |
| Port | The port to which transactions are posted. |
| Server | The server to which transactions are posted. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
