TSYSGiftCard Module

Properties   Methods   Events   Config Settings   Errors  

The TSYSGiftCard module is used to manipulate funds on Gift and Prepaid Cards using the Vital/TSYS payment system. This module supports card-present gift card transactions, and allows for simple, direct, secure communication to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This module can be integrated into web pages or stand- alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the module, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

DPaymentsSDK.Tsysgiftcard

Remarks

This class 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 class) 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 TSYSBenefit class for EBT cards).

The TSYSGiftCard class 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, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

First, set the merchant properties with setup information acquired from your member bank or processor. For instance:

TSYSGiftCard1.MerchantBankId = "999995" TSYSGiftCard1.MerchantNumber = "888000002447" TSYSGiftCard1.MerchantName = "TEST_MERCHANT" TSYSGiftCard1.MerchantTerminalNumber = "1515" TSYSGiftCard1.MerchantStoreNumber = "5999" TSYSGiftCard1.MerchantCategoryCode = "5999" TSYSGiftCard1.MerchantCity = "Durham" TSYSGiftCard1.MerchantState = "NC" TSYSGiftCard1.MerchantZip = "27713" TSYSGiftCard1.MerchantTimeZone = "705" TSYSGiftCard1.MerchantABANumber = "123456789" TSYSGiftCard1.MerchantSettlementAgent = "V123" TSYSGiftCard1.AgentBankNumber = "000000" TSYSGiftCard1.AgentChainNumber = "111111" TSYSGiftCard1.IndustryType = itRetail TSYSGiftCard1.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 CardMagneticStripe data for Prepaid cards can be either track1 or track2, but Gift cards support only the dsTrack2 CardEntryDataSource. Both types support manual entry via the CardNumber, CardExpMonth, and CardExpYear 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:

TSYSGiftCard1.TransactionNumber = 1 TSYSGiftCard1.BatchNumber = 123 TSYSGiftCard1.EmployeeId = "12345678" TSYSGiftCard1.TransactionAmount = "1000" TSYSGiftCard1.CashBackAmount = "300" TSYSGiftCard1.CardTrack2Data = "9999999800002773=09121015432112345678"

The TSYSGiftCard class 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.

TSYSGiftCard1.TransactionType = ttGiftCardPurchase TSYSGiftCard1.Authorize()

When the class receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode 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 TSYSSettle class. ttPrepaidCardPurchase is identical to a credit card purchase made with the TSYSRetail class, so it must be settled with the TSYSSettle class. However, using this class 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AgentBankNumber Property (TSYSGiftCard Module)

Identifies a specific agent entity of the member bank or processor.

Syntax

• Swift
• Objective-C

public var agentBankNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=agentBankNumber,setter=setAgentBankNumber:) NSString* agentBankNumber;

- (NSString*)agentBankNumber;
- (void)setAgentBankNumber :(NSString*)newAgentBankNumber;

Default Value

"000000"

Remarks

This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purposes of identifying a specific agent entity of the member bank or processor.

AgentChainNumber Property (TSYSGiftCard Module)

Identifies a specific chain of an agent organization.

Syntax

• Swift
• Objective-C

public var agentChainNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=agentChainNumber,setter=setAgentChainNumber:) NSString* agentChainNumber;

- (NSString*)agentChainNumber;
- (void)setAgentChainNumber :(NSString*)newAgentChainNumber;

Default Value

"000000"

Remarks

This field contains a six digit number assigned by the merchant's bank or processor. This field is issued by the merchant's member bank or processor for purpose of identifying a specific chain of an agent organization.

BatchNumber Property (TSYSGiftCard Module)

The batch number that this transaction will be included in.

Syntax

• Swift
• Objective-C

public var batchNumber: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=batchNumber,setter=setBatchNumber:) int batchNumber;

- (int)batchNumber;
- (void)setBatchNumber :(int)newBatchNumber;

Default Value

1

Remarks

Unlike regular credit card transactions, Debit, EBT, and GiftCard transactions require that the Batch Number be sent in the authorization request. This number should be the same number you set to the TSYSSettle class's BatchNumber property. The range is from 1 to 999.

Note, this property is ignored for Prepaid Card transactions.

Card Property (TSYSGiftCard Module)

Contains the customer's credit card information.

Syntax

• Swift
• Objective-C

public var card: CCCard {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cardType,setter=setCardType:) int cardType;

- (int)cardType;
- (void)setCardType :(int)newCardType;

@property (nonatomic,readwrite,assign,getter=cardCVVData,setter=setCardCVVData:) NSString* cardCVVData;

- (NSString*)cardCVVData;
- (void)setCardCVVData :(NSString*)newCardCVVData;

@property (nonatomic,readwrite,assign,getter=cardCVVPresence,setter=setCardCVVPresence:) int cardCVVPresence;

- (int)cardCVVPresence;
- (void)setCardCVVPresence :(int)newCardCVVPresence;

@property (nonatomic,readwrite,assign,getter=cardEntryDataSource,setter=setCardEntryDataSource:) int cardEntryDataSource;

- (int)cardEntryDataSource;
- (void)setCardEntryDataSource :(int)newCardEntryDataSource;

@property (nonatomic,readwrite,assign,getter=cardExpMonth,setter=setCardExpMonth:) int cardExpMonth;

- (int)cardExpMonth;
- (void)setCardExpMonth :(int)newCardExpMonth;

@property (nonatomic,readwrite,assign,getter=cardExpYear,setter=setCardExpYear:) int cardExpYear;

- (int)cardExpYear;
- (void)setCardExpYear :(int)newCardExpYear;

@property (nonatomic,readwrite,assign,getter=cardIsEncrypted,setter=setCardIsEncrypted:) BOOL cardIsEncrypted;

- (BOOL)cardIsEncrypted;
- (void)setCardIsEncrypted :(BOOL)newCardIsEncrypted;

@property (nonatomic,readwrite,assign,getter=cardMagneticStripe,setter=setCardMagneticStripe:) NSString* cardMagneticStripe;

- (NSString*)cardMagneticStripe;
- (void)setCardMagneticStripe :(NSString*)newCardMagneticStripe;

@property (nonatomic,readwrite,assign,getter=cardNumber,setter=setCardNumber:) NSString* cardNumber;

- (NSString*)cardNumber;
- (void)setCardNumber :(NSString*)newCardNumber;

 

Default Value

15

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 for swiped cards, or a , , and for manually entered cards. ( indicates which set of properties will be used). See the CCCard type for more information.

Note that Track1 data is only applicable for Prepaid cards. For all other gift cards you must use Track2 data, or manual entry.

CashBackAmount Property (TSYSGiftCard Module)

Amount returned to the customer in cash.

Syntax

• Swift
• Objective-C

public var cashBackAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=cashBackAmount,setter=setCashBackAmount:) NSString* cashBackAmount;

- (NSString*)cashBackAmount;
- (void)setCashBackAmount :(NSString*)newCashBackAmount;

Default Value

""

Remarks

This property may contain an optional cash back amount when authorizing a Debit Purchase transaction, EBT Cash Benefit Purchase, or a Gift Card Purchase transaction. The value of TransactionAmount must reflect the cost of the goods or service purchased plus this CashBackAmount.

Note: CashBackAmount must be empty for Restaurant IndustryType as this is not supported by TSYS.

Note: TSYS does not support transactions containing both CashBack and Gratuity/Tip amounts.

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.

Note: For EBT Withdrawal transactions, CashBackAmount must be empty. However, when creating detail records for the settlement of the transaction, the DebitCashBack in the detail record must match the TransactionAmount for the authorization.

Note, this property is only valid for the ttGiftCardPurchase TransactionType. Trying to send any other TransactionType with cash back will cause the class to fail with an error.

CustomerAddress Property (TSYSGiftCard Module)

The customer's billing address.

Syntax

• Swift
• Objective-C

public var customerAddress: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=customerAddress,setter=setCustomerAddress:) NSString* customerAddress;

- (NSString*)customerAddress;
- (void)setCustomerAddress :(NSString*)newCustomerAddress;

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in this field. City and state are not included, and the zip code is set in the CustomerZip property.

This property is an alphanumeric field. Due to concerns with International addresses and changing specifications, the component does not do any processing on the address. The address will be included in the authorization request exactly as you set it.

Per TSYS specs, the following rules apply:

• In the address, numbers are not spelled out. "First Street" becomes "1ST Street," "Second" becomes "2ND," and so on.
• There must be a (space) between two consecutive data elements that are only numeric.

Note the following examples:

• "1234 56th Street" is equivalent to: "1234 56Street"
• "1234 56th Street" is NOT equivalent to: "123456Street" //do not strip all spaces between two numbers
• "1391 ELM STREET" is equivalent to: "1391ELMSTREET"
• "P.O. BOX 24356" is equivalent to: "POBOX24356"

The length of this property is 19 characters, and any string longer than this . If the customer's address is much greater than the length of this field, it is admissible to include only the street number in this field.

CustomerZip Property (TSYSGiftCard Module)

Customer's zip code (or postal code if outside of the USA).

Syntax

• Swift
• Objective-C

public var customerZip: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=customerZip,setter=setCustomerZip:) NSString* customerZip;

- (NSString*)customerZip;
- (void)setCustomerZip :(NSString*)newCustomerZip;

Default Value

""

Remarks

This field is used as part of the Address Verification Service (AVS). If the customer resides within the United States, this field should contain the five or nine digit zip code as it appears on the customer's monthly statement. If the customer's billing address is outside of the United States, this field should contain the customer's postal code.

This field is an alphanumeric field with a maximum length of nine characters. Spaces and dashes are automatically stripped when the property is set.

EmployeeId Property (TSYSGiftCard Module)

Identification number of the Employee making this transaction.

Syntax

• Swift
• Objective-C

public var employeeId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=employeeId,setter=setEmployeeId:) NSString* employeeId;

- (NSString*)employeeId;
- (void)setEmployeeId :(NSString*)newEmployeeId;

Default Value

""

Remarks

This property identifies the operator initiating this transaction, and should be a unique value defined for each employee within the merchant. This field is only required if the merchant participates in a program where operator level reporting is performed.

Note, this property is ignored for Prepaid Card transactions.

IndustryType Property (TSYSGiftCard Module)

Code which indicates the industry the merchant is engaged in.

Syntax

• Swift
• Objective-C

public var industryType: TsysgiftcardIndustryTypes {
  get {...}
  set {...}
}

public enum TsysgiftcardIndustryTypes: Int32 {
  case sitUnknown = 0
  case sitRetail = 1
  case sitRestaurant = 2
  case sitGroceryStore = 3
  case sitDirectMarketing = 4
  case sitHotel = 5
  case sitAutoRental = 6
  case sitPassengerTransport = 7
}

@property (nonatomic,readwrite,assign,getter=industryType,setter=setIndustryType:) int industryType;

- (int)industryType;
- (void)setIndustryType :(int)newIndustryType;

Default Value

1

Remarks

This property is used to identify the industry type of the merchant submitting the authorization request. The following table lists the industry types supported by this class.

Note: American Express cards are NOT currently supported in the sitAutoRental industry.

Note: itDirectMarketing, itHotel, and itAutoRental are NOT supported for this class All Debit, EBT, and Gift Card transactions must be face-to-face card present transactions.

Merchant Property (TSYSGiftCard Module)

Contains the merchant's setup information.

Syntax

• Swift
• Objective-C

public var merchant: TSYSMerchant {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantBankId,setter=setMerchantBankId:) NSString* merchantBankId;

- (NSString*)merchantBankId;
- (void)setMerchantBankId :(NSString*)newMerchantBankId;

@property (nonatomic,readwrite,assign,getter=merchantCategoryCode,setter=setMerchantCategoryCode:) NSString* merchantCategoryCode;

- (NSString*)merchantCategoryCode;
- (void)setMerchantCategoryCode :(NSString*)newMerchantCategoryCode;

@property (nonatomic,readwrite,assign,getter=merchantCity,setter=setMerchantCity:) NSString* merchantCity;

