PTechECommerce Component

Properties   Methods   Events   Config Settings   Errors  

The PTECHECOMMERCE component is an advanced tool used to authorize credit card transactions in both Direct Marketing and E-Commerce environments with the Paymentech NetConnect system on the Tampa platform. It allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

TibcPTechECommerce

Remarks

Setting up the component and authorizing a transaction is easy. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your IndustryType to either Direct Marketing (mail order/telephone order) or E-Commerce at this time.

After the merchant information is setup, you may enter transaction data. The Credit Card's CardEntryDataSource must be Manually Entered for this component, so the CardNumber, CardExpMonth, and CardExpYear properties should be filled out and the CardMagneticStripe left empty. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. In addition, the TransactionAmount should be set with the total amount for the transaction, including any taxes.

Now simply call the Sale or AuthOnly method to send the authorization to the Paymentech Server.

The status of the authorization request will be stored in the ResponseCode property, with human-readable text appearing in the ResponseText property. There are several other Response properties which will contain data that should be logged.

Once an authorization request is approved, one of three things happen. If you are using the Host Capture SettlementMode, and your Paymentech account is setup with the Host Auto Close feature, you need take no further action. The host will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. In order for the merchant's batch to be included in the Paymentech Host Auto Close process, the merchant parameter file on the host must indicate that the merchant is Auto Close. Without this flag being set, the merchant's transactions must be settled with a Manual Batch Release.

If you are using the Host Capture SettlementMode, and your Paymentech account not setup with Host Auto Close, then after an authorization is approved the transaction is added to the current batch on the Paymentech Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through the Manual Batch Release Settlement process in order for the blocked money to be transferred to the merchant's account. To release a batch for settlement, please see the PTechHostSettle component.

If you are using the Terminal Capture SettlementMode, you must store the XML aggregate returned from the GetDetailAggregate method and submit it at the end of the day in a manual batch settlement. A detail aggregate for each authorized transaction must be sent in a batch using the PTechManualSettle component. A transaction that has been authorized and then subsequently voided with this component must NOT be added to the batch settlement, and must not be submitted with the PTechManualSettle component. Any transaction not submitted with PTechManualSettle will eventually time out, and the block on the customer's card will be removed (essentially, you may void transactions by simply not sending them in the batch settlement). The Terminal Capture SettlementMode is required for the Restaurant and Hotel IndustryTypes. This is because both IndustryTypes will generally have additional charges added on to the original authorization (for example: a tip for your server, or a drink from the hotel bar charged to your room). Other IndustryTypes may benefit from this functionality as well, but if you do not require your transactions to be authorized for one amount and then settled for a different amount, it is highly recommended you use the much simpler Host Capture SettlementMode.

Note that a transaction authorized in the Host Capture SettlementMode MUST be released for settlement using the PTechHostSettle component. It cannot be added to a manual batch settlement using the PTechManualSettle component. Doing so will result in charging the customer twice! Likewise, transactions authorized with SettlementMode set to Terminal Capture cannot be released using the PTechHostSettle component, because no record of the transaction has been stored on the Paymentech Server.

Also note that you cannot mix Host Capture and Terminal Capture SettlementModes on the same MerchantNumber / TerminalNumber pair. Contact Paymentech to setup your merchant account for Terminal Capture.

Property List

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

Method List

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

Event List

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

Config Settings

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

CardType Property (PTechECommerce Component)

Type of credit card being used in this transaction.

Syntax

__property TibcPTechECommerceCardTypes CardType = { read=FCardType, write=FSetCardType };

enum TibcPTechECommerceCardTypes {
  ctUnknown=0,
  ctVisa=1,
  ctMasterCard=2,
  ctAMEX=3,
  ctDiscover=4,
  ctDiners=5,
  ctJCB=6,
  ctVisaElectron=7,
  ctMaestro=8,
  ctLaser=10
};

Default Value

ctUnknown

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (PTechECommerce Component)

Three digit security code on back of card (optional).

Syntax

__property String CardCVVData = { read=FCardCVVData, write=FSetCardCVVData };

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (PTechECommerce Component)

Indicates the presence of the card verification value.

Syntax

__property TibcPTechECommerceCardCVVPresences CardCVVPresence = { read=FCardCVVPresence, write=FSetCardCVVPresence };

enum TibcPTechECommerceCardCVVPresences {
  cvpNotProvided=0,
  cvpProvided=1,
  cvpIllegible=2,
  cvpNotOnCard=3
};

Default Value

cvpNotProvided

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The component will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (PTechECommerce Component)

This property contains a 1-character code identifying the source of the customer data.

Syntax

__property TibcPTechECommerceCardEntryDataSources CardEntryDataSource = { read=FCardEntryDataSource, write=FSetCardEntryDataSource };

enum TibcPTechECommerceCardEntryDataSources {
  edsTrack1=0,
  edsTrack2=1,
  edsManualEntryTrack1Capable=2,
  edsManualEntryTrack2Capable=3,
  edsManualEntryNoCardReader=4,
  edsTrack1Contactless=5,
  edsTrack2Contactless=6,
  edsManualEntryContactlessCapable=7,
  edsIVR=8,
  edsKiosk=9
};

Default Value

edsTrack1

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (PTechECommerce Component)

Expiration month of the credit card specified in Number .

Syntax

__property int CardExpMonth = { read=FCardExpMonth, write=FSetCardExpMonth };

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (PTechECommerce Component)

Expiration year of the credit card specified in Number .

Syntax

__property int CardExpYear = { read=FCardExpYear, write=FSetCardExpYear };

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (PTechECommerce Component)

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

__property bool CardIsEncrypted = { read=FCardIsEncrypted, write=FSetCardIsEncrypted };

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (PTechECommerce Component)

Track data read off of the card's magnetic stripe.

Syntax

__property String CardMagneticStripe = { read=FCardMagneticStripe, write=FSetCardMagneticStripe };

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

component.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" component.CardEntryDataSource = edsTrack1 or component.CardMagneticStripe = "4788250000028291=05121015432112345678" component.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (PTechECommerce Component)

Customer's credit card number for the transaction.

Syntax

__property String CardNumber = { read=FCardNumber, write=FSetCardNumber };

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

CAVV Property (PTechECommerce Component)

AuthenticationCAVV data from a ThreeDSecure authentication.

Syntax

__property String CAVV = { read=FCAVV, write=FSetCAVV };

Default Value

""

Remarks

This property is used to pass 3D Secure CAVV data on to the transaction server. This property must be a 28 or 32 byte Base-64 encoded value. This component may be used in conjunction with the IP*Works! 3D Secure MPI component or with any other 3D Secure MPI implementation. For example:

component.CAVV = ThreeDSecure.AuthenticationCAVV

Other properties necessary for passing 3D Secure data are XID and ECI.

Data Type

String

ClientNumber Property (PTechECommerce Component)

Merchant configuration property, assigned by Paymentech.

Syntax

__property String ClientNumber = { read=FClientNumber, write=FSetClientNumber };

Default Value

""

Remarks

The ClientNumber will be supplied to you by Paymentech.

Data Type

String

CustomerAddress Property (PTechECommerce Component)

The customer's billing address.

Syntax

__property String CustomerAddress = { read=FCustomerAddress, write=FSetCustomerAddress };

Default Value

""

Remarks

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

Data Type

String

CustomerZip Property (PTechECommerce Component)

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

Syntax

__property String CustomerZip = { read=FCustomerZip, write=FSetCustomerZip };

Default Value

""

Remarks

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

Data Type

String

DuplicateChecking Property (PTechECommerce Component)

Indicates whether duplicate checking is enabled.

Syntax

__property TibcPTechECommerceDuplicateCheckings DuplicateChecking = { read=FDuplicateChecking, write=FSetDuplicateChecking };

enum TibcPTechECommerceDuplicateCheckings {
  duDoNotSendIndicator=0,
  duNoDuplicateChecking=1,
  duErrorOnDuplicate=2,
  duReturnOriginalResponse=3
};

Default Value

duDoNotSendIndicator

Remarks

This Duplicate Checking Indicator is used to tell the Host whether or not to check for duplicate transactions. This property is not valid for BatchInquiry and BatchRelease transactions.

In order to be viewed as a duplicate, the transaction must be exactly the same as the original. This includes SequenceNumber and TransactionAmount.

Data Type

Integer

ECI Property (PTechECommerce Component)

Electronic Commerce Indicator.

Syntax

__property String ECI = { read=FECI, write=FSetECI };

Default Value

"7"

Remarks

This field contains a 1-character transaction indicator identifying the type of transaction being authorized. This is also known as "MOTO". This value is used only for Card Not Present transactions. See the table below for a list of supported values.

Data Type

String

GoodsIndicator Property (PTechECommerce Component)

Indicates the type of goods being sold by an e-Commerce merchant.

Syntax

__property TibcPTechECommerceGoodsIndicators GoodsIndicator = { read=FGoodsIndicator, write=FSetGoodsIndicator };

enum TibcPTechECommerceGoodsIndicators {
  pgiPhysicalGoods=0,
  pgiDigitalGoods=1
};

Default Value

pgiPhysicalGoods

Remarks

If the merchant is selling physical goods (goods that are shipped or are otherwise tangible) this property must be set to pgiPhysicalGoods. If the merchant is selling Digital goods, such a membership, or any software or file that is delivered electronically, this field must be set to pgiDigitalGoods. This property is only valid when the IndustryType is set to itECommerce.

Data Type

Integer

IndustryType Property (PTechECommerce Component)

Determines the merchant's industry type.

Syntax

__property TibcPTechECommerceIndustryTypes IndustryType = { read=FIndustryType, write=FSetIndustryType };

enum TibcPTechECommerceIndustryTypes {
  pitRetail=0,
  pitDirectMarketing=1,
  pitECommerce=2,
  pitRestaurant=3,
  pitHotel=4
};

Default Value

pitECommerce

Remarks

This property sets the merchant's industry type. Valid values are shown in the table below:

* Restaurant orders taken over the phone should be processed as pitDirectMarketing transactions. Hotel transactions should always be processed in the pitHotel IndustryType. Setting the HotelPreferredCustomer property to True.

Data Type

Integer

InvoiceNumber Property (PTechECommerce Component)

Merchant-generated invoice number.

Syntax

__property String InvoiceNumber = { read=FInvoiceNumber, write=FSetInvoiceNumber };

Default Value

""

Remarks

This property contains a merchant-generated invoice number. This number should be unique for each transaction. The maximum length for this properties varies depending on the IndustryType. For Retail transactions the max length is 6 characters. For Direct Marketing transactions it is 9 characters, and for Electronic Commerce transactions the maximum length is 16 characters. Any text beyond these limits will be truncated by the component.

Data Type

String

Level2PurchaseId Property (PTechECommerce Component)

Purchase Identifier for use when sending Level II data.

Syntax

__property String Level2PurchaseId = { read=FLevel2PurchaseId, write=FSetLevel2PurchaseId };

Default Value

""

Remarks

Purchase Identifier for use when sending Level II data. This property contains a Purchase Identifier (Purchase Order Number or Order Number). The Level2PurchaseId, Level2SalesTax, and Level2ShipToZip properties are used to transmit Level II purchasing card data to the host. If any of these properties contain a value, Level II purchasing data will be sent with the authorization request. If they are all empty, Level II data will not be sent. The maximum length for this property is 17 characters.

Data Type

String

Level2SalesTax Property (PTechECommerce Component)

Sales Tax for use when sending Level II data.

Syntax

__property String Level2SalesTax = { read=FLevel2SalesTax, write=FSetLevel2SalesTax };

Default Value

""

Remarks

Sales Tax for use when sending Level II data. This property contains the portion of the TransactionAmount which is sales tax. This amount is presented in US Dollars with a decimal point in the proper position, and has a maximum length of 9 characters. Set this property to "EXEMPT" if the transaction is not taxable. Set it to "0.00" if there is no tax provided.

The Level2PurchaseId, Level2SalesTax, and Level2ShipToZip properties are used to transmit Level II purchasing card data to the host. If any of these properties contain a value, Level II purchasing data will be sent with the authorization request. If they are all empty, Level II data will not be sent.

Data Type

String

Level2ShipToZip Property (PTechECommerce Component)

Destination ZipCode for use when sending Level II data.

Syntax

__property String Level2ShipToZip = { read=FLevel2ShipToZip, write=FSetLevel2ShipToZip };

Default Value

""

Remarks

Destination ZipCode for use when sending Level II data. This property contains the zip code where the purchased goods are to be shipped. If this is a face-to-face transaction in a retail environment where the customer immediately receives the goods, this property should be the Zip code of the merchant location where the item was purchased.

The Level2PurchaseId, Level2SalesTax, and Level2ShipToZip properties are used to transmit Level II purchasing card data to the host. If any of these properties contain a value, Level II purchasing data will be sent with the authorization request. If they are all empty, Level II data will not be sent.

Data Type

String

MerchantNumber Property (PTechECommerce Component)

A unique number used to identify the merchant, assigned by Paymentech.

Syntax

__property String MerchantNumber = { read=FMerchantNumber, write=FSetMerchantNumber };

Default Value

""

Remarks

This 12 digit field contains a unique number to identify the merchant to the host.

Data Type

String

Password Property (PTechECommerce Component)

Password for authentication with the NetConnect Server .

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

The Password will be supplied to you by Paymentech.

Data Type

String

PinlessDebit Property (PTechECommerce Component)

Indicates whether the transaction will be a Pinless Debit transaction.

Syntax

__property bool PinlessDebit = { read=FPinlessDebit, write=FSetPinlessDebit };

Default Value

false

Remarks

When set to "True", a Pinless Debit transaction will be sent which enables a customer to pay for a transaction using their debit card without entering a PIN.

This setting is only applicable to Sale Credit and VoidTransaction transactions.

Data Type

Boolean

POSRetrievalNumber Property (PTechECommerce Component)

Merchant-generated reference number, used for reversals.

Syntax

__property String POSRetrievalNumber = { read=FPOSRetrievalNumber, write=FSetPOSRetrievalNumber };

Default Value

""

Remarks

This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the PTechReversal component to reverse an authorization or sale.

Data Type

String

ProxyAuthScheme Property (PTechECommerce Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TibcPTechECommerceProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TibcPTechECommerceProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (PTechECommerce Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (PTechECommerce Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (PTechECommerce Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (PTechECommerce Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (PTechECommerce Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TibcPTechECommerceProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TibcPTechECommerceProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (PTechECommerce Component)

This property contains a username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseApprovalCode Property (PTechECommerce Component)

Contains an authorization code when a transaction has been approved, or an error code.

Syntax

__property String ResponseApprovalCode = { read=FResponseApprovalCode };

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved, or an error code. This six character field contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction has not been approved, then this field will contain an error code, and the ResponseText property will contain the description. Note that the host does not send back an actual authorization code for Credit Returns. Instead, the host sends back six blank spaces in the authorization code field. Credit VOIDS return the original authorization number.

See the list of errors for this component for more information.

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (PTechECommerce Component)

Used for partial authorizations.

Syntax

__property String ResponseAuthorizedAmount = { read=FResponseAuthorizedAmount };

Default Value

""

Remarks

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

Note that the ResponseAuthorizedAmount will only contain a value if the PartialRedemption property in the authorizing component was set to True. It will remain blank otherwise.

This property is read-only.

Data Type

String

ResponseAuthSource Property (PTechECommerce Component)

Indicates the source of the authorization code stored in ApprovalCode .

Syntax

__property String ResponseAuthSource = { read=FResponseAuthSource };

Default Value

""

Remarks

Indicates the source of the authorization code stored in ResponseApprovalCode. This field contains a one character code indicating the source of the ResponseApprovalCode. The received code must be stored and submitted in the batch settlement. Valid source codes:

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

Data Type

String

ResponseAVSResult Property (PTechECommerce Component)

Contains the Address Verification System result code.

Syntax

__property String ResponseAVSResult = { read=FResponseAVSResult };

Default Value

""

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below. Please see the ResponseCode property for a more detailed list of ResponseCode and ResponseAVSResult code combinations.

Valid AVS Codes:

If supporting international transactions, six additional International Address Verification Service (IAVS) codes are introduced:

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

Data Type

String

ResponseBatchNumber Property (PTechECommerce Component)

Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTECHHOSTSETTLE component, or after a SendSettlement sent using the PTECHMANUALSETTLE component.

Syntax

__property String ResponseBatchNumber = { read=FResponseBatchNumber };

Default Value

""

Remarks

Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle component, or after a SendSettlement sent using the PTechManualSettle component.

This property is read-only.

Data Type

String

ResponseCardLevel Property (PTechECommerce Component)

This property contains a two-character code created by Visa during the authorization process.

Syntax

__property String ResponseCardLevel = { read=FResponseCardLevel };

Default Value

""

Remarks

This property contains a two-character code created by Visa during the authorization process.

The current list of possible return values can be found below: Visa Card Level Results Code:

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

Data Type

String

ResponseCardType Property (PTechECommerce Component)

Type of the credit card.

Syntax

__property String ResponseCardType = { read=FResponseCardType };

Default Value

""

Remarks

Type of the credit card.

Paymentech determines the type of credit card used for each authorization, and returns that value to the merchant in the response. The following is a list of card mnemonics and their meanings.

This property is read-only.

Data Type

String

ResponseCAVVCode Property (PTechECommerce Component)

Results of the CAVV authentication.

Syntax

__property String ResponseCAVVCode = { read=FResponseCAVVCode };

Default Value

""

Remarks

Results of the CAVV authentication. This field is only returned in response to transactions containing Verified By Visa / MasterCard SecureCode CAVV authentication data.

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

Data Type

String

ResponseCode Property (PTechECommerce Component)

Indicates the status of the authorization request.

Syntax

__property String ResponseCode = { read=FResponseCode };

Default Value

""

Remarks

Indicates the status of the authorization request. This is the property used to determine whether a transaction has been approved or not. Valid values for this property are:

See the list of errors for this component for more information.

This property is read-only.

Data Type

String

ResponseCVVResult Property (PTechECommerce Component)

Contains the returned CVV result code if it was requested.

Syntax

__property String ResponseCVVResult = { read=FResponseCVVResult };

Default Value

""

Remarks

Contains the returned CVV result code if it was requested. If a CVV value was present in the CardCVVData property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. Please note that a CVV Result code is never returned for an American Express transaction, even if the CardCVVData property is filled. Instead, an AMEX transaction will be declined if the CVV value does not match, with an ResponseText indicating such. The following is a list of current result codes:

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

Data Type

String

ResponseNetworkId Property (PTechECommerce Component)

Authorizing network Identifier which indicates which network approved this transaction.

Syntax

__property String ResponseNetworkId = { read=FResponseNetworkId };

Default Value

""

Remarks

Authorizing network Identifier which indicates which network approved this transaction. A list of codes follows.

This property is read-only.

Data Type

String

ResponseRetrievalNumber Property (PTechECommerce Component)

Reference number returned from the Paymentech host.

Syntax

__property String ResponseRetrievalNumber = { read=FResponseRetrievalNumber };

Default Value

""

Remarks

Reference number returned from the Paymentech host. This is the reference number of the transaction as assigned by the Paymentech host. This number must remain with the transaction for the duration of the transaction's life cycle. This information is sent as a parameter in the VoidTransaction method.

If the SettlementMode is set to manual this property will contain the POSRetrievalNumber submitted in the authorization. If no POSRetrievalNumber was sent, this property will contain all zeros, and you will not have a reference number for the transaction.

If the SettlementMode is set to host settle, this property will always contain the Paymentech-generated retrieval number returned by the transaction server, regardless of the value contained in the POSRetrievalNumber property.

In all cases, the ResponseRetrievalNumber will contain the number used to reference the transaction when issuing voids or reversals.

This property is read-only.

Data Type

String

ResponseSequenceNumber Property (PTechECommerce Component)

SequenceNumber echoed from the authorization.

Syntax

__property String ResponseSequenceNumber = { read=FResponseSequenceNumber };

Default Value

""

Remarks

SequenceNumber echoed from the authorization. After any transaction this property will contain the same value sent in the SequenceNumber property.

This property is read-only.

Data Type

String

ResponseText Property (PTechECommerce Component)

Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result.

Syntax

__property String ResponseText = { read=FResponseText };

Default Value

""

Remarks

Approval/Decline/Error text message information This field contains a response or display text message, and is used by the terminal to display the authorization result. This property will contain human-readable text indicating whether the transaction was approved or declined, or will contain a description of the error. The actual error code will be returned in the ResponseApprovalCode property. The ResponseText property is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the ResponseCode property to determine this.

See the list of errors for this component for more information.

This property is read-only.

Data Type

String

ResponseTransactionId Property (PTechECommerce Component)

This 15-character property contains the Transaction Identifier assigned by the card issuer or network.

Syntax

__property String ResponseTransactionId = { read=FResponseTransactionId };

Default Value

""

Remarks

This 15-character property contains the Transaction Identifier assigned by the card issuer or network. Transaction Identifier is used to link subsequent MIT transactions to an original CIT transaction.

Note: Merchants are responsible for retaining the response TransactionId from the original transaction and submitting the TransactionId in subsequent MIT transactions.

This property is read-only.

Data Type

String

SequenceNumber Property (PTechECommerce Component)

Sequence number of the transaction.

Syntax

__property int SequenceNumber = { read=FSequenceNumber, write=FSetSequenceNumber };

Default Value

0

Remarks

This field is user definable and can be used at the users discretion. When submitting any type of transaction for approval, this sequence number may be any numeric value 0 to 2400. This is a purely optional field for the Host Capture SettlementMode, and you may choose to send a unique number or simply send every transaction with zeros. The host will echo the sequence number submitted from the authorization request back in the ResponseSequenceNumber property.

However, if you are processing with the Terminal Capture SettlementMode, SequenceNumber CANNOT remain zero, and must contain a number that is incremented for each transaction you authorized. When it reaches 2400, the SequenceNumber should then start over at 1 again.

Data Type

Integer

Server Property (PTechECommerce Component)

The URL for the PaymenTech NetConnect server.

Syntax

__property String Server = { read=FServer, write=FSetServer };

Default Value

"https://netconnect1.chasepaymentech.com/NetConnect/controller"

Remarks

This property contains the server to which all transactions are sent.

Data Type

String

SSLAcceptServerCertEncoded Property (PTechECommerce Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (PTechECommerce Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (PTechECommerce Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Byte Array

SSLCertStorePassword Property (PTechECommerce Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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 (PTechECommerce Component)

This is the type of certificate store for this certificate.

Syntax

__property TibcPTechECommerceSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (PTechECommerce Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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 (PTechECommerce Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TibcPTechECommerceSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibcPTechECommerceSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (PTechECommerce Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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

Byte Array

TAVV Property (PTechECommerce Component)

Visa/ChaseNet Token Authentication Verification Value to support 3-D Secure (3DS) validation.

Syntax

__property String TAVV = { read=FTAVV, write=FSetTAVV };

Default Value

""

Remarks

This property is used to pass 3D Secure TAVV data for token-based card-on-file, e-commerce, and application-based e-commerce transactions. This property must be a 28 byte Base-64 encoded value.

Data Type

String

TerminalNumber Property (PTechECommerce Component)

Terminal number assigned by Paymentech.

Syntax

__property String TerminalNumber = { read=FTerminalNumber, write=FSetTerminalNumber };

Default Value

""

Remarks

3-digit field assigned by Paymentech, which identifies the terminal to the host.

Data Type

String

Timeout Property (PTechECommerce Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransactionAmount Property (PTechECommerce Component)

Purchase amount for an authorization.

Syntax

__property String TransactionAmount = { read=FTransactionAmount, write=FSetTransactionAmount };

Default Value

""

Remarks

This field contains the transaction amount to be authorized. The transaction amount is presented in US Dollars with a decimal point in the proper position. If sending a Debit transaction and the customer requests cash back, the TransactionAmount must include the total cost of the purchase, PLUS the DebitCashBack amount.

This must be formatted as a dollar amount with a real decimal point, excluding the dollar sign. For instance "12.00"

Data Type

String

UserId Property (PTechECommerce Component)

UserId for authentication with the NetConnect Server .

Syntax

__property String UserId = { read=FUserId, write=FSetUserId };

Default Value

""

Remarks

The UserId will be supplied to you by PaymenTech.

Data Type

String

XID Property (PTechECommerce Component)

TransactionId from a 3D Secure authentication.

Syntax

__property String XID = { read=FXID, write=FSetXID };

Default Value

""

Remarks

This property is used to pass the 3D Secure TransactionId (XID) data on to the credit card processor. This property must be a 40-byte plaintext value, or a 28-byte Base-64 encoded value. This component may be used in conjunction with the IP*Works! 3D Secure MPI component or with any other 3D Secure MPI implementation. For example:

component.XID = ThreeDSecure.TransactionId

Other properties necessary for passing 3D Secure data are CAVV and ECI.

Data Type

String

AuthOnly Method (PTechECommerce Component)

Sends an AuthOnly transaction to the host.

Syntax

void __fastcall AuthOnly();

Remarks

An Auth Only transaction is used to verify and reserve the cardholder's open-to-buy funds available at that time. This transaction is NOT added to the open batch. In order to settle (be paid) for this transaction, the merchant must run a Capture transaction using the original ResponseApprovalCode obtained during this Auth Only transaction. This will add the transaction to the batch. The funds may then be captured by settling the batch with the BatchRelease method. Typically any funds blocked with a Sale or Auth Only transaction are reserved for approximately seven (7) to ten (10) days. This may vary from issuer to issuer. Sample transactions follow.

E-Commerce AuthOnly transaction: component.IndustryType = itECommerce component.CardEntryDataSource = dsManuallyEntered component.GoodsIndicator = giPhysicalGoods component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.CustomerAddress = "123 Nowhere Ln." ' optional AVS data component.CustomerZip = "90210" ' optional AVS data component.TransactionAmount = "1.00" component.InvoiceNumber = "1234" component.AuthOnly()

Retail AuthOnly transaction: component.IndustryType = itRetail component.CardEntryDataSource = dsTrack1 component.CardMagneticStripe = "B4788250000028291^PAYMENTECH^05121015432112345678" component.TransactionAmount = "1.00" component.AuthOnly()

Retail manually keyed AuthOnly transaction: component.IndustryType = itRetail component.CardEntryDataSource = dsManuallyEntered component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.TransactionAmount = "1.00" component.AuthOnly()

Capture Method (PTechECommerce Component)

Sends a capture transaction to the PaymenTech Server.

Syntax

void __fastcall Capture(String ApprovalCode);

Remarks

Capture (Prior Sales) are typically used when a merchant has previously utilized the AuthOnly method. A Capture transaction adds the transaction to the current open batch, and the transaction will be settled at the next call to the PTechHostSettle component's BatchRelease method. The Paymentech system treats Capture and Force transactions identically, so this method may also be used when a merchant has obtained voice approval over the phone.

Manually keyed capture: component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.TransactionAmount = "1.00" component.Capture("123456") 'value from voice auth or previous AuthOnly trans

Note: This method is not available when using the Terminal Capture SettlementMode.

Config Method (PTechECommerce Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

Credit Method (PTechECommerce Component)

Credits a cardholder's account or obtains a Return Authorization.

Syntax

void __fastcall Credit();

Remarks

Also known as a Return, this transaction refunds the cardholder's account. It can be used in both Host Capture and Terminal Capture SettlementModes.

If you are using the Host Capture SettlementMode, the Credit method will send a Return request to Paymentech. Paymentech will treat the request as an online purchase return authorization if the online return functionality is available for the given card brand and merchant. In this case an authorization request is sent to the card brand and if the authorization is successful the transaction is automatically included in the current batch for settlement. If that functionality is not available the request will be handled as an off-line credit request and will be included in the batch for settlement without requesting an authorization first.

If you are using the Terminal Capture SettlementMode, the Credit method can only be used for online purchase return authorization requests when such functionality is available for the given card and merchant. It cannot be used for off-line credit transactions. When using the Credit method in Terminal Capture mode you will need to get the authorization response and include the transaction in the batch to be settled using the PTechManualSettle component.

Manually keyed credit: component.CardNumber = "4444333322221111" component.CardExpMonth = 12 component.CardExpYear = 2025 component.CardEntryDataSource = dsManuallyEntered component.TransactionAmount = "1.00" 'credits $1.00 component.Credit()

GetDetailAggregate Method (PTechECommerce Component)

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

Syntax

String __fastcall GetDetailAggregate();

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This is only used when processing on the Terminal Capture System (TCS) and using the PTechManualSettle component Generally, you will only use detail aggregates and manual settlements for the Hotel and Restaurant IndustryTypes.

This aggregate must be passed to the PTechManualSettle component's DetailRecords array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or extra hotel charges for instance), you may use the PTechDetailRecord component to do so.

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

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

PTechCharge.Sale(); PTechManualSettle.DetailRecords[0] = PTechCharge.GetDetailAggregate();

Interrupt Method (PTechECommerce Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (PTechECommerce Component)

Clears all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

This method clears all properties to their default values.

Sale Method (PTechECommerce Component)

Sends a Sale transaction to the host.

Syntax

void __fastcall Sale();

Remarks

A basic sale transaction. This transaction decrements the cardholder's open-to-buy funds for the sale amount. This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the PTechHostSettle component. Sample transactions follow.

E-Commerce Sale transaction: component.IndustryType = itECommerce component.GoodsIndicator = giPhysicalGoods component.CardEntryDataSource = dsManuallyEntered component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.CustomerAddress = "123 Nowhere Ln." ' optional AVS data component.CustomerZip = "90210" ' optional AVS data component.TransactionAmount = "1.00" component.Sale()

Retail Sale transaction: component.IndustryType = itRetail component.CardEntryDataSource = dsTrack1 component.CardMagneticStripe = "B4788250000028291^PAYMENTECH^05121015432112345678" component.TransactionAmount = "1.00" component.Sale()

Retail manually keyed Sale transaction: component.IndustryType = itRetail component.CardEntryDataSource = dsManuallyEntered component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.TransactionAmount = "1.00" component.Sale()

VoidTransaction Method (PTechECommerce Component)

Voids a transaction in the current batch.

Syntax

void __fastcall VoidTransaction(String RetrievalNumberToVoid, String LastRetrievalNumber);

Remarks

This method voids a previously authorized transaction. A transaction can only be voided if it exists in the current open batch. If the batch that contained the target transaction has already been released (settled), you must use the Credit method instead.

The VoidTransaction method has two parameters, RetrievalNumberToVoid and LastRetrievalNumber. RetrievalNumberToVoid is the ResponseRetrievalNumber of the transaction you wish to void. LastRetrievalNumber should be set to the last ResponseRetrievalNumber received from the Paymentech Server. If LastRetrievalNumber is left blank, the current contents of the ResponseRetrievalNumber property will be used instead.

Before sending a void, you must make sure that the CardNumber property contains the card number from the original transaction. Also note that since AuthOnly transactions are not added to the current batch, they cannot be voided. Examples follow.

component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.TransactionAmount = "1.00" component.Sale() cnumToVoid = component.CardNumber refNumToVoid = component.ResponseRetrievalNumber ... more sale transactions ... 'All that's needed for a void: component.CardNumber = cnumToVoid component.VoidTransaction(refNumToVoid, "")

Note that in the above void, if you use a new instance of the component or otherwise reset it's state, you must set the LastRetrievalNumber parameter as well.

Note: This method is not available when using the Terminal Capture SettlementMode.

DataPacketIn Event (PTechECommerce Component)

Fired when receiving a data packet from the transaction server.

Syntax

typedef struct {
  String DataPacket;
  DynamicArray<Byte> DataPacketB;
} TibcPTechECommerceDataPacketInEventParams;
typedef void __fastcall (__closure *TibcPTechECommerceDataPacketInEvent)(System::TObject* Sender, TibcPTechECommerceDataPacketInEventParams *e);
__property TibcPTechECommerceDataPacketInEvent OnDataPacketIn = { read=FOnDataPacketIn, write=FOnDataPacketIn };

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

DataPacketOut Event (PTechECommerce Component)

Fired when sending a data packet to the transaction server.

Syntax

typedef struct {
  String DataPacket;
  DynamicArray<Byte> DataPacketB;
} TibcPTechECommerceDataPacketOutEventParams;
typedef void __fastcall (__closure *TibcPTechECommerceDataPacketOutEvent)(System::TObject* Sender, TibcPTechECommerceDataPacketOutEventParams *e);
__property TibcPTechECommerceDataPacketOutEvent OnDataPacketOut = { read=FOnDataPacketOut, write=FOnDataPacketOut };

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.

Error Event (PTechECommerce Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibcPTechECommerceErrorEventParams;
typedef void __fastcall (__closure *TibcPTechECommerceErrorEvent)(System::TObject* Sender, TibcPTechECommerceErrorEventParams *e);
__property TibcPTechECommerceErrorEvent OnError = { read=FOnError, write=FOnError };

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 (PTechECommerce Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibcPTechECommerceSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibcPTechECommerceSSLServerAuthenticationEvent)(System::TObject* Sender, TibcPTechECommerceSSLServerAuthenticationEventParams *e);
__property TibcPTechECommerceSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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 (PTechECommerce Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibcPTechECommerceSSLStatusEventParams;
typedef void __fastcall (__closure *TibcPTechECommerceSSLStatusEvent)(System::TObject* Sender, TibcPTechECommerceSSLStatusEventParams *e);
__property TibcPTechECommerceSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (PTechECommerce Component)

PTechECommerce Config Settings

HTTP 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 (PTechECommerce Component)

PTechECommerce Errors

Paymentech Server Errors:

The following is a list of error codes which may be returned by the Paymentech Server. In the case of a server-side error condition, the ResponseCode property will contain "E", the error code will be contained in the ResponseApprovalCode property, and the description in ResponseText

Paymentech Issuer Errors

Paymentech Format Errors

Paymentech Host / Setup Errors

Paymentech Debit / EBT Specific Errors

Paymentech Batch Management Errors (use the ErrorCode configuration setting to retrieve this information from the PTechHostSettle component.

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors