TSYSLevel3 Module

Properties   Methods   Events   Config Settings   Errors  

The TSYSLevel3 module is a tool used to create Level3 Corporate Purchasing Card addendum aggregates, which can then be passed to the TSYSSETTLE module and settled.

Syntax

DPaymentsSDK.Tsyslevel3

Remarks

This TSYSLevel3 class creates Level III addendum data, which can be sent in the settlement to achieve a better interchange rate when accepting corporate purchasing cards. The Level III addendum allows the merchant to send very detailed information about every item that was purchased by the card holder, as well as tax and shipping information.

This class creates a different addendum aggregate based on the CardType. Visa and MasterCard addendums differ slightly, and therefore a slightly different set of properties are required for each.

The following properties are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• LineItemsDescription
• LineItemsDiscountAmount
• LineItemsProductCode
• LineItemsQuantity
• LineItemsTaxAmount
• LineItemsTaxRate
• LineItemsTotal
• LineItemsUnits

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• LineItemsCommodityCode
• LineItemsUnitCost

Additional properties for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• LineItemsDiscountRate
• LineItemsTaxIncluded
• LineItemsTaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType: 'First authorize the credit card TSYSECommerce1.TransactionAmount = "53" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. 'The following properties are required for a Visa Corporate Purchasing Card: TSYSLevel3.CardType = tctVisa TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "purchOrdNum" TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number TSYSLevel3.CommodityCode = "fake" TSYSLevel3.DiscountAmount = "0" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "840" TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo" TSYSLevel3.OrderDate = "060526" TSYSLevel3.FreightTaxAmount = "0" TSYSLevel3.FreightTaxRate = "0" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()

A Level III addendum for the tctMasterCard CardType is constructed similarly:

'First authorize the credit card TSYSECommerce1.TransactionAmount = "200" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. TSYSLevel3.cardType = tctMasterCard TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "cardholderRefId" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "USA" TSYSLevel3.AlternateTaxAmount = "0" TSYSLevel3.AlternateTaxId = "altTaxId" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemDescription(0) = "bolt" TSYSLevel3.LineItemProductCode(0) = "BOLT6x20" TSYSLevel3.LineItemQuantity(0) = 2 TSYSLevel3.LineItemUnits(0) = "each" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemTaxType(0) = "taxType" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTaxIncluded(0) = False TSYSLevel3.LineItemTotal(0) = "100" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemDiscountRate(0) = "0" TSYSLevel3.LineItemDescription(1) = "flange nut" TSYSLevel3.LineItemProductCode(1) = "FLANGE6" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "each" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemTaxType(1) = "taxType" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTaxIncluded(1) = False TSYSLevel3.LineItemTotal(1) = "100" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemDiscountRate(1) = "0" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle1.DetailAddendum(1) = TSYSLevel3.GetAddendum()

Note that while Level3 addendum data is only applicable to corporate purchasing cards, however you may send Level3 data for all Visa and Master Card cards if you wish.

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.

AlternateTaxAmount Property (TSYSLevel3 Module)

Secondary tax amount (only applicable in some countries).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=alternateTaxAmount,setter=setAlternateTaxAmount:) NSString* alternateTaxAmount;

- (NSString*)alternateTaxAmount;
- (void)setAlternateTaxAmount :(NSString*)newAlternateTaxAmount;

Default Value

""

Remarks

This property is used to record the second tax amount in countries where more than one type of tax can be applied to purchases. This amount must be included in the TransactionAmount of the original transaction.

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. This property is only used for MasterCard Corporate Purchasing Cards.

AlternateTaxId Property (TSYSLevel3 Module)

Tax Id number of the merchant that reported the AlternateTaxAmount .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=alternateTaxId,setter=setAlternateTaxId:) NSString* alternateTaxId;

- (NSString*)alternateTaxId;
- (void)setAlternateTaxId :(NSString*)newAlternateTaxId;

Default Value

""

Remarks

This property contains the tax identification number of the merchant that reported the AlternateTaxAmount This property is only used for MasterCard Corporate Purchasing Cards.

CardType Property (TSYSLevel3 Module)

The card type for which a Level2 or Level3 addendum will be created.

Syntax

• Swift
• Objective-C

public var cardType: Tsyslevel3CardTypes {
  get {...}
  set {...}
}

public enum Tsyslevel3CardTypes: Int32 {
  case tctVisa = 0
  case tctMasterCard = 1
  case tctAmericanExpress = 2
}

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

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

Default Value

0

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

CommodityCode Property (TSYSLevel3 Module)

Code indicating the type of goods or services sold.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=commodityCode,setter=setCommodityCode:) NSString* commodityCode;

- (NSString*)commodityCode;
- (void)setCommodityCode :(NSString*)newCommodityCode;

Default Value

""

Remarks

This property should contain an international description code of the overall goods or services being supplied. The acquirer bank or processor should provide the merchant an updated listing of currently defined codes.

The maximum length of this property is 4 characters.

This property is only used for Visa Corporate Purchasing Cards.

CustomerTaxId Property (TSYSLevel3 Module)

Customer's Value Added Tax registration number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=customerTaxId,setter=setCustomerTaxId:) NSString* customerTaxId;

- (NSString*)customerTaxId;
- (void)setCustomerTaxId :(NSString*)newCustomerTaxId;

Default Value

""

Remarks

This property contains a Value Added Tax registration number supplied by the Commercial Card cardholder.

The maximum length of this property is 13 characters.

This property is only used for Visa Corporate Purchasing Cards.

DestinationCountry Property (TSYSLevel3 Module)

Country the goods are to be shipped to.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=destinationCountry,setter=setDestinationCountry:) NSString* destinationCountry;

- (NSString*)destinationCountry;
- (void)setDestinationCountry :(NSString*)newDestinationCountry;

Default Value

""

Remarks

For Visa transactions, this property contains the three-digit numeric code of the country where the goods are being shipped. These codes are specified by ISO-3166. For the United States, use "840".

For MasterCard transactions, this property should contain the three-character alpha code specified by that same ISO spec. For the United States, use "USA".

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

DestinationZip Property (TSYSLevel3 Module)

Zip code the goods are to be shipped to.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=destinationZip,setter=setDestinationZip:) NSString* destinationZip;

- (NSString*)destinationZip;
- (void)setDestinationZip :(NSString*)newDestinationZip;

Default Value

""

Remarks

This property contains the Postal/Zip code of the address where purchased goods will be delivered. This property can be identical to the ShipFromZip if the customer is present and takes immediate possession of the goods.

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

DiscountAmount Property (TSYSLevel3 Module)

Amount of any discount subtracted from the line item totals.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=discountAmount,setter=setDiscountAmount:) NSString* discountAmount;

- (NSString*)discountAmount;
- (void)setDiscountAmount :(NSString*)newDiscountAmount;

Default Value

""

Remarks

This property contains the amount of any discount applied by the merchant to the entire order. This field should be empty if the LineItemsUnitCost for each line item reflects a discount price, or if no discount applies.

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.

This property is only used for Visa Corporate Purchasing Cards.

DutyAmount Property (TSYSLevel3 Module)

Duty fees (if any) for imported goods.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dutyAmount,setter=setDutyAmount:) NSString* dutyAmount;

- (NSString*)dutyAmount;
- (void)setDutyAmount :(NSString*)newDutyAmount;

Default Value

""

Remarks

This property contains the fee amount associated with the import of the purchased goods.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

FreightAmount Property (TSYSLevel3 Module)

Shipping charges associated with this transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=freightAmount,setter=setFreightAmount:) NSString* freightAmount;

- (NSString*)freightAmount;
- (void)setFreightAmount :(NSString*)newFreightAmount;

Default Value

""

Remarks

This property contains the freight or shipping portion of the total transaction amount.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

FreightTaxAmount Property (TSYSLevel3 Module)

Portion of the FreightAmount that is tax.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=freightTaxAmount,setter=setFreightTaxAmount:) NSString* freightTaxAmount;

- (NSString*)freightTaxAmount;
- (void)setFreightTaxAmount :(NSString*)newFreightTaxAmount;

Default Value

""

Remarks

This property contains the amount of any Value Added Taxes (VAT) which can be associated with the freight or shipping charges for the purchased item.

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.

This property is only used for Visa Corporate Purchasing Cards.

FreightTaxRate Property (TSYSLevel3 Module)

Rate used to calculate the FreightTaxAmount .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=freightTaxRate,setter=setFreightTaxRate:) NSString* freightTaxRate;

- (NSString*)freightTaxRate;
- (void)setFreightTaxRate :(NSString*)newFreightTaxRate;

Default Value

""

Remarks

This property contains the tax rate used to calculate the FreightTaxAmount. This field has a two-digit implied decimal position, and the maximum length is 4 digits.

This property is only used for Visa Corporate Purchasing Cards.

LineItems Property (TSYSLevel3 Module)

A collection of line items to be included in the Level III addendum.

Syntax

• Swift
• Objective-C

public var lineItems: Array<TSYSLineItem> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=lineItemCount,setter=setLineItemCount:) int lineItemCount;

- (int)lineItemCount;
- (void)setLineItemCount :(int)newLineItemCount;

- (NSString*)lineItemCommodityCode:(int)lineItemIndex;
- (void)setLineItemCommodityCode:(int)lineItemIndex :(NSString*)newLineItemCommodityCode;

- (NSString*)lineItemDebitCreditIndicator:(int)lineItemIndex;
- (void)setLineItemDebitCreditIndicator:(int)lineItemIndex :(NSString*)newLineItemDebitCreditIndicator;

- (NSString*)lineItemDescription:(int)lineItemIndex;
- (void)setLineItemDescription:(int)lineItemIndex :(NSString*)newLineItemDescription;

- (NSString*)lineItemDiscountAmount:(int)lineItemIndex;
- (void)setLineItemDiscountAmount:(int)lineItemIndex :(NSString*)newLineItemDiscountAmount;

- (NSString*)lineItemDiscountRate:(int)lineItemIndex;
- (void)setLineItemDiscountRate:(int)lineItemIndex :(NSString*)newLineItemDiscountRate;

- (NSString*)lineItemProductCode:(int)lineItemIndex;
- (void)setLineItemProductCode:(int)lineItemIndex :(NSString*)newLineItemProductCode;

- (int)lineItemQuantity:(int)lineItemIndex;
- (void)setLineItemQuantity:(int)lineItemIndex :(int)newLineItemQuantity;

- (NSString*)lineItemTaxAmount:(int)lineItemIndex;
- (void)setLineItemTaxAmount:(int)lineItemIndex :(NSString*)newLineItemTaxAmount;

- (BOOL)lineItemTaxIncluded:(int)lineItemIndex;
- (void)setLineItemTaxIncluded:(int)lineItemIndex :(BOOL)newLineItemTaxIncluded;

- (NSString*)lineItemTaxRate:(int)lineItemIndex;
- (void)setLineItemTaxRate:(int)lineItemIndex :(NSString*)newLineItemTaxRate;

- (NSString*)lineItemTaxType:(int)lineItemIndex;
- (void)setLineItemTaxType:(int)lineItemIndex :(NSString*)newLineItemTaxType;

- (NSString*)lineItemTotal:(int)lineItemIndex;
- (void)setLineItemTotal:(int)lineItemIndex :(NSString*)newLineItemTotal;

- (NSString*)lineItemUnitCost:(int)lineItemIndex;
- (void)setLineItemUnitCost:(int)lineItemIndex :(NSString*)newLineItemUnitCost;

- (NSString*)lineItemUnits:(int)lineItemIndex;
- (void)setLineItemUnits:(int)lineItemIndex :(NSString*)newLineItemUnits;

Default Value

""

Remarks

This property contains a collection of line items to be included in the Level III addendum.

This property is used for both Visa and MasterCard Corporate Purchasing Cards. However, the line item fields that each card supports are different.

List of valid Line Item properties for Visa:

List of valid Line Item properties for Mastercard:

An example of setting two line items for a Visa Corporate purchasing card follows:

TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20"

LocalTax Property (TSYSLevel3 Module)

Amount of local or state taxes that are a part of this transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=localTax,setter=setLocalTax:) NSString* localTax;

- (NSString*)localTax;
- (void)setLocalTax :(NSString*)newLocalTax;

Default Value

""

Remarks

This property contains the sales tax associated with the purchase. If the transaction is exempt from local or state taxes, set this property to the text "EXEMPT".

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

MerchantTaxId Property (TSYSLevel3 Module)

Merchant's government tax Id number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=merchantTaxId,setter=setMerchantTaxId:) NSString* merchantTaxId;

- (NSString*)merchantTaxId;
- (void)setMerchantTaxId :(NSString*)newMerchantTaxId;

Default Value

""

Remarks

This property contains the government-assigned tax identification number of the merchant from whom the goods or services were purchased.

The maximum length of this field is 20 characters.

This property is only used for Visa Corporate Purchasing Cards.

NationalTax Property (TSYSLevel3 Module)

Amount of federal or national taxes that are a part of this transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=nationalTax,setter=setNationalTax:) NSString* nationalTax;

- (NSString*)nationalTax;
- (void)setNationalTax :(NSString*)newNationalTax;

Default Value

""

Remarks

This property contains the national tax included in the TransactionAmount of the original transaction.

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.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

OrderDate Property (TSYSLevel3 Module)

Date of the order in YYMMDD format.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=orderDate,setter=setOrderDate:) NSString* orderDate;

- (NSString*)orderDate;
- (void)setOrderDate :(NSString*)newOrderDate;

Default Value

""

Remarks

This property contains the purchase order date, and must be supplied in the YYMMDD format.

The maximum length of this field is 6 digits.

This property is only used for Visa Corporate Purchasing Cards.

PurchaseIdentifier Property (TSYSLevel3 Module)

Optional purchase order number assigned by the merchant.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=purchaseIdentifier,setter=setPurchaseIdentifier:) NSString* purchaseIdentifier;

- (NSString*)purchaseIdentifier;
- (void)setPurchaseIdentifier :(NSString*)newPurchaseIdentifier;

Default Value

""

Remarks

In this field the merchant may assign an optional Purchase Identifier. This field must contain digits, and will be automatically left-justified, space-filled to 25 spaces.

This field is applicable to E-Commerce, Hotel, and Auto Rental transactions.

Note: For the Hotel IndustryType, this property will contain the Hotel Folio Number. For the Auto Rental IndustryType, it should indicate the Rental Agreement Number.

Failure to set a PurchaseIdentifier for the e-commerce IndustryType may result in a CPS downgrade when the transaction is settled. This can result in higher interchange rates.

PurchaseOrder Property (TSYSLevel3 Module)

Purchase Order Number supplied by the cardholder.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=purchaseOrder,setter=setPurchaseOrder:) NSString* purchaseOrder;

- (NSString*)purchaseOrder;
- (void)setPurchaseOrder :(NSString*)newPurchaseOrder;

Default Value

""

Remarks

This property contains a 16, 17, or 25-character Purchase Order Number or Customer Reference Identifier supplied by the Visa or MasterCard Purchasing Card cardholder.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

ShipFromZip Property (TSYSLevel3 Module)

Zip code the goods are being shipped from.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=shipFromZip,setter=setShipFromZip:) NSString* shipFromZip;

- (NSString*)shipFromZip;
- (void)setShipFromZip :(NSString*)newShipFromZip;

Default Value

""

Remarks

This property contains the Postal/Zip code of the address from where the purchased goods are being shipped.

The maximum length of this property is 10 characters.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

TaxInvoiceNumber Property (TSYSLevel3 Module)

Unique Value Added Tax Invoice Reference Number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=taxInvoiceNumber,setter=setTaxInvoiceNumber:) NSString* taxInvoiceNumber;

- (NSString*)taxInvoiceNumber;
- (void)setTaxInvoiceNumber :(NSString*)newTaxInvoiceNumber;

Default Value

""

Remarks

This property contains the invoice number that is associated with the Value Added Tax (VAT) invoice.

The maximum length of this property is 15 characters.

This property is only used for Visa Corporate Purchasing Cards.

Config Method (TSYSLevel3 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.

GetAddendum Method (TSYSLevel3 Module)

Returns a Level III Purchasing card addendum based on the specified CardType .

Syntax

• Swift
• Objective-C

public func getAddendum() throws -> String

- (NSString*)getAddendum;

Remarks

The type of addendum created by this class depends upon the value of the CardType property. Different addendums are created when the CardType is set to tctVisa or tctMasterCard, and different properties are required for the two different CardTypes.

The following properties are valid for both tctVisa and tctMasterCard CardTypes.

• PurchaseIdentifier
• LocalTax
• NationalTax
• PurchaseOrder
• FreightAmount
• DutyAmount
• DestinationZip
• ShipFromZip
• DestinationCountry
• LineItemsDescription
• LineItemsDiscountAmount
• LineItemsProductCode
• LineItemsQuantity
• LineItemsTaxAmount
• LineItemsTaxRate
• LineItemsTotal
• LineItemsUnits

• MerchantTaxId
• CustomerTaxId
• CommodityCode
• DiscountAmount
• TaxInvoiceNumber
• OrderDate
• FreightTaxAmount
• FreightTaxRate
• LineItemsCommodityCode
• LineItemsUnitCost

Additional properties for the tctMasterCard CardType include:

• AlternateTaxAmount
• AlternateTaxId
• LineItemsDiscountRate
• LineItemsTaxIncluded
• LineItemsTaxType

The following example illustrates how to build a Level III addendum for the tctVisa CardType: 'First authorize the credit card TSYSECommerce1.TransactionAmount = "53" TSYSECommerce.Authorize() 'Then, put the result into the settlement component TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() 'Now build the Level3 Extension. 'The following properties are required for a Visa Corporate Purchasing Card: TSYSLevel3.CardType = tctVisa TSYSLevel3.LocalTax = "EXEMPT" TSYSLevel3.NationalTax = "0" TSYSLevel3.PurchaseOrder = "purchOrdNum" TSYSLevel3.MerchantTaxId = "merchantTaxId" 'Merchant VAT Registration Number TSYSLevel3.CustomerTaxId = "customerTaxId" 'Customer VAT Registration Number TSYSLevel3.CommodityCode = "fake" TSYSLevel3.DiscountAmount = "0" TSYSLevel3.FreightAmount = "0" TSYSLevel3.DutyAmount = "0" TSYSLevel3.DestinationZip = "27709" TSYSLevel3.ShipFromZip = "27709" TSYSLevel3.DestinationCountry = "840" TSYSLevel3.TaxInvoiceNumber = "VATInvoiceRefNo" TSYSLevel3.OrderDate = "060526" TSYSLevel3.FreightTaxAmount = "0" TSYSLevel3.FreightTaxRate = "0" 'Begin adding line items: TSYSLevel3.LineItemCount = 2 TSYSLevel3.LineItemCommodityCode(0) = "fake" TSYSLevel3.LineItemDescription(0) = "hardware" TSYSLevel3.LineItemProductCode(0) = "productCode123" TSYSLevel3.LineItemQuantity(0) = 1 TSYSLevel3.LineItemUnits(0) = "" TSYSLevel3.LineItemUnitCost(0) = "33" TSYSLevel3.LineItemTaxAmount(0) = "0" TSYSLevel3.LineItemTaxRate(0) = "0" TSYSLevel3.LineItemDiscountAmount(0) = "0" TSYSLevel3.LineItemTotal(0) = "33" TSYSLevel3.LineItemCommodityCode(1) = "fake" TSYSLevel3.LineItemDescription(1) = "hardware" TSYSLevel3.LineItemProductCode(1) = "productCode124" TSYSLevel3.LineItemQuantity(1) = 1 TSYSLevel3.LineItemUnits(1) = "" TSYSLevel3.LineItemUnitCost(1) = "20" TSYSLevel3.LineItemTaxAmount(1) = "0" TSYSLevel3.LineItemTaxRate(1) = "0" TSYSLevel3.LineItemDiscountAmount(1) = "0" TSYSLevel3.LineItemTotal(1) = "20" 'Finally, add the Level3 addendum to the same index in the settlement. TSYSSettle.DetailRecordAddendum(0) = TSYSLevel31.GetAddendum()

Reset Method (TSYSLevel3 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.

Error Event (TSYSLevel3 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.

TSYSLineItem Type

Contains a single Level 3 line item.

Remarks

This type contains a single line item, used for Level 3 settlements. The fields contained by this type are listed below.

Fields

Constructors

public init()

Config Settings (TSYSLevel3 Module)

TSYSLevel3 Config Settings

Base Config Settings

Trappable Errors (TSYSLevel3 Module)

TSYSLevel3 Errors