TSYSSettle Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSSettle class is used to do a Batch Settlement on all transactions that were successfully authorized with the TSYSECOMMERCE or TSYSRETAIL classes. This class may also send Level II and Level III Corporate Purchasing Card data for better interchange rates.

Class Name

DPaymentsSDK_TSYSSettle

Procedural Interface

 dpaymentssdk_tsyssettle_open();
 dpaymentssdk_tsyssettle_close($res);
 dpaymentssdk_tsyssettle_register_callback($res, $id, $function);
 dpaymentssdk_tsyssettle_get_last_error($res);
 dpaymentssdk_tsyssettle_get_last_error_code($res);
 dpaymentssdk_tsyssettle_set($res, $id, $index, $value);
 dpaymentssdk_tsyssettle_get($res, $id, $index);
 dpaymentssdk_tsyssettle_do_config($res, $configurationstring);
 dpaymentssdk_tsyssettle_do_interrupt($res);
 dpaymentssdk_tsyssettle_do_reset($res);
 dpaymentssdk_tsyssettle_do_sendsettlement($res);

Remarks

This class allows for a direct, secure connection to the Vital/TSYS gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers. The TSYSSettle class is used to settle all transactions previously authorized by the TSYSECommerce or TSYSRetail class. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the TSYSSettle class the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.

To send a Batch Settlement, first the user must fill out the Merchant properties with the same information contained in the authorizing class's Merchant properties.

TSYSSettle.MerchantBankId = "999995" TSYSSettle.MerchantCategoryCode = "5999" TSYSSettle.MerchantName = "test merchant" TSYSSettle.MerchantNumber = "123456789012" TSYSSettle.MerchantCity = "Beverly Hills" TSYSSettle.MerchantState = "CA" TSYSSettle.MerchantStoreNumber = "5999" TSYSSettle.MerchantTerminalNumber = "1515" TSYSSettle.MerchantZip = "90210"

Additionally, the AgentBankNumber, AgentChainNumber, TerminalId, BatchNumber, and IndustryType must be set. Note that the TerminalId is fundamentally different from the MerchantTerminalNumber. The MerchantTerminalNumber is used to identify a unique terminal (PC, server, whatever) within a merchant location. The TerminalId, also known as the "V Number", is used for point-of-sale tracking. TSYSSettle.AgentBankNumber = "000000" TSYSSettle.AgentChainNumber = "111111" TSYSSettle.TerminalId = "00000001" TSYSSettle.BatchNumber = 15 TSYSSettle.IndustryType = itRetail

At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailRecordAggregate array property. First set the DetailRecordCount; to the total number of transactions you wish to settle. Each index in the DetailRecordAggregate array property must be set with the XML aggregate returned from the TSYSRetail, TSYSECommerce, or TSYSDetailRecord class's GetDetailAggregate method.

TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate(0) = TSYSRetail.GetDetailAggregate()

Finally, call the SendSettlement method.

TSYSSettle.SendSettlement()

If the transaction is successful, the ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.

Thousands of detail records may be settled in the above manner, just by increasing the DetailRecordCount and adding a transaction to each index of the DetailRecordAggregate property. However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.

To Void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. Credits and forced transactions may be created using the TSYSDetailRecord class and settled in the same manner.

To add Level II or Level III data to the settled transactions, use the DetailRecordAddendum property and the TSYSLevel2 or TSYSLevel3 classs.

Note that the IndustryType from the TSYSSettle class MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.

Property List

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

Method List

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

Event List

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

Config Settings

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

AgentBankNumber Property (DPaymentsSDK_TSYSSettle Class)

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

Object Oriented Interface

public function getAgentBankNumber();


public function setAgentBankNumber($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 1 );


dpaymentssdk_tsyssettle_set($res, 1, $value );

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.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

Data Type

String

AgentChainNumber Property (DPaymentsSDK_TSYSSettle Class)

Identifies a specific chain of an agent organization.

Object Oriented Interface

public function getAgentChainNumber();


public function setAgentChainNumber($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 2 );


dpaymentssdk_tsyssettle_set($res, 2, $value );

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.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

Data Type

String

BatchCashBackTotal Property (DPaymentsSDK_TSYSSettle Class)

Total amount of cash back for all transactions in the batch.

Object Oriented Interface

public function getBatchCashBackTotal();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 3 );

Default Value

'0000000000000000'

Remarks

Total amount of cash back for all transactions in the batch.

This property contains the total of all cash back amounts reflected in the settlement batch. Note that only Debit Cards, Gift Cards, and EBT cards allow for cash back to be returned to the customer. For normal credit card transactions, this property will be defaulted to zeros.

This is a Trailer property, and is automatically computed by the class.

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 read-only and not available at design time.

Data Type

String

BatchHashingTotal Property (DPaymentsSDK_TSYSSettle Class)

Total of purchases plus credits.

Object Oriented Interface

public function getBatchHashingTotal();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 4 );

Default Value

'0000000000000000'

Remarks

Total of purchases plus credits.

This 16-digit property contains the batch hashing total generated by the terminal. The hashing total is generated by adding the absolute value of all detail record amounts. Void and purchase return settlement amounts are treated as positive and added to the total, not subtracted from it.

This is a Trailer property, and is automatically computed by the class.

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 read-only and not available at design time.

Data Type

String

BatchNetDeposit Property (DPaymentsSDK_TSYSSettle Class)

Total of purchases minus credits.

Object Oriented Interface

public function getBatchNetDeposit();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 5 );

Default Value

'0000000000000000'

Remarks

Total of purchases minus credits.

This 16-digit property contains the net deposit generated by the terminal. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit/refund amounts from it.

This is a Trailer property, and is automatically computed by the class.

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 read-only.

Data Type

String

BatchRecordCount Property (DPaymentsSDK_TSYSSettle Class)

Total number of records sent including Header, Parameter, and Trailer.

Object Oriented Interface

public function getBatchRecordCount();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 6 );

Default Value

0

Remarks

Total number of records sent including Header, Parameter, and Trailer.

This property contains a batch (transaction) record count, calculated by the class. This property is supplied in the Batch Trailer Record and contains the total number of transactions in the batch -- including Header, Parameter, Detail(s), and Trailer records. This property reflects the actual number of records that have been sent, and is independent of the number of detail records sent in the settlement.

This is a Trailer property, and is automatically computed by the class.

This property is read-only.

Data Type

Integer

BatchNumber Property (DPaymentsSDK_TSYSSettle Class)

Sequence number of this batch transaction.

Object Oriented Interface

public function getBatchNumber();


public function setBatchNumber($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 7 );


dpaymentssdk_tsyssettle_set($res, 7, $value );

Default Value

0

Remarks

This property contains a three digit batch sequence number generated by the Point of Sale (POS) device. The batch number must be within the range "001" to "999". If the POS device is automatically incrementing the batch number, it should automatically advance the number from "999" to "001"("000" is invalid). Batch numbers must not be reused or repeated within 5 consecutive days.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

If the transaction is successful, the ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.

Data Type

Integer

DetailRecordCount Property (DPaymentsSDK_TSYSSettle Class)

The number of records in the DetailRecord arrays.

Object Oriented Interface

public function getDetailRecordCount();


public function setDetailRecordCount($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 8 );


dpaymentssdk_tsyssettle_set($res, 8, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DetailRecordAddendum
• DetailRecordAggregate

The array indices start at 0 and end at DetailRecordCount - 1.

This property is not available at design time.

Data Type

Integer

DetailRecordAddendum Property (DPaymentsSDK_TSYSSettle Class)

Optional Detail Record Addendum data (such as Level2 or Level3 data) The DetailAggregate property contains an xml aggregate of the transaction retrieved from the TSYSECOMMERCE , TSYSRETAIL , or TSYSDETAILRECORD class's GetDetailAggregate method.

Object Oriented Interface

public function getDetailRecordAddendum($detailrecordindex);


public function setDetailRecordAddendum($detailrecordindex, $value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 9 , $detailrecordindex);


dpaymentssdk_tsyssettle_set($res, 9, $value , $detailrecordindex);

Default Value

''

Remarks

Optional Detail Record Addendum data (such as Level2 or Level3 data)

The DetailRecordDetailAggregate property contains an xml aggregate of the transaction retrieved from the TSYSECommerce, TSYSRetail, or TSYSDetailRecord class's GetDetailAggregate method. If you wish to accept corporate purchasing cards you will also need to send Level2, and possibly Level3 addendum data along with the DetailRecordDetailAggregate. The DetailRecordAddendumAggregate property takes an xml aggregate containing either Level2 or Level3 addendum data, which will be added to the DetailRecordDetailAggregate. The addendum aggregate may be created with either the TSYSLevel2 or TSYSLevel3 classs, and then returned via those class's GetAddendum method.

For example:

'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()

Note that you may mix corporate and non-corporate card transactions in the same settlement. It is not necessary that all DetailRecordDetailAggregates have a corresponding DetailRecordAddendumAggregate.

The $detailrecordindex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

DetailRecordAggregate Property (DPaymentsSDK_TSYSSettle Class)

Set this property with xml aggregates of the transactions you wish to settle.

Object Oriented Interface

public function getDetailRecordAggregate($detailrecordindex);


public function setDetailRecordAggregate($detailrecordindex, $value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 10 , $detailrecordindex);


dpaymentssdk_tsyssettle_set($res, 10, $value , $detailrecordindex);

Default Value

''

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the TSYSRetail, or TSYSECommerce class's GetDetailAggregate method. For instance:

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

On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the TSYSDetailRecord class.

For example, to add a gratuity to a charge:

DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate()) DetailRecord.Gratuity = "500" DetailRecord.SettlementAmount = DetailRecord.AuthorizedAmount + DetailRecord.Gratuity TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

To settle a Passenger Transport transaction authorized with the sitPassengerTransport IndustryType, you must use the TSYSDetailRecord class to add the number of this passenger and the total count of all passengers in the authorization code. For instance, if the authorization transaction included "Three passengers", and this is the first passenger, then the passenger number will be 1, and the passenger count 3. An example is included below:

TSYSRetail.IndustryType = sitPassengerTransport TSYSRetail.Authorize() DetailRecord.ParseAggregate TSYSRetail.GetDetailAggregate() DetailRecord.PassengerCount = 3 DetailRecord.PassengerNumber = 1 DetailRecord.Config("RestrictedTicketIndicator=True") DetailRecord.Config("TicketNumber=8382152100395") DetailRecord.Config("PassengerName=John Smith") DetailRecord.Config("DepartureDate=072117") DetailRecord.Config("Origin=JFK") DetailRecord.Config("Leg1=Carrier=DL;ServiceClass=C;StopOver=X;Destination=LAX") TSYSSettle1.IndustryType = sitPassengerTransport TSYSSettle1.Config("TravelAgencyCode=12345678") 'if ticket was issued by a travel agency TSYSSettle1.Config("TravelAgencyName=Travel and Tours") 'if ticket was issued by a travel agency TSYSSettle1.DetailAggregate[5] = DetailRecord.GetDetailAggregate()

The $detailrecordindex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

ErrorData Property (DPaymentsSDK_TSYSSettle Class)

Erroneous data contained within the property specified by DataFieldNumber .

Object Oriented Interface

public function getErrorData();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 11 );

Default Value

''

Remarks

Erroneous data contained within the field specified by ErrorDataFieldNumber.

When you receive a Rejected Batch (ResponseCode is "RB"), this 32-character property will contain the data that caused the batch to fail. The record that contains this error is specified by ErrorSequenceNumber, and the location of the erroneous data within that record is specified by ErrorDataFieldNumber.

This property is read-only.

Data Type

String

ErrorDataFieldNumber Property (DPaymentsSDK_TSYSSettle Class)

Field within an invalid record that contains an error.

Object Oriented Interface

public function getErrorDataFieldNumber();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 12 );

Default Value

0

Remarks

Field within an invalid record that contains an error.

When you receive a Rejected Batch (ResponseCode is "RB"), this property contains the sequential field number within the data record which caused the batch to be rejected. The erroneous data within this property is returned in ErrorData, and the sequence number of the record that contains this error is specified by ErrorSequenceNumber.

This property is read-only.

Data Type

Integer

ErrorDetailRecordIndex Property (DPaymentsSDK_TSYSSettle Class)

Provides the index of the DetailRecord that caused the batch error.

Object Oriented Interface

public function getErrorDetailRecordIndex();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 13 );

Default Value

-1

Remarks

Provides the index of the DetailRecord that caused the batch error.

When you receive a Rejected Batch (Response Code of 'RB'), this field will be populated with the index of the DetailRecord that caused the error (provided that it was a Detail Record that caused it). If no error occurred, this field will return "-1".

This property is read-only.

Data Type

Integer

ErrorType Property (DPaymentsSDK_TSYSSettle Class)

Type of batch error.

Object Oriented Interface

public function getErrorType();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 14 );

Default Value

''

Remarks

Type of batch error.

When you receive a Rejected Batch (ResponseCode is "RB"), this one character property will provide additional info as to the nature of the rejected batch. The following table lists the currently defined error types.

This property is read-only.

Data Type

String

ErrorRecordType Property (DPaymentsSDK_TSYSSettle Class)

Type of record in which an error occurred.

Object Oriented Interface

public function getErrorRecordType();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 15 );

Default Value

''

Remarks

Type of record in which an error occurred.

When you receive a Rejected Batch (ResponseCode is "RB"), this one character property defines the type of data record which caused the batch to be rejected. The table below lists all valid responses.

This property is read-only.

Data Type

String

ErrorSequenceNumber Property (DPaymentsSDK_TSYSSettle Class)

Sequence number of the record that caused an error.

Object Oriented Interface

public function getErrorSequenceNumber();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 16 );

Default Value

0

Remarks

Sequence number of the record that caused an error.

When you receive a Rejected Batch (ResponseCode is "RB"), this property will contain the sequential number of the data record which caused the rejected batch state. To obtain the index of the DetailRecord in the DetailRecords arrays that contains the erroneous data, please see the ErrorDetailRecordIndex. The field within this record that contains erroneous data is specified by ErrorDataFieldNumber, and the actual data causing the error will be contained in the ErrorData property.

This property is read-only.

Data Type

Integer

IndustryType Property (DPaymentsSDK_TSYSSettle Class)

Code which indicates the industry the merchant is engaged in.

Object Oriented Interface

public function getIndustryType();


public function setIndustryType($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 17 );


dpaymentssdk_tsyssettle_set($res, 17, $value );

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.

Data Type

Integer

MerchantBankId Property (DPaymentsSDK_TSYSSettle Class)

The number which identifies the merchant's bank or processor.

Object Oriented Interface

public function getMerchantBankId();


public function setMerchantBankId($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 18 );


dpaymentssdk_tsyssettle_set($res, 18, $value );

Default Value

''

Remarks

The number which identifies the merchant's bank or processor.

This property contains a six digit Visa assigned Bank Identification Number issued by the merchant's member bank or processor. The acquirer Bank Identification Number (BIN) identifies the member bank that signed the merchant using the Point of Sale application. This property may not remain zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantCategoryCode Property (DPaymentsSDK_TSYSSettle Class)

Classifies a merchant by the type of store.

Object Oriented Interface

public function getMerchantCategoryCode();


public function setMerchantCategoryCode($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 19 );


dpaymentssdk_tsyssettle_set($res, 19, $value );

Default Value

''

Remarks

Classifies a merchant by the type of store.

This four digit property contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).

Data Type

String

MerchantCity Property (DPaymentsSDK_TSYSSettle Class)

Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.

Object Oriented Interface

public function getMerchantCity();


public function setMerchantCity($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 20 );


dpaymentssdk_tsyssettle_set($res, 20, $value );

Default Value

''

Remarks

Merchant's City

For Retail (Card Present) transactions, this property should contain the city in which the merchant is located. This is an optional property. However if it is specified, the MerchantName and MerchantState must also be specified.

Note: For Direct Marketing and E-Commerce transactions, for Visa, Discover, and Amex, this property is ignored. MerchantServicePhone is used for those industries instead of MerchantCity (this does not apply to MasterCard).

Note: This property must contain the same data used in the batch settlement. The first character of this property may not be a space. This property may contain alphanumeric characters, but not punctuation or control characters. The maximum length of this property is 13 characters.

Data Type

String

MerchantCountryCode Property (DPaymentsSDK_TSYSSettle Class)

Identifies the country where the merchant is located.

Object Oriented Interface

public function getMerchantCountryCode();


public function setMerchantCountryCode($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 21 );


dpaymentssdk_tsyssettle_set($res, 21, $value );

Default Value

'840'

Remarks

Identifies the country where the merchant is located.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's location country. These codes are specified by ISO-3166-1. For the United States, use "840".

Data Type

String

MerchantCurrencyCode Property (DPaymentsSDK_TSYSSettle Class)

Identifies the type of currency used by the merchant.

Object Oriented Interface

public function getMerchantCurrencyCode();


public function setMerchantCurrencyCode($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 22 );


dpaymentssdk_tsyssettle_set($res, 22, $value );

Default Value

'840'

Remarks

Identifies the type of currency used by the merchant.

This property contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

Data Type

String

MerchantLanguage Property (DPaymentsSDK_TSYSSettle Class)

Designates the language that response messages will be returned in.

Object Oriented Interface

public function getMerchantLanguage();


public function setMerchantLanguage($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 23 );


dpaymentssdk_tsyssettle_set($res, 23, $value );

Default Value

'00'

Remarks

Designates the language that response messages will be returned in.

This property contains a two digit language indicator. This value designates the language to be used in formatting the authorization response text message. This property may be changed from transaction to transaction. The following table provides a summary of the languages currently supported.

Data Type

String

MerchantName Property (DPaymentsSDK_TSYSSettle Class)

Name of the merchant.

Object Oriented Interface

public function getMerchantName();


public function setMerchantName($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 24 );


dpaymentssdk_tsyssettle_set($res, 24, $value );

Default Value

''

Remarks

Name of the merchant.

This 25 character property contains the merchant name provided by the signing member or processor. The name provided must correspond to the name printed on the customer receipt. The first character of this property may not be a space. This property must contain the same value in both authorization and batch settlement.

This is an optional property. However if this property is specified, the MerchantState and MerchantCity (Retail) or MerchantState and MerchantServicePhone (E-Commerce) must also be specified.

This property may contain alphanumeric and punctuation characters. The maximum length of this property is 25 characters.

Data Type

String

MerchantNumber Property (DPaymentsSDK_TSYSSettle Class)

A unique number used to identify the merchant within the VisaNet system.

Object Oriented Interface

public function getMerchantNumber();


public function setMerchantNumber($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 25 );


dpaymentssdk_tsyssettle_set($res, 25, $value );

Default Value

''

Remarks

A unique number used to identify the merchant within the VisaNet system.

This 12 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This property is used to identify the merchant within the VisaNet system. This number will be right-justified and zero-filled.

Note, the TSYS Server uses the Merchant's MerchantBankId and MerchantNumber to route the transaction to the proper back-end processor. If either number is incorrect (or if you're using test numbers and the test system is offline) the TSYS server will immediately disconnect, and will not supply an error message.

Data Type

String

MerchantPhone Property (DPaymentsSDK_TSYSSettle Class)

Merchant's phone number.

Object Oriented Interface

public function getMerchantPhone();


public function setMerchantPhone($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 26 );


dpaymentssdk_tsyssettle_set($res, 26, $value );

Default Value

''

Remarks

Merchant's phone number.

This property contains the Merchant's business phone number. This can be the same as the customer service phone number.

Data Type

String

MerchantServicePhone Property (DPaymentsSDK_TSYSSettle Class)

Merchant's customer service number.

Object Oriented Interface

public function getMerchantServicePhone();


public function setMerchantServicePhone($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 27 );


dpaymentssdk_tsyssettle_set($res, 27, $value );

Default Value

''

Remarks

Merchant's customer service number.

This property contains a merchant telephone number that the cardholder may call for service. It should contain an 11-character phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This property is used for authorizations in the Hotel, Auto Rental, and Direct Marketing Industry Types, and in the settlement for all industry types.

Data Type

String

MerchantState Property (DPaymentsSDK_TSYSSettle Class)

State or province that the merchant is located in.

Object Oriented Interface

public function getMerchantState();


public function setMerchantState($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 28 );


dpaymentssdk_tsyssettle_set($res, 28, $value );

Default Value

''

Remarks

State or province that the merchant is located in.

This two character property contains the merchant state or province provided by the signing member or processor. This property must contain the same data used in the batch settlement.

This is an optional property. However if it is specified the Merchant MerchantName and MerchantCity (Retail) or MerchantName and MerchantServicePhone (E-Commerce) must also be specified.

Data Type

String

MerchantStoreNumber Property (DPaymentsSDK_TSYSSettle Class)

Used to identify a specific merchant's store within the VisaNet system.

Object Oriented Interface

public function getMerchantStoreNumber();


public function setMerchantStoreNumber($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 29 );


dpaymentssdk_tsyssettle_set($res, 29, $value );

Default Value

''

Remarks

Used to identify a specific merchant's store within the VisaNet system.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the VisaNet system. This property must be right-justified and zero-filled.

Data Type

String

MerchantStreetAddress Property (DPaymentsSDK_TSYSSettle Class)

Merchant's street address.

Object Oriented Interface

public function getMerchantStreetAddress();


public function setMerchantStreetAddress($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 30 );


dpaymentssdk_tsyssettle_set($res, 30, $value );

Default Value

''

Remarks

Merchant's street address.

This 25 character property contains the Merchant's street address, which should include the street number, street name, and other identifiers of the precise location, such as a building or unit number.

Data Type

String

MerchantTerminalNumber Property (DPaymentsSDK_TSYSSettle Class)

Used to identify a unique terminal within a merchant location.

Object Oriented Interface

public function getMerchantTerminalNumber();


public function setMerchantTerminalNumber($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 31 );


dpaymentssdk_tsyssettle_set($res, 31, $value );

Default Value

''

Remarks

Used to identify a unique terminal within a merchant location.

This four digit property contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location. Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this property may additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. This property must be right-justified and zero-filled.

Data Type

String

MerchantTimeZone Property (DPaymentsSDK_TSYSSettle Class)

Specifies the GMT offset used to calculate the local time within the VisaNet system.

Object Oriented Interface

public function getMerchantTimeZone();


public function setMerchantTimeZone($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 32 );


dpaymentssdk_tsyssettle_set($res, 32, $value );

Default Value

'705'

Remarks

Specifies the GMT offset used to calculate the local time within the VisaNet system.

This filed contains a three digit code used to calculate the local time within the VisaNet authorization system. The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first digit specifies the direction of the differential and offset increment as well as whether daylight savings is observed. The last two digits specify the magnitude of the differential. For example, North Carolina would be "705", California would be "708", and Arizona would be "107" (daylight savings not observed). The following table provides a brief summary of the Time Zone Differential Codes.

Byte #1:

If byte #1 designates an area with offset in hours, (0, 1, 6, 7) the value of these bytes should be between "00" and "12", inclusive. If byte #1 designates an area with offset in 15 minute increments, (2-5) the value of these bytes should be between "00" and "48", inclusive.

Data Type

String

MerchantZip Property (DPaymentsSDK_TSYSSettle Class)

Zip code where the merchant that initiated this transaction is located.

Object Oriented Interface

public function getMerchantZip();


public function setMerchantZip($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 33 );


dpaymentssdk_tsyssettle_set($res, 33, $value );

Default Value

''

Remarks

Zip code where the merchant that initiated this transaction is located.

This property contains the nine character code used to further identify the merchant location. Within the United States, the five or nine digit zip code of the address of the store location is used. Outside of the United States, this property will be assigned by the signing member or processor.

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

Data Type

String

MerchantLocalPhone Property (DPaymentsSDK_TSYSSettle Class)

Merchant's local phone number. Used in settlement only.

Object Oriented Interface

public function getMerchantLocalPhone();


public function setMerchantLocalPhone($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 34 );


dpaymentssdk_tsyssettle_set($res, 34, $value );

Default Value

''

Remarks

This property should contain an 11-character merchant phone number in XXX-XXXXXXX format. The initial "1" for long-distance or toll-free calls should be omitted. For instance, "800-1234567" is acceptable, while "1-800-1234567" is not. The fourth character position MUST contain a hyphen. Hyphens may not be used anywhere else.

This phone number should be the number for the local merchant establishment. For the Hotel IndustryType, it should contain the phone number for the actual hotel at which the customer is staying. Likewise, for the Auto Rental IndustryType this property must contain the phone number for the location from which the car is actually rented.

This property is used for Hotel, Auto Rental, and Direct Marketing IndustryTypes.

This property is only used in the settlement, and will be ignored for all authorizations.

Data Type

String

ResponseCode Property (DPaymentsSDK_TSYSSettle Class)

Indicates the status of the batch transmission.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 35 );

Default Value

''

Remarks

Indicates the status of the batch transmission.

This property contains the two character response code returned by the host indicating the status of the Batch Settlement attempt. The following table provides a summary of the response returned by the TSYS host:

This property is read-only and not available at design time.

Data Type

String

ResponseNetDeposit Property (DPaymentsSDK_TSYSSettle Class)

Total of purchases minus credits and voids.

Object Oriented Interface

public function getResponseNetDeposit();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 36 );

Default Value

''

Remarks

Total of purchases minus credits and voids.

This property contains the net deposit generated by the terminal. It should equal the BatchNetDesposit property, which is computed by the class. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit amounts from it. This property is represented as an absolute value and cannot be negative.

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 read-only and not available at design time.

Data Type

String

ResponseNumber Property (DPaymentsSDK_TSYSSettle Class)

Batch number that belongs to this response.

Object Oriented Interface

public function getResponseNumber();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 37 );

Default Value

0

Remarks

Batch number that belongs to this response.

This property should be compared to the BatchNumber in order to match a response with a given Batch Settlement. If running in synchronous mode, this property should always be identical to BatchNumber.

This property is read-only and not available at design time.

Data Type

Integer

ResponseRecordCount Property (DPaymentsSDK_TSYSSettle Class)

Number of records received by the server in this batch.

Object Oriented Interface

public function getResponseRecordCount();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 38 );

Default Value

0

Remarks

Number of records received by the server in this batch.

This property contains the total number of records received by the host -- including Header, Parameter, Detail, and Trailer records. In the case of a ResponseCode of "GB" (Good Batch), the value returned should match the value in the Batch.RecordCount property. In the case of a ResponseCode of "RB" (Rejected Batch), this property will reflect the total number of records received until the point of failure. ResponseRecordCount + 1 will reveal the sequential number of the transaction record responsible for causing a rejected batch condition, and should be identical to the Error.SequenceNumber property in this case.

This property is read-only and not available at design time.

Data Type

Integer

ResponseText Property (DPaymentsSDK_TSYSSettle Class)

Contents of this property are dependent upon the Code .

Object Oriented Interface

public function getResponseText();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 39 );

Default Value

''

Remarks

Contents of this field are dependent upon the ResponseCode.

This nine character property will contain the text "_ACCEPTED" when a settlement batch has been successfully received by the host. However, the Point of Sale (POS) device should examine only the ResponseCode to determine the status of a particular Batch Settlement.

This property is read-only and not available at design time.

Data Type

String

ResponseTransmissionDate Property (DPaymentsSDK_TSYSSettle Class)

Date that the batch was settled.

Object Oriented Interface

public function getResponseTransmissionDate();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 40 );

Default Value

''

Remarks

Date that the batch was settled.

This property is reserved, pending the future upgrade to a higher protocol version.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_TSYSSettle Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 42 );


dpaymentssdk_tsyssettle_set($res, 42, $value );

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.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_TSYSSettle Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 70 );


dpaymentssdk_tsyssettle_set($res, 70, $value );

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.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_TSYSSettle Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 86 );


dpaymentssdk_tsyssettle_set($res, 86, $value );

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).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_TSYSSettle Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 87 );


dpaymentssdk_tsyssettle_set($res, 87, $value );

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.

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_TSYSSettle Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 88 );


dpaymentssdk_tsyssettle_set($res, 88, $value );

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:

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_TSYSSettle Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 89 );


dpaymentssdk_tsyssettle_set($res, 89, $value );

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.

Data Type

String

SSLProvider Property (DPaymentsSDK_TSYSSettle Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 97 );


dpaymentssdk_tsyssettle_set($res, 97, $value );

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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_TSYSSettle Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 99 );

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 and not available at design time.

Data Type

Binary String

TerminalId Property (DPaymentsSDK_TSYSSettle Class)

Contains number to accommodate a POS device tracking number.

Object Oriented Interface

public function getTerminalId();


public function setTerminalId($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 126 );


dpaymentssdk_tsyssettle_set($res, 126, $value );

Default Value

'00000001'

Remarks

This eight digit field contains the number to accommodate a Point Of Sale (POS) device tracking number. This field is also known as the "V" number. Unless otherwise specified by the merchant's bank or processor, this field should be defaulted to "00000001".

Note: If specified, the "V" alpha character must be changed to a numeric 7 when setting this property.

This is a Parameter Property, and need only be set once for a single Batch Settlement transaction.

Data Type

String

Timeout Property (DPaymentsSDK_TSYSSettle Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_tsyssettle_get($res, 127 );


dpaymentssdk_tsyssettle_set($res, 127, $value );

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).

Data Type

Integer

Config Method (DPaymentsSDK_TSYSSettle Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_tsyssettle_do_config($res, $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.

Interrupt Method (DPaymentsSDK_TSYSSettle Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_tsyssettle_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_TSYSSettle Class)

Resets all the properties of the entire settlement to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_tsyssettle_do_reset($res);

Remarks

This method resets the Header and Parameter Record properties to default values, and clears all Detail Records. To clear only the Detail Records (leaving Header and Parameter records intact) set the DetailRecordCount property to 0.

SendSettlement Method (DPaymentsSDK_TSYSSettle Class)

Begins a Batch Settlement transaction with the transaction server.

Object Oriented Interface

public function doSendSettlement();

Procedural Interface

dpaymentssdk_tsyssettle_do_sendsettlement($res);

Remarks

This begins a Batch Settlement transaction. The Header Record, Parameter Record, all transaction Detail Records, and the computed Trailer Record are sent sequentially to the Vital/TSYS host.

If the transaction is successful, the ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.

Connected Event (DPaymentsSDK_TSYSSettle Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 '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 (DPaymentsSDK_TSYSSettle Class)

Fired when receiving a data packet from the transaction server.

Object Oriented Interface

public function fireDataPacketIn($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 2, array($this, 'fireDataPacketIn'));

Parameter List

 '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 (DPaymentsSDK_TSYSSettle Class)

Fired when sending a data packet to the transaction server.

Object Oriented Interface

public function fireDataPacketOut($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 3, array($this, 'fireDataPacketOut'));

Parameter List

 '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 (DPaymentsSDK_TSYSSettle Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 '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 (DPaymentsSDK_TSYSSettle Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 '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 (DPaymentsSDK_TSYSSettle Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 '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 (DPaymentsSDK_TSYSSettle Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_tsyssettle_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (TSYSSettle Class)

TSYSSettle Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (TSYSSettle Class)

TSYSSettle Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors