PTechHotel Module

Properties Methods Events Config Settings Errors

The PTECHHOTEL module is used to authorize credit card transactions for the Hotel IndustryType with the Paymentech NetConnect system on the Tampa platform. This module creates a simple interface for processing transactions in the Hotel environment. It allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This module can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the module, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

DPaymentsSDK.Ptechhotel

Remarks

Setting up the class 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 and PINCapability at this time.

After the merchant information is setup, you may enter transaction data. When the Credit Card's CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent in card-present retail transactions by filling the CustomerAddress and CustomerZip properties. For any other CardEntryDataSource , the CardMagneticStripe property should be filled. In addition, the TransactionAmount should be set with the total amount for the transaction, including any taxes.

Now you should set the Hotel properties with extra information about the transaction. At minimum you should set the HotelArrivalDate (or reservation date), estimated HotelDuration of stay, HotelDepartureDate (planned or actual), and HotelSaleCode. If the transaction is card-not-present (ie: phone or online reservation) and the customer supplies a Visa, MasterCard, or American Express card for payment, you must also set the HotelPreferredCustomer to True. This indicates a card-not-present transaction for these two card types. Other card types must use the PTechECommerce class for card-not-present transactions.

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.

Hotel transactions only operate in Terminal Capture mode. This means you cannot rely on Paymentech to automatically handle the settlement for you. Instead, you must save the XML aggregate returned from the GetDetailAggregate method, for each and every authorization. At the end of the day, you must then use the PTechManualSettle class to send all of these aggregates for processing. The reason Paymentech cannot handle the batch automatically for the PTechHotel class is because Hotel transactions by nature will usually have additional charges tacked on to the originally authorized amount. It may also be several days between check-in (authorization) and departure (when you can then settle the card). The XML aggregates for each transaction may be manipulated using the PTechDetailRecord class. This will allow you to add or remove additional days to the stay, tack on charges for room service or telephone calls, and more.

Note that when processing transactions in Terminal Capture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle classs.

Property List

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


Card	Contains the customer's credit card information.
ClientNumber	Merchant configuration property, assigned by Paymentech.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
Hotel	Contains additional information required for the Hotel/Lodging industry.
InvoiceNumber	Hotel Folio Number.
MerchantNumber	A unique number used to identify the merchant, assigned by Paymentech.
Password	Password for authentication with the NetConnect Server .
PINCapability	Indicates if the terminal device supports a PIN pad.
POSRetrievalNumber	Merchant-generated reference number, used for reversals.
Proxy	This property includes a set of properties related to proxy access.
Response	Contains the response to an authorization.
SequenceNumber	Sequence number of the transaction.
Server	The URL for the PaymenTech NetConnect server.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
TerminalNumber	Terminal number assigned by Paymentech.
Timeout	A timeout for the module.
TransactionAmount	Purchase amount for an authorization.
UserId	UserId for authentication with the NetConnect Server .

Method List

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


AuthOnly	Sends an AuthOnly transaction to the host.
Config	Sets or retrieves a configuration setting.
Credit	Credits a cardholder's account or obtains a Return Authorization.
GetDetailAggregate	Returns an aggregate containing details of this transaction, which is then used for manual settlement.
Interrupt	Interrupt the current method.
Reset	Clears all properties to their default values.
Sale	Sends a Sale transaction to the host.
VisaIncremental	Increases the TransactionAmount of a previously-submitted transaction.
VisaReversal	Decreases the TransactionAmount of a previously-submitted transaction.

Event List

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


DataPacketIn	Fired when receiving a data packet from the transaction server.
DataPacketOut	Fired when sending a data packet to the transaction server.
Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Config Settings

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


AllowPartialAuths	Indicates whether partial authorizations are to be supported.
CAVV	AuthenticationCAVV data from a ThreeDSecure authentication.
CustomerDefinedData	Additional transaction identification data.
DeviceID	Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.
DeviceType	Indicates the Remote Payment Type for MasterCard Contactless Authorizations.
DiscoverAuthAmount	Returns the amount authorized for the transaction.
DiscoverPINCapabability	Indicates if the POS is capable of supporting a PIN.
DiscoverPOSEntryMode	Returns the method by which the primary account number was entered at the POS.
DiscoverProcessingCode	Returns the type of Authorization request that was submitted to Discover.
DiscoverSystemTraceAuditNumber	Returns the value assigned by the host/merhant to assist in identifying a specific transaction.
DiscoverTrackDataCondition	Returns condition of the track data.
ECommerceIndicator	Used to specify the indicator describing the type of internet transaction.
EMVData	The EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSource	The EMV Data Entry Source (DES).
EMVOnlineKSN	Clear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePIN	DUKPT DES encrypted PIN block for EMV Online PIN transactions.
HardwareSerialNum	Hardware Serial Number.
HostProcessingTypes	Host Processing Platform.
MessageReasonCode	Message Reason Code.
MITTransactionId	Transaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale or AuthOnly transaction.
POSEntryModeCOF	POS Entry Mode Credential on File.
POSEnvironmentCode	POS Environment Code.
RequestBalanceInfo	Specifies whether to request balance information.
RequestTransactionId	Indicates the Transaction Identifier is requested.
ResponseBalanceAmount1	Credit Prepaid Available Balance #1.
ResponseBalanceAmount2	Credit Prepaid Available Balance $2.
ResponseBalanceCurrency1	Currency code for ResponseBalanceAmount1.
ResponseBalanceCurrency2	Currency code for ResponseBalanceAmount2.
ResponseEMVCardAuthCode	The ChaseNet and Visa card authentication results code.
ResponseEMVData	The response EMV data.
ResponseEMVDownloadIndicator	Whether EMV parameters should be updated.
ResponsePOSRetrievalNumber	POS Retrieval Number sent in the request, echoed back in the response.
SettlementMode	Indicates whether the module uses Paymentech's Host Capture or Terminal Capture system.
SoftwareID	Software Identifier.
SystemInformation	System Information field for Batch Inquiry and Release transactions.
VendorID	Hardware/Vendor Identifier.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the module.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the module will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the module.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the module.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the module binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the module whether or not to use the system security libraries or an internal implementation.

Card Property (PTechHotel Module)

Contains the customer's credit card information.

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a for swiped cards, or a , , and for manually entered cards. ( indicates which set of properties will be used). See the CCCard type for more information.

ClientNumber Property (PTechHotel Module)

Merchant configuration property, assigned by Paymentech.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=clientNumber,setter=setClientNumber:) NSString* clientNumber;

- (NSString*)clientNumber;
- (void)setClientNumber :(NSString*)newClientNumber;

Default Value

Remarks

The ClientNumber will be supplied to you by Paymentech.

CustomerAddress Property (PTechHotel Module)

The customer's billing address.

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

CustomerZip Property (PTechHotel Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

Hotel Property (PTechHotel Module)

Contains additional information required for the Hotel/Lodging industry.

Syntax

Swift
Objective-C

public var hotel: PTechHotelInfo {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=hotelArrivalDate,setter=setHotelArrivalDate:) NSString* hotelArrivalDate;

- (NSString*)hotelArrivalDate;
- (void)setHotelArrivalDate :(NSString*)newHotelArrivalDate;

@property (nonatomic,readwrite,assign,getter=hotelChargeDescriptor,setter=setHotelChargeDescriptor:) int hotelChargeDescriptor;

- (int)hotelChargeDescriptor;
- (void)setHotelChargeDescriptor :(int)newHotelChargeDescriptor;

@property (nonatomic,readwrite,assign,getter=hotelDepartureDate,setter=setHotelDepartureDate:) NSString* hotelDepartureDate;

- (NSString*)hotelDepartureDate;
- (void)setHotelDepartureDate :(NSString*)newHotelDepartureDate;

@property (nonatomic,readwrite,assign,getter=hotelDuration,setter=setHotelDuration:) int hotelDuration;

- (int)hotelDuration;
- (void)setHotelDuration :(int)newHotelDuration;

@property (nonatomic,readwrite,assign,getter=hotelExtraChargeAmount,setter=setHotelExtraChargeAmount:) NSString* hotelExtraChargeAmount;

- (NSString*)hotelExtraChargeAmount;
- (void)setHotelExtraChargeAmount :(NSString*)newHotelExtraChargeAmount;

@property (nonatomic,readwrite,assign,getter=hotelExtraChargesCode,setter=setHotelExtraChargesCode:) NSString* hotelExtraChargesCode;

- (NSString*)hotelExtraChargesCode;
- (void)setHotelExtraChargesCode :(NSString*)newHotelExtraChargesCode;

@property (nonatomic,readwrite,assign,getter=hotelPreferredCustomer,setter=setHotelPreferredCustomer:) BOOL hotelPreferredCustomer;

- (BOOL)hotelPreferredCustomer;
- (void)setHotelPreferredCustomer :(BOOL)newHotelPreferredCustomer;

@property (nonatomic,readwrite,assign,getter=hotelSaleCode,setter=setHotelSaleCode:) int hotelSaleCode;

- (int)hotelSaleCode;
- (void)setHotelSaleCode :(int)newHotelSaleCode;

Default Value

Remarks

This property will be sent in both authorizations and detail records when the IndustryType is set to Hotel. At minimum, you should pass the expected , , expected , and . You may pass the and in the authorization, but those are normally not known until settlement. To process a reservation or any other transaction where the customer and his card are not physically present, set the property to True;. This will indicate to Paymentech that the transaction is a card-not-present authorization ( must be set to False for normal card-present transaction processing).

InvoiceNumber Property (PTechHotel Module)

Hotel Folio Number.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

Default Value

Remarks

This property contains a hotel folio number associated with the transaction. This number must be 6 characters in length, and must contain only digits. ("0" - "9")

MerchantNumber Property (PTechHotel Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

Password Property (PTechHotel Module)

Password for authentication with the NetConnect Server .

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

Remarks

The Password will be supplied to you by Paymentech.

PINCapability Property (PTechHotel Module)

Indicates if the terminal device supports a PIN pad.

Syntax

Swift
Objective-C

public var pinCapability: PtechhotelPINCapabilities {
  get {...}
  set {...}
}

public enum PtechhotelPINCapabilities: Int32 {
  case ppUnknown = 0
  case ppAcceptsPIN = 1
  case ppNoPIN = 2
  case ppPadInoperative = 8
  case ppVerifiedPIN = 9
}


@property (nonatomic,readwrite,assign,getter=PINCapability,setter=setPINCapability:) int PINCapability;

- (int)PINCapability;
- (void)setPINCapability :(int)newPINCapability;

Default Value

Remarks

This property indicates to the host whether the merchant's terminal has a PIN entry pad. Valid values for this property are:


Unknown (0)	Unknown.
ppAcceptsPIN (1)	Terminal device accepts PIN entry.
ppNoPIN (2)	Terminal device does not accept PIN entry.
ppPadInoperative (8)	PIN pad inoperative.
ppVerifiedPIN (9)	PIN Verified by terminal device.

NOTE: Code 8 is not used at this time. This is for future use by Visa

POSRetrievalNumber Property (PTechHotel Module)

Merchant-generated reference number, used for reversals.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=POSRetrievalNumber,setter=setPOSRetrievalNumber:) NSString* POSRetrievalNumber;

- (NSString*)POSRetrievalNumber;
- (void)setPOSRetrievalNumber :(NSString*)newPOSRetrievalNumber;

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 class to reverse an authorization or sale.

Proxy Property (PTechHotel Module)

This property includes a set of properties related to proxy access.

Syntax

Swift
Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

Default Value

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Response Property (PTechHotel Module)

Contains the response to an authorization.

Syntax

Swift
Objective-C

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


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

- (NSString*)responseApprovalCode;

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

- (NSString*)responseAuthorizedAmount;

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

- (NSString*)responseAuthSource;

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

- (NSString*)responseAVSResult;

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

- (NSString*)responseBatchNumber;

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

- (NSString*)responseCardLevel;

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

- (NSString*)responseCardType;

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

- (NSString*)responseCode;

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

- (NSString*)responseCVVResult;

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

- (NSString*)responseDebitSurcharge;

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

- (NSString*)responseDebitTrace;

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

- (NSString*)responseNetworkId;

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

- (NSString*)responseRetrievalNumber;

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

- (NSString*)responseSequenceNumber;

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

- (NSString*)responseText;

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

- (NSString*)responseTransactionId;

Default Value

Remarks

This property will contain the response returned from the Paymentech server. It should be inspected (and logged) after a call to Sale, AuthOnly, Capture, Credit, or VoidTransaction. The PTechChargeResponse type contains the following fields:


	Contains an authorization code for an approved transaction.
	Used for partial authorizations. Indicates the actual amount authorized from the stored value card.
	Indicates the source of the authorization code stored in .
	Contains the Address Verification System result code. Used for fraud detection.
	Number that identifies the batch that this transaction will be settled in (only applicable to Host Capture. Will be all zeros for Terminal Capture settlements).
	Contains a two-character code created by Visa during the authorization process.
	Type of credit card that was authorized (computed by Paymentech and returned in this property).
	Indicates the success or failure of the transaction.
	Contains the returned CVV result code if it was requested. Used for fraud detection.
	The Transaction Identifier assigned by the card issuer or network.
	Additional fee (if any) charged for debit transactions.
	Debit-specific host tracking number for this transaction.
	Authorizing network Id.
	Reference number returned from the Paymentech host.
	SequenceNumber echoed from the authorization.
	Contains a human-readable message explaining the code.

SequenceNumber Property (PTechHotel Module)

Sequence number of the transaction.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=sequenceNumber,setter=setSequenceNumber:) int sequenceNumber;

- (int)sequenceNumber;
- (void)setSequenceNumber :(int)newSequenceNumber;

Default Value

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.

Server Property (PTechHotel Module)

The URL for the PaymenTech NetConnect server.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=server,setter=setServer:) NSString* server;

- (NSString*)server;
- (void)setServer :(NSString*)newServer;

Default Value

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

Remarks

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

SSLAcceptServerCertEncoded Property (PTechHotel Module)

This is the certificate (PEM/base64 encoded).

Syntax

Swift
Objective-C

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

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


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

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

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

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

Default Value

Remarks

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

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

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

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

SSLCertEncoded Property (PTechHotel Module)

This is the certificate (PEM/base64 encoded).

Syntax

Swift
Objective-C

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

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


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

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

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

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

Default Value

Remarks

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

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

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

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

SSLCertStore Property (PTechHotel Module)

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

Syntax

Swift
Objective-C

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

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


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

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

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

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

Default Value

"MY"

Remarks

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

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

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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. PKCS12 certificate store).

SSLCertStorePassword Property (PTechHotel Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

SSLCertStoreType Property (PTechHotel Module)

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

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

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


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

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

Default Value

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:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SSLCertSubject Property (PTechHotel Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

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

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (PTechHotel Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

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


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

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

Default Value

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:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (PTechHotel Module)

This is the certificate (PEM/base64 encoded).

Syntax

Swift
Objective-C

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

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


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

- (NSString*)SSLServerCertEncoded;

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

- (NSData*)SSLServerCertEncodedB;

Default Value

Remarks

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

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

This property is read-only.

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

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

TerminalNumber Property (PTechHotel Module)

Terminal number assigned by Paymentech.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=terminalNumber,setter=setTerminalNumber:) NSString* terminalNumber;

- (NSString*)terminalNumber;
- (void)setTerminalNumber :(NSString*)newTerminalNumber;

Default Value

Remarks

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

Timeout Property (PTechHotel Module)

A timeout for the module.

Syntax

Swift
Objective-C

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


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

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

Default Value

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 class will wait for the operation to complete before returning control.

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

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.

TransactionAmount Property (PTechHotel Module)

Purchase amount for an authorization.

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

This field contains the transaction amount to be authorized. 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"

UserId Property (PTechHotel Module)

UserId for authentication with the NetConnect Server .

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=userId,setter=setUserId:) NSString* userId;

- (NSString*)userId;
- (void)setUserId :(NSString*)newUserId;

Default Value

Remarks

The UserId will be supplied to you by PaymenTech.

AuthOnly Method (PTechHotel Module)

Sends an AuthOnly transaction to the host.

Syntax

Swift
Objective-C

public func authOnly() throws -> Void

- (void)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: class.IndustryType = itECommerce class.CardEntryDataSource = dsManuallyEntered class.GoodsIndicator = giPhysicalGoods class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.CustomerAddress = "123 Nowhere Ln." ' optional AVS data class.CustomerZip = "90210" ' optional AVS data class.TransactionAmount = "1.00" class.InvoiceNumber = "1234" class.AuthOnly()

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

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

Config Method (PTechHotel Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

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

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Credit Method (PTechHotel Module)

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

Syntax

Swift
Objective-C

public func credit() throws -> Void

- (void)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 class.

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

GetDetailAggregate Method (PTechHotel Module)

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

Syntax

Swift
Objective-C

public func getDetailAggregate() throws -> String

- (NSString*)getDetailAggregate;

Remarks

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

This aggregate must be passed to the PTechManualSettle class'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 class to do so.

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

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

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

Interrupt Method (PTechHotel Module)

Interrupt the current method.

Syntax

Swift
Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (PTechHotel Module)

Clears all properties to their default values.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

Sale Method (PTechHotel Module)

Sends a Sale transaction to the host.

Syntax

Swift
Objective-C

public func sale() throws -> Void

- (void)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 class. Sample transactions follow.

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

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

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

VisaIncremental Method (PTechHotel Module)

Increases the TransactionAmount of a previously-submitted transaction.

Syntax

Swift
Objective-C

public func visaIncremental(approvalCode: String) throws -> Void

- (void)visaIncremental:(NSString*)approvalCode;

Remarks

This method is used exactly like Sale and AuthOnly, except that all of the properties of the class must match the values from transaction you wish to increment. Set the TransactionAmount property with the ADDITIONAL authorization amount. If the original transaction was for $100, and you wish to increment that to $150, then the TransactionAmount should contain "50.00". The Hotel properties may reflect additional charges or duration of stay, and these should be ONLY for the additional TransactionAmount.

Once all of these properties are all set, simply call this method with the ResponseApprovalCode returned in the response to the original transaction.

An incremental transaction must NOT be added to the manual batch settlement. Instead, the detail record of the original transaction should be updated with the new settlement amount and updated Hotel properties. An authorization may only be incremented once.

Paymentech has expanded support for this method and ChaseNet, MasterCard, and Visa cards are supported.

VisaReversal Method (PTechHotel Module)

Decreases the TransactionAmount of a previously-submitted transaction.

Syntax

Swift
Objective-C

public func visaReversal(approvalCode: String) throws -> Void

- (void)visaReversal:(NSString*)approvalCode;

Remarks

This method is used to partially (or fully) reverse a previously authorized transaction. This method is used much like an AuthOnly or Sale, except that all of the properties of the class must match the values from the transaction you wish to reverse. There is however no need to set the Hotel properties for a reversal, as they will not be transmitted to the host. The TransactionAmount should reflect the new settlement amount - not the amount you wish to reverse. If you want to reduce a $100 transaction by $20, then the TransactionAmount should be set to "80.00". If you wish to completely reverse the authorization set the TransactionAmount to "0.00".

Once all of these properties are all set, simply call this method with the ResponseApprovalCode returned in the response to the original transaction.

A reversal transaction must NOT be added to the manual batch settlement. Instead, the detail record of the original transaction should be updated with the new settlement amount and Hotel properties you wish to update. An authorization may be reversed multiple times.

Note: This method was renamed by Paymentech to "partial authorization reversal" (formerly called Visa Auth Reversal). In addition to that, this transaction can be submitted for a ChaseNet, Discover (including US JCB and Diners), MasterCard and Visa transaction.

DataPacketIn Event (PTechHotel Module)

Fired when receiving a data packet from the transaction server.

Syntax

Swift
Objective-C

func onDataPacketIn(dataPacket: Data)

- (void)onDataPacketIn:(NSData*)dataPacket;

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (PTechHotel Module)

Fired when sending a data packet to the transaction server.

Syntax

Swift
Objective-C

func onDataPacketOut(dataPacket: Data)

- (void)onDataPacketOut:(NSData*)dataPacket;

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting.

Error Event (PTechHotel Module)

Information about errors during data delivery.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (PTechHotel Module)

Fired after the server presents its certificate to the client.

Syntax

Swift
Objective-C

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

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

Swift
Objective-C

func onSSLStatus(message: String)

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the to indicate which track is stored in the field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the , , and fields, and must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the to edsManualEntryNoCardReader. If you wish to set any other value for the , you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of . If you set the , , and fields, but is set to edsTrack2, the class will look for data when authorizing the transaction, and will because none is present.

Fields

cardType
TCardTypes
Default Value: 0

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


ctUnknown (0)	Invalid or unknown prefix, card type not known.
ctVisa (1)	Visa or Delta Card.
ctMasterCard (2)	MasterCard.
ctAMEX (3)	American Express Card.
ctDiscover (4)	Discover Card.
ctDiners (5)	Diners Club or Carte Blanche Card.
ctJCB (6)	JCB Card.
ctVisaElectron (7)	Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8)	Maestro Card
ctLaser (10)	Laser Card (Ireland)

cvvData
String
Default Value: ""

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 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, will be automatically set to cvpProvided. If set to empty string (""), will be automatically set to cvpNotProvided.

cvvPresence
CCCVVPresences
Default Value: 0

Indicates the presence of the card verification value.

This property is used to indicate the presence of .

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

Available values are:

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

entryDataSource
EntryDataSources
Default Value: 0

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


edsTrack1 (0)	Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1)	Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2)	Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)	Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)	Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)	Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)	Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)	Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)	Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (, , and are sent).
edsKiosk (9)	Automated kiosk transaction. Track1 or Track2 data must be sent in , the transaction cannot be manually entered.

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.


TSYSHCBenefit	edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce	edsManualEntryNoCardReader
TSYSHCRetail	edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

expMonth
Int32
Default Value: 1

Expiration month of the credit card specified in .

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

expYear
Int32
Default Value: 2000

Expiration year of the credit card specified in .

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.

isEncrypted
Bool
Default Value: False

Determines whether data set to the or fields is validated.

By default, when the or fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and data will be parsed for the track specified by . 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 or fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the may be affected, and the card number will not be verified.

magneticStripe
String
Default Value: ""

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

If 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 property to indicate which track you are sending.

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

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.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.

number
String
Default Value: ""

Customer's credit card number for the transaction.

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

Constructors

public init()

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

public init(magneticStripe: , entryDataSource: )

Proxy Type

This is the proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

authScheme
ProxyAuthSchemes
Default Value: 0

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

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

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

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

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

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

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

autoDetect
Bool
Default Value: False

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

password
String
Default Value: ""

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

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

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

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

port
Int32
Default Value: 80

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

server
String
Default Value: ""

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

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

ssl
ProxySSLTypes
Default Value: 0

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


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

user
String
Default Value: ""

This property contains a user name, if authentication is to be used for the proxy.

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

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

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

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

PTechChargeResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the PTechCharge class. The fields contained by this type are listed below.

Fields

approvalCode
String (read-only)
Default Value: ""

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 returned indicates that the transaction has not been approved, then this field will contain an error code, and the 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 class for more information.

authorizedAmount
String (read-only)
Default Value: ""

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

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

authSource
String (read-only)
Default Value: ""

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


Code	Description
1	STIP (Stand-In Processing): time-out response.
2	STIP: amount below issuer limit.
3	STIP: issuer in Suppress Inquiry mode.
4	STIP: issuer unavailable.
5	Issuer generated response.
6	Off-line approval: POS device generated.
7	Acquirer approval: Base I unavailable.
8	Acquirer approval of a referral.
9	Use for non-authorized transactions; such as credit card credits.
D	Referral: authorization code manually keyed.
E	Off-line approval: authorization code manually keyed.
F	CAFIS Interface Off-Line Post-Auth.*
G	Issuer Approval: Post-Auth.*
T	Advice of a Telcode File change initiated by the VisaPhone Issuer Direct Service.

* Currently in use by Japan Acquirer Services (JAS).

avsResult
String (read-only)
Default Value: ""

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 property for a more detailed list of and code combinations.

Valid AVS Codes:


Code	Description
0	Address verification was not requested.
A	CustomerAddress matches, CustomerZip does not.
E	AVS error / Ineligible (not a mail/phone order).
G	Ver Unavailable - Non-US Issuer does not participate.
I	Ver Unavailable - Address information not verified for international transaction.
M	Exact Match - CustomerAddress match for international transaction.
N	No match on CustomerAddress or CustomerZip.
R	Retry - Issuer system unavailable.
S	Service not supported by issuer.
U	Address information is unavailable.
W	Nine digit CustomerZip matches, CustomerAddress does not.
X	Exact AVS match, nine digit CustomerZip.
Y	Exact AVS match, five digit CustomerZip.
Z	Five digit CustomerZip matches, CustomerAddress does not.

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


B	Street address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code).
C	Street address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code).
D	Street addresses and postal codes match for international transaction.
I	Address information not verified for international transaction.
M	Street addresses and postal codes match for international transaction.
P	Postal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code).

batchNumber
String (read-only)
Default Value: ""

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

cardLevel
String (read-only)
Default Value: ""

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:


Code	Meaning
Spaces	Not applicable
A^	Visa Traditional
AX*	American Express
B^	Visa Traditional Rewards
C^	Visa Signature
D^	Visa Infinite
DI*	Discover
E^	Reserved
F^	Reserved
G^	Visa Business Card
G1	Visa Signature Business
G2	Visa Business Check Card
H^	Classic Visa Check Card
I^	Visa Commerce
J^	Reserved
J1	Visa General Prepaid
J2	Visa Prepaid Gift Card
J3	Visa Prepaid Healthcare
J4	Visa Prepaid Commercial
K^	Visa Corporate Card
K1	Visa GSA Corporate T&E
L^	Reserved
M^*	MasterCard/EuroCard and Diners
N^ - P^	Reserved
Q^	Private Label
Q1	Private Label Prepaid
R^	Proprietary Card
S^	Visa Purchasing Card
S1	Visa Fleet
S2	Visa GSA Purchasing
S3	Visa GSA Purchasing with Fleet
T^	Reserved/Interlink
U^	Visa TravelMoney
W^ - Z^	Reserved
0^ - 9^	Reserved


^	Space
*	Valid only when the transaction was re-routed to Visa for authorization.

cardType
String (read-only)
Default Value: ""

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.


VI	Visa
MC	MasterCard
AE	American Exp.
DS	Discover
JC	JCB
DB	Debit
EB	EBT
SV	Stored Value
CK	Check Authorization
IG	In Good Taste
PL	Retail PL
CC	Club Card
SC	Smarte Carte
TH	TCH Light Fleet
TS	TCRS Consumer Card
IR	Irving Oil PL
RA	RAI
DY	Disney Rewards
SR	Sears PL
BE	Best
EN	Enmark
GC	FleetCor / GasCard
VY	Voyager
FO	Fleet One
SH	Shell
GT	Gate
WX	WEX
MM	MotoMart
??	Included in Batch Totals by Card Type responses when the host has summarized more than 14 card types within the batch (includes all other card types in the batch over 14).
99	Supported in Enhanced Batch Inquiry requests when "all" details or totals are being requested.

code
String (read-only)
Default Value: ""

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:


A	Transaction is Approved.
E	Error condition or card declined (see the Error section of the help file for more information).

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

cvvResult
String (read-only)
Default Value: ""

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 indicating such. The following is a list of current result codes:


M	CVV2 match.
N	CVV2 no match.
P	Not processed.
S	Merchant has indicated that CVV2 is not present on card.
U	Issuer not certified and/or has not provided Visa encryption keys.

debitSurcharge
String (read-only)
Default Value: ""

Additional fee charged for debit transactions. This property contains the fee, if any, charged by the host for debit card transactions. The Surcharge Fee field is present only if greater than 0.00. If there was no surcharge for this transaction, the property will remain empty. If present, the Surcharge amount must print on receipt and be labeled as "TERMINAL FEE".

Note: If either the DebitPIN or DebitKSN properties are present, the class will assume this is a debit card transaction. Debit transactions are only supported by the Retail IndustryType, and only for Card Present transactions. For any other type of transaction the class .

class.IndustryType = itRetail class.CardEntryDataSource = edsTrack2 class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.TransactionAmount = "25.00" class.PINCapability = ppVerifiedPIN class.DebitPIN = "623F36B53CC18393" class.DebitKSN = "000000008F000021" class.DebitCashBack = "5.00" class.Sale()

debitTrace
String (read-only)
Default Value: ""

This property is returned in the response to a debit card transaction. The returned value is used for transaction tracking purposes, and must be printed on the customer's receipt.

Note: For normal credit card transactions, this property may contain Interchange compliance data for qualified Visa and MasterCard transactions.

networkId
String (read-only)
Default Value: ""

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


00	Not electronically authorized
31	Chase Paymentech Stored Value
01	VisaNet
65	Comdata/SVS Stored Value
02	MasterCard BankNet
34	Bank of Nova Scotia
03	Maestro Direct
35	Royal Bank of Canada - V
04	Club Card Private Label
36	Royal Bank of Canada - T
05	MAC Direct
37	Royal Bank of Canada - M
06	American Express Direct
38	The Toronto-Dominion Bank - 1
11	WEX (Wright Express)
39	The Toronto-Dominion Bank - 3
12	Novus (Discover)
40	National Bank of Canada
15	Sears Private Label
43	d'economie Desjardins du Quebec
16	Fleet One
44	Credit Union Central of Canada
17	Shell
45	CGI Credit Union Central of Canada - 2
19	TCH
46	CGI
20	Pulse Direct
48	CU Connect
21	Interlink Direct
49	CIBC - 5
22	MotoMart
51	Shazam Direct
23	Private Label - PL1
53	AFFN Direct
25	NYCE Direct
54	CIBC - 6
28	FleetCor / GasCard Authorizer
56	CU Central of British Columbia
29	MPS Gateway - Accell, AFFN, Alaska Option, CU24, CU24M, Explore, Honor, Interlink MPS, Jeannie, MAC-MPS, Maestro, Moneystation, MPS EBT Gateway, NYCE, PULSE, Shazam, Tempo
64	Maestro Canada
30	STAR Direct
69	ACCEL Direct
33	Bank of Montreal
73	ETC Scan Check Authorizer

retrievalNumber
String (read-only)
Default Value: ""

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 will contain the number used to reference the transaction when issuing voids or reversals.

sequenceNumber
String (read-only)
Default Value: ""

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

text
String (read-only)
Default Value: ""

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 property. The property is for informational use only, and should not be used in determining whether a transaction has been approved or not. Instead, use the property to determine this.

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

transactionId
String (read-only)
Default Value: ""

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.

Constructors

public init()

PTechHotelInfo Type

Contains additional information required for the Hotel/Lodging industry.

Remarks

This type is used in both authorizations and detail records when processing transactions in the hotel/lodging industry type. At minimum, you should pass the expected of stay, , expected , and . You may pass the and in the authorization, but those are normally not known until settlement. To process a reservation or any other transaction where the customer and his card are not physically present, set the property to True;. This will indicate to Paymentech that the transaction is a card-not-present authorization ( must be set to False for normal card-present transaction processing).

Fields

arrivalDate
String
Default Value: "010101"

Date the customer checked in, or the expected arrival date when authorizing a reservation. This property must contain an actual valid date.

chargeDescriptor
PTHotelChargeDescs
Default Value: 1

Provides additional information about what this transaction was used for at the hotel. If used to pay for actual hotel accommodations, this should be set to cdLodging. If this transaction was used for any hotel-provided services, it should be set to the corresponding description listed below. Available descriptors include:

cdHealthClub (0)
cdLodging (1)
cdRestaurant (2)
cdGiftShop (3)
cdHairSalon (4)
cdConventionFees (5)
cdTennisClub (6)
cdGolfShop (7)

departureDate
String
Default Value: "010101"

Date the customer checked out, or the expected check-out date when authorizing a reservation. This property must contain an actual valid date.

duration
Int32
Default Value: 1

The number of days the customer stayed in the hotel, or the expected duration of stay when authorizing a reservation. This property must be between 1 and 99 days.

extraChargeAmount
String
Default Value: "0.00"

Total amount of extra charges incurred by the customer. Use the to indicate the types of charges that have been added on to this transaction.

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

extraChargesCode
String
Default Value: "000000"

List of extra charges added to the cost of lodging. You may include a list of extra charges for hotel transactions. Simply add the code below to this property. Multiple codes may be specified by concatenating them together. Only six extra charges may be added. For instance "240000" indicates the customer dined at the hotel restaurant and drank from the mini bar in his room. Available codes include:


0	None. If there are no extra charges, this property should contain six zeros- "000000".
2	Restaurant.
3	Gift shop.
4	Mini bar.
5	Telephone charges.
6	Other charges not listed.
7	Laundry service.

preferredCustomer
Bool
Default Value: False

Set this property to True to process a hotel transaction as card-not-present. This can be used for phoned-in reservations, no-show charges, or any transaction that takes place without the customer's physical card present. This property is only applicable for Visa and MasterCard transactions. Other card types must use the PTechECommerce class for phone or internet reservations.

saleCode
PTHotelSaleCodes
Default Value: 1

Provides additional details about the type of this transaction.

Constructors

public init()

Config Settings (PTechHotel Module)

The class accepts one or more of the following configuration settings. Configuration 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.

PTechHotel Config Settings

AllowPartialAuths: Indicates whether partial authorizations are to be supported.

When this setting is True, if the credit card being authorized does not contain sufficient funds to cover the TransactionAmount, the card will not be declined. Instead, the transaction will be authorized for a lesser amount, which is equal to the balance of the credit card. The customer must then use another form of payment to make up the remainder. The total amount authorized by Paymentech will be returned in the ResponseAuthorizedAmount configuration setting. For instance, if the TransactionAmount is $50, but credit card only has a $42 balance, the card is charged for $42.00, and the ResponseAuthorizedAmount will be "42.00". The merchant may then collect the remaining $8 in cash, check, credit card, or any other acceptable form of payment. This setting is True by default.

CAVV: AuthenticationCAVV data from a ThreeDSecure authentication.

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

class.Config("CAVV=" + ThreeDSecure.AuthenticationCAVV);

CustomerDefinedData: Additional transaction identification data.

This data field will allow merchants to assign a unique value to their transaction that will assist them in reconciling their authorization activity to their settlement activity. This field is supported for all transactions and all IndustryTypes. The data will be stored on the Paymentech system, however only Paymentech acquired merchants will see this value in their back-end reporting (Combined Extract File). Note that the maximum length for the CustomerDefinedData is 30 characters. Strings longer than 30 characters will be truncated by the class.

DeviceID: Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.

The specified value must be 4 characters long. If the DeviceID you wish to use is less than 4 characters, you must zero-fill the value. The first 2 characters are used to specify the Inside Device ID and the last 2 characters are used to specify the Outside Fuel Dispenser ID where the transaction was processed.

Note that this value is required to comply with MasterCard's Authorization Data Accuracy Initiative.

DeviceType: Indicates the Remote Payment Type for MasterCard Contactless Authorizations.

This configuration setting is used to indicate the remote payment type or device type for MasterCard Contactless MSD Authorizations.

Valid values are:


Value	Description
00	Card
01	Mobile Phone or Smartphone with Mobile Network Operator (MNO)
02	Key Fob
03	Watch
04	Mobile Tag
05	Wristband
06	Mobile Phone Case or Sleeve
07	Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO
08	Mobile Phone or Smartphone with Removable secure element not controlled by the MNO
09	Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO
10	Tablet or e-Reader with an MNO controlled removable secure element (SIM or UICC)
11	Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO
12	Removable secure element not controlled by the MNO
13	Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO
14	Mobile Phone or Smartphone with a payment application running in a host processor
15	Tablet or e-Reader with a payment application running in a host processor
16	Mobile Phone or Smartphone with payment application running in the TEE of a host processor
17	Tablet or E-Book with a payment application running in the TEE of a host processor
18	Watch with a payment application running in the TEE of a host processor
19	Watch with a payment application running in a host processor
20	Card
21	Phone
22	Tablet/e-reader
23	Watch/Wristband
24	Sticker
25	PC or laptop
26	Device Peripheral (Mobile phone case or sleeve)
27	Tag (Key fob or mobile tag)
28	Jewelry
29	Fashion Accessory
30	Garment
31	Domestic Appliance
32	Vehicle, including vehicle attached devices
33	Media/Gaming Device or gaming device

DiscoverAuthAmount: Returns the amount authorized for the transaction.

After an operation this setting may be queried to return the amount authorized for that transaction. The decimal point in the returned value is implied. This is a read-only configuration setting valid only for Discover transactions.

DiscoverPINCapabability: Indicates if the POS is capable of supporting a PIN.

After an operation this setting may be queried to return the code which indicates if the POS is capable of supporting a PIN. This value is determined at the host based on transaction and terminal parameter settings. This is a read-only configuration setting valid only for Discover transactions.

DiscoverPOSEntryMode: Returns the method by which the primary account number was entered at the POS.

After an operation this setting may be queried to return the method by which the PAN was entered at the POS. This is a read-only configuration setting valid only for Discover transactions.

DiscoverProcessingCode: Returns the type of Authorization request that was submitted to Discover.

After an operation this setting may be queried to return the type of authorization request that was submitted to Discover. This is a read-only configuration setting valid only for Discover transactions.

DiscoverSystemTraceAuditNumber: Returns the value assigned by the host/merhant to assist in identifying a specific transaction.

After an operation this setting may be queried to return the value assigned by the host/merhant to assist in identifying a specific transaction. This is a read-only configuration setting valid only for Discover transactions.

DiscoverTrackDataCondition: Returns condition of the track data.

After an operation this setting may be queried to return the condition of the track data. This is a read-only configuration setting valid only for Discover transactions.

ECommerceIndicator: Used to specify the indicator describing the type of internet transaction.

This field is used for the Restaurant and Hotel industry types and should be set when a transaction is processed over the internet using either of the listed industry types. This enables the merchant to receive better interchange rates and higher chargeback protection.

Valid values:


Value	Description
05	Successfully authenticated (VbV & MCSC). Must set CAVV field.
06	Authentication attempted (VbV & MCSC). Must set CAVV field.
07	Non-Authenticated security transaction without SET certificate, such as channel-encrypted.
08	Non-secure transactions.
20	Payment Token data present (Amex only).

EMVData: The EMV data returned from a Pin Pad after reading an EMV card.

This configuration setting takes the entire TLV (tag-length-value) EMV data received from a Pin Pad after reading an EMV card.

EMVEntryDataSource: The EMV Data Entry Source (DES).

This configuration setting tells the host what the device capability is and how the account information was physically obtained by the POS.

Valid values are:


Value	Device Capability	Presentation Method	Supported Card Types/Comments
36	Chip and Contactless Capable	Track 2 read from inserted	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
37	Chip and Contactless Capable	Insert attempted, fall back to Track 1 from swiped	Allowed on American Express, ChaseNet, International Maestro, JCB, MasterCard and Visa transactions
38	Chip and Contactless Capable	Insert attempted, fall back to Track 2 from swiped	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
39	Chip and Contactless Capable	Insert attempted, swipe attempted, fall back to keyed/ manually entered	Allowed on American Express, ChaseNet, Discover, International Maestro, JCB, MasterCard and Visa transactions
40	Chip and Contactless Capable	Track 1 read from proximity w/chip	Allowed on American Express, ChaseNet, MasterCard and Visa transactions
41	Chip and Contactless Capable	Track 2 read from proximity w/chip	Allowed on American Express, Canadian Debit, ChaseNet, Discover, MasterCard, *US Debit and Visa transactions
42	Chip and Contactless Capable	Track 1 read from proximity w/mag stripe	Allowed on American Express, ChaseNet, Discover, MasterCard and Visa transactions
43	Chip and Contactless Capable	Track 2 read from proximity w/mag stripe	Allowed on American Express, Canadian Debit, ChaseNet, Discover, MasterCard, *US Debit and Visa transactions
44	Chip and Contactless Capable	Track 1 read from swiped	Allowed on all card types except US Debit, Canadian Debit, EBT, and stored value
45	Chip and Contactless Capable	Track 2 read from swiped	Allowed on all card types
46	Chip and Contactless Capable	Keyed / Manually Entered	Allowed on all card types except US Debit and Canadian Debit (note that this code is permitted on Debit Reversal Advices however)
48	Chip (but not Contactless) Capable	Track 2 read from inserted	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
49	Chip (but not Contactless) Capable	Insert attempted, fall back to Track 1 from Swiped	Allowed on American Express, ChaseNet, International Maestro, JCB, MasterCard and Visa transactions
50	Chip (but not Contactless) Capable	Insert attempted, fall back to Track 2 from Swiped	Allowed on American Express, Canadian Debit, ChaseNet, Discover, International Maestro, JCB, MasterCard, *US Debit and Visa transactions
51	Chip (but not Contactless) Capable	Insert attempted, swipe attempted, fall back to manually entered	Allowed on American Express, ChaseNet, Discover, International Maestro, JCB, MasterCard and Visa transactions
52	Chip (but not Contactless) Capable	Track 1 from swiped	Allowed on all card types except US Debit, Canadian Debit, EBT, and stored value.
53	Chip (but not Contactless) Capable	Track 2 from swiped	Allowed on all card types
54	Chip (but not Contactless) Capable	Keyed / Manually Entered	Allowed on all card types except US Debit and Canadian Debit.
55	Contactless Capable	Barcode read	Allowed on American Express only.
56	Chip and Contactless Capable	Barcode read	Allowed on American Express only.
57	Chip (but not Contactless) Capable	Barcode read	Allowed on American Express only.

EMVOnlineKSN: Clear-text Key Sequence Number for EMV Online PIN transactions.

This field is used along with EMVOnlinePIN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. This value must be 16 characters in length.

EMVOnlinePIN: DUKPT DES encrypted PIN block for EMV Online PIN transactions.

This field is used along with EMVOnlineKSN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. This value must be 16 characters in length.

HardwareSerialNum: Hardware Serial Number.

This field is used for POS/VAR Capabilities Data. It determines the serial number of hardware device.

HostProcessingTypes: Host Processing Platform.

This field is used for POS/VAR Capabilities Data. It can be set to the binary 'OR' of one or more of the following values:

Valid values:


Description	Value
TAS Only Credit	128 (Hex 0x80)
TAS/TCS Credit	64 (Hex 0x40)
TCS Only Credit	32 (Hex 0x20)
HCS Auth Only Credit	16 (Hex 0x10)
HCS Auth/Settle Credit	8 (Hex 0x8)
Host Extended Product Support (Debit, SV, EBT)	4 (Hex 0x4)

For TAS/TCS Credit and Host Extended Product, this configuration setting must be set to 68.

MessageReasonCode: Message Reason Code.

Use this 4-character config to identify the type of Merchant Initiated Transaction for Visa. Valid values are:


Value	Description
3900	Incremental Authorization
3901	Resubmission
3902	Delayed Charges
3903	Reauthorization
3904	No Show

Note: This config is used in Visa card transactions only.

MITTransactionId: Transaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale or AuthOnly transaction.

Use this 15-character config when sending a subsequent Merchant Initiated Sale or AuthOnly transaction. It should be set with the ResponseTransactionId from the original (first) authorization response. Note: This config is used in Visa or Discover card transactions only.

POSEntryModeCOF: POS Entry Mode Credential on File.

This configuration setting is used to indicate that POS Entry Mode Credential is on file. The valid value is:


Value	Description
Y	Credential on file

Note: If no amount is due at the time credentials are stored, you must submit an Account Verification authorization (zero-amount transaction) using the AuthOnly method.

POSEnvironmentCode: POS Environment Code.

Use this 1-character config to indicate that a transaction is a Recurring, Installment, or Unscheduled COF payment, or when placing cardholder Credentials On File for the first time.

Visa card valid values are:


Value	Description
C	Credential on file. Used for Unscheduled COF transactions or when the cardholder's credentials are saved for the first time.
I	Installment. Required for initial and all subsequent Installment payment transactions
R	Recurring. Required for initial and all subsequent Recurring transactions.

Discover card valid values are:


Value	Description
R	Recurring transaction
A	Re-Authorization Full Amount
P	Partial/Split transaction

Note: Discover valid values are for Merchant Initiated Transactions only.

RequestBalanceInfo: Specifies whether to request balance information.

When this setting is 'True', the available card balance amounts will be returned via ResponseBalanceAmount1 and ResponseBalanceAmount2 and the currency codes for each amount will be returned via ResponseBalanceCurrency1 and ResponseBalanceCurrency2. This setting is 'False' by default.

RequestTransactionId: Indicates the Transaction Identifier is requested.

Setting this config to 'True' indicates the Transaction Identifier (TXID) is requested.

The default value is False.

ResponseBalanceAmount1: Credit Prepaid Available Balance #1.

Current available balance in the merchant's currency. Signed numeric amount with an implied decimal point. For instance, a positive $10.00 balance will be represented as "+000000001000". This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseBalanceAmount2: Credit Prepaid Available Balance $2.

Current available balance in the customer's currency. Signed numeric amount with an implied decimal point. For instance, a positive $10.00 balance will be represented as "+000000001000". This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseBalanceCurrency1: Currency code for ResponseBalanceAmount1.

If present, this indicates the currency code for the ResponseBalanceAmount1. This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseBalanceCurrency2: Currency code for ResponseBalanceAmount2.

If present, this indicates the currency code for the ResponseBalanceAmount2. This setting is only valid for Credit Prepaid transactions, and is read-only.

ResponseEMVCardAuthCode: The ChaseNet and Visa card authentication results code.

The ChaseNet and Visa card authentication results code.

ResponseEMVData: The response EMV data.

This configuration setting contains the EMV Data in TLV (tag-length-value) format. This field will only be populated if an EMV transaction was performed and EMV Data was received in the response.

ResponseEMVDownloadIndicator: Whether EMV parameters should be updated.

If true, EMV parameters should be updated. EMVKeyMgr may be used to download current EMV parameters. This is only applicable when SettlementMode is set to 0 (Host Capture).

ResponsePOSRetrievalNumber: POS Retrieval Number sent in the request, echoed back in the response.

If the SettlementMode is set to Host Capture, Paymentech ignores the value of the POSRetrievalNumber property and generates its own ResponseRetrievalNumber to reference the transaction. The ResponsePOSRetrievalNumber configuration setting can be used to return the value you sent in the request, but the ResponseRetrievalNumber will always contain the number used to reference the transaction.

SettlementMode: Indicates whether the class uses Paymentech's Host Capture or Terminal Capture system.

Possible values are:


0	Host Capture (default)
1	Terminal Capture

Note that for PTechReversal, 1 (Terminal Capture) will be the default value. If Host Capture is being used, a value of 0 will need to be set.

Host-Capture means that you authorize your transactions using the AuthOnly or Sale methods, and you process refunds and capture outstanding authorizations with the Credit and Capture methods. Paymentech handles all batch management. All you need to do is use the PTechHostSettle class to release the batch for settlement (you may even set your account up for Host Auto-Close, which will automatically release the batch for settlement at the end of the business day).

Terminal-Capture means that you handle all of the batch management yourself. This is necessary for the Hotel/Lodging and Restaurant IndustryTypes, because the final settlement amount may be more than (or less than) the amount that was originally authorized. For instance, a restaurant authorization may have a GratuityAmount added to the original charge before the transaction is settled. Likewise, a customer may stay longer or shorter than originally planned, or incur additional charges (mini bar, telephone call, room service, etc), and the settlement amount must be adjusted accordingly.

All industry types supported by PTechCharge may be processed in smTerminalCapture mode. However, Restaurant and Hotel transactions MUST be authorized and settled in smTerminalCapture mode. Attempting to authorize a Restaurant or Hotel/Lodging transaction with the SettlementMode; set to 0 (Host Capture) will cause the class .

When processing transactions in smTerminalCapture mode, credits and captures are processed off-line using the PTechDetailRecord and PTechManualSettle classs. Attempting to call the VoidTransaction or Capture methods the class .

SoftwareID: Software Identifier.

This field is used for POS/VAR Capabilities Data. It is assigned by Paymentech at the time of certification.

Default value is "010C".

SystemInformation: System Information field for Batch Inquiry and Release transactions.

System Information that all software packages must supply to the Paymentech host when sending a Batch Inquiry or Release transaction. Unless Paymentech indicates otherwise, the value of this configuration setting should not be changed. If it is changed, it should meet the specifications below.

The class will construct the System Information data based on the following specifications:

Application Name - 7 characters
Release Date - 6 characters (MMDDYY)
EPROM / Version Number - 10 characters

For example: DIRPAYI110613VERSION6.0

VendorID: Hardware/Vendor Identifier.

This field is used for POS/VAR Capabilities Data. It is assigned by Paymentech at the time of certification.

Default value is "0076".

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If , the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If , the connection will be closed immediately after the server response is received.

The default value for KeepAlive is .

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.