- (NSString*)merchantCity;
- (void)setMerchantCity :(NSString*)newMerchantCity;

@property (nonatomic,readwrite,assign,getter=merchantCountryCode,setter=setMerchantCountryCode:) NSString* merchantCountryCode;

- (NSString*)merchantCountryCode;
- (void)setMerchantCountryCode :(NSString*)newMerchantCountryCode;

@property (nonatomic,readwrite,assign,getter=merchantCurrencyCode,setter=setMerchantCurrencyCode:) NSString* merchantCurrencyCode;

- (NSString*)merchantCurrencyCode;
- (void)setMerchantCurrencyCode :(NSString*)newMerchantCurrencyCode;

@property (nonatomic,readwrite,assign,getter=merchantLanguage,setter=setMerchantLanguage:) NSString* merchantLanguage;

- (NSString*)merchantLanguage;
- (void)setMerchantLanguage :(NSString*)newMerchantLanguage;

@property (nonatomic,readwrite,assign,getter=merchantName,setter=setMerchantName:) NSString* merchantName;

- (NSString*)merchantName;
- (void)setMerchantName :(NSString*)newMerchantName;

@property (nonatomic,readwrite,assign,getter=merchantNumber,setter=setMerchantNumber:) NSString* merchantNumber;

- (NSString*)merchantNumber;
- (void)setMerchantNumber :(NSString*)newMerchantNumber;

@property (nonatomic,readwrite,assign,getter=merchantPhone,setter=setMerchantPhone:) NSString* merchantPhone;

- (NSString*)merchantPhone;
- (void)setMerchantPhone :(NSString*)newMerchantPhone;

@property (nonatomic,readwrite,assign,getter=merchantServicePhone,setter=setMerchantServicePhone:) NSString* merchantServicePhone;

- (NSString*)merchantServicePhone;
- (void)setMerchantServicePhone :(NSString*)newMerchantServicePhone;

@property (nonatomic,readwrite,assign,getter=merchantState,setter=setMerchantState:) NSString* merchantState;

- (NSString*)merchantState;
- (void)setMerchantState :(NSString*)newMerchantState;

@property (nonatomic,readwrite,assign,getter=merchantStoreNumber,setter=setMerchantStoreNumber:) NSString* merchantStoreNumber;

- (NSString*)merchantStoreNumber;
- (void)setMerchantStoreNumber :(NSString*)newMerchantStoreNumber;

@property (nonatomic,readwrite,assign,getter=merchantStreetAddress,setter=setMerchantStreetAddress:) NSString* merchantStreetAddress;

- (NSString*)merchantStreetAddress;
- (void)setMerchantStreetAddress :(NSString*)newMerchantStreetAddress;

@property (nonatomic,readwrite,assign,getter=merchantTerminalNumber,setter=setMerchantTerminalNumber:) NSString* merchantTerminalNumber;

- (NSString*)merchantTerminalNumber;
- (void)setMerchantTerminalNumber :(NSString*)newMerchantTerminalNumber;

@property (nonatomic,readwrite,assign,getter=merchantTimeZone,setter=setMerchantTimeZone:) NSString* merchantTimeZone;

- (NSString*)merchantTimeZone;
- (void)setMerchantTimeZone :(NSString*)newMerchantTimeZone;

@property (nonatomic,readwrite,assign,getter=merchantZip,setter=setMerchantZip:) NSString* merchantZip;

- (NSString*)merchantZip;
- (void)setMerchantZip :(NSString*)newMerchantZip;

 

Default Value

15

Remarks

This property must be set to an instance of the TSYSMerchant type, which will contain information to identify the merchant to the TSYS processing server. Please see the TSYSMerchant type for a list of available properties.

MerchantABANumber Property (TSYSGiftCard Module)

Merchant's routing number.

Syntax

• Swift
• Objective-C

public var merchantABANumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantABANumber,setter=setMerchantABANumber:) NSString* merchantABANumber;

- (NSString*)merchantABANumber;
- (void)setMerchantABANumber :(NSString*)newMerchantABANumber;

Default Value

""

Remarks

This property identifies the merchant to a direct debit switch, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 9 digits in length.

MerchantSettlementAgent Property (TSYSGiftCard Module)

Merchant's settling agent.

Syntax

• Swift
• Objective-C

public var merchantSettlementAgent: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=merchantSettlementAgent,setter=setMerchantSettlementAgent:) NSString* merchantSettlementAgent;

- (NSString*)merchantSettlementAgent;
- (void)setMerchantSettlementAgent :(NSString*)newMerchantSettlementAgent;

Default Value

""

Remarks

This property identifies the merchant settling agent, and must be supplied for all debit request transactions. This number is provided by the signing member or processor, and should be exactly 4 digits in length.

OriginalPurchaseDate Property (TSYSGiftCard Module)

Date and time of original purchase, used for returns.

Syntax

• Swift
• Objective-C

public var originalPurchaseDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=originalPurchaseDate,setter=setOriginalPurchaseDate:) NSString* originalPurchaseDate;

- (NSString*)originalPurchaseDate;
- (void)setOriginalPurchaseDate :(NSString*)newOriginalPurchaseDate;

Default Value

""

Remarks

This property is only applicable for Debit Credit transactions and Gift Card Refund transactions. If supplied, this property must be 8 characters long and formatted as "MMDDhhmm" (month, day, hour, minute).

Note that this property is only valid for the ttGiftCardRefund TransactionType, and will be ignored for all other transactions.

PartialRedemption Property (TSYSGiftCard Module)

Partial Redemption indicator.

Syntax

• Swift
• Objective-C

public var partialRedemption: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=partialRedemption,setter=setPartialRedemption:) BOOL partialRedemption;

- (BOOL)partialRedemption;
- (void)setPartialRedemption :(BOOL)newPartialRedemption;

Default Value

False

Remarks

If the customer does not have enough on his stored value card to cover the complete cost of the purchase, the merchant may request that the host perform a partial redemption. The stored value card will be used to fund as much of the transaction as possible, and the remainder may be funded by some other form of payment. When PartialRedemption is set to True, the host will supply the actual amount authorized from the stored value card in the ResponseAuthorizedAmount property.

Note that the ResponseAuthorizedAmount will only contain a value if PartialRedemption is set to True, and will remain blank otherwise. If the Stored Value card has a zero balance before submitting this transaction, it will be declined regardless of the value of PartialRedemption.

ReceivingInstitution Property (TSYSGiftCard Module)

Indicates which gift card network to use.

Syntax

• Swift
• Objective-C

public var receivingInstitution: TsysgiftcardReceivingInstitutions {
  get {...}
  set {...}
}

public enum TsysgiftcardReceivingInstitutions: Int32 {
  case riStoredValueSystems = 0
  case riFifthThird = 1
}

@property (nonatomic,readwrite,assign,getter=receivingInstitution,setter=setReceivingInstitution:) int receivingInstitution;

- (int)receivingInstitution;
- (void)setReceivingInstitution :(int)newReceivingInstitution;

Default Value

0

Remarks

This field contains a secondary network routing identifier, which indicates the gift card network to be used to process transactions. This is necessary because private issue gift card number ranges may conflict with ranges assigned to major credit card issuers. The supported receiving institutions include:

Note, this property is ignored for Prepaid Card transactions.

Response Property (TSYSGiftCard Module)

Contains the response to a debit authorization request.

Syntax

• Swift
• Objective-C

public var response: TSYSDebitResponse {
  get {...}
}

@property (nonatomic,readonly,assign,getter=responseApprovalCode) NSString* responseApprovalCode;

- (NSString*)responseApprovalCode;

@property (nonatomic,readonly,assign,getter=responseAuthorizedAmount) NSString* responseAuthorizedAmount;

- (NSString*)responseAuthorizedAmount;

@property (nonatomic,readonly,assign,getter=responseAuthSource) NSString* responseAuthSource;

- (NSString*)responseAuthSource;

@property (nonatomic,readonly,assign,getter=responseAVSResult) NSString* responseAVSResult;

- (NSString*)responseAVSResult;

@property (nonatomic,readonly,assign,getter=responseBalance) NSString* responseBalance;

- (NSString*)responseBalance;

@property (nonatomic,readonly,assign,getter=responseCode) NSString* responseCode;

- (NSString*)responseCode;

@property (nonatomic,readonly,assign,getter=responseCVVResult) NSString* responseCVVResult;

- (NSString*)responseCVVResult;

@property (nonatomic,readonly,assign,getter=responseHostMessageId) NSString* responseHostMessageId;

- (NSString*)responseHostMessageId;

@property (nonatomic,readonly,assign,getter=responseNetworkId) NSString* responseNetworkId;

- (NSString*)responseNetworkId;

@property (nonatomic,readonly,assign,getter=responseRetrievalNumber) NSString* responseRetrievalNumber;

- (NSString*)responseRetrievalNumber;

@property (nonatomic,readonly,assign,getter=responseReturnedACI) NSString* responseReturnedACI;

- (NSString*)responseReturnedACI;

@property (nonatomic,readonly,assign,getter=responseSettleDate) NSString* responseSettleDate;

- (NSString*)responseSettleDate;

@property (nonatomic,readonly,assign,getter=responseText) NSString* responseText;

- (NSString*)responseText;

@property (nonatomic,readonly,assign,getter=responseTrace) NSString* responseTrace;

- (NSString*)responseTrace;

@property (nonatomic,readonly,assign,getter=responseTransactionDate) NSString* responseTransactionDate;

- (NSString*)responseTransactionDate;

@property (nonatomic,readonly,assign,getter=responseTransactionId) NSString* responseTransactionId;

- (NSString*)responseTransactionId;

@property (nonatomic,readonly,assign,getter=responseTransactionNumber) NSString* responseTransactionNumber;

- (NSString*)responseTransactionNumber;

@property (nonatomic,readonly,assign,getter=responseTransactionTime) NSString* responseTransactionTime;

- (NSString*)responseTransactionTime;

@property (nonatomic,readonly,assign,getter=responseValidationCode) NSString* responseValidationCode;

- (NSString*)responseValidationCode;

 

Default Value

15

Remarks

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

SSLAcceptServerCertEncoded Property (TSYSGiftCard Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (TSYSGiftCard Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (TSYSGiftCard Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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 (TSYSGiftCard Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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 (TSYSGiftCard Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: TsysgiftcardSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum TsysgiftcardSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (TSYSGiftCard Module)

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

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (TSYSGiftCard Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: TsysgiftcardSSLProviders {
  get {...}
  set {...}
}

public enum TsysgiftcardSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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 will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (TSYSGiftCard Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (TSYSGiftCard Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

TransactionAmount Property (TSYSGiftCard Module)

Purchase amount to be authorized.

Syntax

• Swift
• Objective-C

public var transactionAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transactionAmount,setter=setTransactionAmount:) NSString* transactionAmount;

- (NSString*)transactionAmount;
- (void)setTransactionAmount :(NSString*)newTransactionAmount;

Default Value

""

Remarks

This field 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 (TSYSGiftCard Module)

Sequence number of this transaction.

Syntax

• Swift
• Objective-C

public var transactionNumber: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transactionNumber,setter=setTransactionNumber:) int transactionNumber;

- (int)transactionNumber;
- (void)setTransactionNumber :(int)newTransactionNumber;

Default Value

0

Remarks

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the ResponseTransactionNumber for the purpose of assisting in the matching of authorization request and response messages. This value must be in the range 0001 to 9999 and should be incremented on each authorization request message. This number should automatically increment from 9999 to 1. 0 is an invalid transaction number.

TransactionType Property (TSYSGiftCard Module)

Specifies the type of Gift Card transaction to process.

Syntax

• Swift
• Objective-C

public var transactionType: TsysgiftcardTransactionTypes {
  get {...}
  set {...}
}

public enum TsysgiftcardTransactionTypes: Int32 {
  case ttGiftCardPurchase = 15
  case ttGiftCardRefund = 16
  case ttGiftCardAddValue = 17
  case ttGiftCardDecreaseValue = 18
  case ttGiftCardCloseCard = 19
  case ttGiftCardBalanceInquiry = 20
  case ttPrepaidCardActivation = 21
  case ttPrepaidCardLoad = 22
  case ttPrepaidCardPurchase = 23
  case ttPrepaidCardBalanceInquiry = 24
}

@property (nonatomic,readwrite,assign,getter=transactionType,setter=setTransactionType:) int transactionType;

- (int)transactionType;
- (void)setTransactionType :(int)newTransactionType;

Default Value

15

Remarks

This property indicates the type of Gift Card transaction to send. The following table explains the transaction types in detail:

Authorize Method (TSYSGiftCard Module)

Sends a Gift Card transaction.

Syntax

• Swift
• Objective-C

public func authorize() throws -> Void

- (void)authorize;

Remarks

This method sends a Gift Card authorization request to the Vital/TSYS host. The type of transaction sent is based upon the value of the TransactionType property. If the request was successful, the ResponseCode property will contain "00".

Note that only ttPrepaidCardPurchase transactions are settled with the TSYSSettle class. All other transactions (including ttGiftCardPurchase) take place in real time. Instead of using this class to authorize Prepaid Card purchases, you may opt to use the TSYSRetail class instead. However, this class allows you to support PartialRedemption, and will also return the prepaid card's available balance in the ResponseBalance property.

Config Method (TSYSGiftCard Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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.

GetDetailAggregate Method (TSYSGiftCard Module)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

• Swift
• Objective-C

public func getDetailAggregate() throws -> String

- (NSString*)getDetailAggregate;

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle class's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord class to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method .

An example of how this method is used is shown below:

TSYSRetail.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

Note that ttPrepaidCardPurchase transactions are identical to regular credit card authorizations, and thus must be settled like credit card transactions. Attempting to call this method for any other TransactionType will cause the class to fail with an error.

Interrupt Method (TSYSGiftCard Module)

Interrupts the current action.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (TSYSGiftCard Module)

Clears all properties to their default values.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

Connected Event (TSYSGiftCard Module)

Fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)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 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 (TSYSGiftCard Module)

Fired when receiving a data packet from the transaction server.

Syntax

• Swift
• Objective-C

func onDataPacketIn(dataPacket: Data)

- (void)onDataPacketIn:(NSData*)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 (TSYSGiftCard Module)

Fired when sending a data packet to the transaction server.

Syntax

• Swift
• Objective-C

func onDataPacketOut(dataPacket: Data)

- (void)onDataPacketOut:(NSData*)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 (TSYSGiftCard Module)

Fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)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 Winsock. Description contains a description of this code. The value of StatusCode is equal to the value of the Winsock error.

Please refer to the Error Codes section for more information.

Error Event (TSYSGiftCard Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing.

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 (TSYSGiftCard Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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 (TSYSGiftCard Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. This event tracks 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 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 to indicate which track is stored in the 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 , , and fields, and 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 to edsManualEntryNoCardReader. If you wish to set any other value for the , 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 . If you set the , , and fields, but is set to edsTrack2, the class will look for data when authorizing the transaction, and will because none is present.

Fields

Constructors

public init()

public init(number: , expMonth: , expYear: )

public init(magneticStripe: , entryDataSource: )

TSYSDebitResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the TSYSDebit, TSYSGiftCard, or TSYSBenefit class. The properties contained by this type are listed below.

Fields

Constructors

public init()

TSYSMerchant Type

Contains the merchant's setup information.

Remarks

This type contains the merchant's setup information. This includes the merchant identification, bank routing information, language, location, and other properties that identify the merchant to the TSYS server. Some of the information in these properties will be included on the customer's credit card statement, such as the merchant's , , , etc.

Fields

Constructors

public init()

Config Settings (TSYSGiftCard Module)

TSYSGiftCard Config Settings

Base Config Settings

Trappable Errors (TSYSGiftCard Module)

TSYSGiftCard Errors

TCPClient Errors

SSL Errors

TCP/IP Errors