PTechHostSettle Module

Properties Methods Events Config Settings Errors

The PTechHostSettle module is used to manually settle an open Batch with the Paymentech NetConnect system on the Tampa platform. This module supports Direct Marketing, e-Commerce, and Retail environments, and 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.Ptechhostsettle

Remarks

Once an authorization request is approved with either the PTechCharge or PTechGiftCard class, one of two things happen. If your Paymentech account is setup with the Host Auto Close feature enabled, you need take no further action. The host will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. In order for the merchant's batch to be included in the Paymentech Host Auto Close process, the merchant parameter file on the host must indicate that the merchant is Auto Close. If this flag is set, the PTechHostSettle class is not necessary.

However, if your account is not setup with Host Auto Close, then after an authorization is approved the transaction is added to the current batch on the Paymentech Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through the Manual Batch Release Settlement process in order for the blocked money to be transferred to the merchant's account. To release a batch for settlement, first set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. Then get the Net Amount of the batch by calling the BatchInquiry method. Compare this amount to the amount in your transaction records. If they match, you may send a BatchRelease to settle the funds.

The status of a batch inquiry or release is returned in the ResponseCode. with a human-readable description contained in ResponseText. Additional Response properties indicate the number of transactions in the batch, the date and time the batch was opened and closed, and Net amount of the batch.

Normally a BatchRelease is done at the end of each business day. Outstanding authorizations (even those in an open batch) will expire after 7 to 10 days depending on the cardholder's bank, so it is wise to release the batch often.

Note that this class only supports the Manual Batch Release (Host Capture) settlement method, and does not support Terminal Capture processing (this class is not required for Host Auto Close).

Property List

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


CardType	Indicates the card type for which the terminal is requesting totals or details on.
ClientNumber	Merchant configuration property, assigned by Paymentech.
InquiryType	The type of batch inquiry to be submitted.
MerchantNumber	A unique number used to identify the merchant, assigned by Paymentech.
MoreData	Indicates whether the Paymentech server has more data to return.
Password	Password for authentication with the NetConnect Server .
PaymentTypes	Collection of payment types in the current batch.
Proxy	This property includes a set of properties related to proxy access.
RequestStatus	Used with enhanced BatchInquiry s to retrieve the next set of transaction data.
Response	Contains the response to the settlement.
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.
TransactionDetails	Details about each transaction in the current open batch.
TransactionTotals	Totals of each card type that has been authorized in the current open batch.
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.


BatchInquiry	Retrieves the current state of the open batch.
BatchRelease	Releases the current batch for settlement.
Config	Sets or retrieves a configuration setting.
Interrupt	Interrupt the current method.
Reset	Clears all properties to their default values.

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.


ErrorCode	Batch Management Error Code.
SystemInformation	System Information field for Batch Inquiry and Release transactions.
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.

CardType Property (PTechHostSettle Module)

Indicates the card type for which the terminal is requesting totals or details on.

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


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

- (NSString*)cardType;
- (void)setCardType :(NSString*)newCardType;

Default Value

"99"

Remarks

This property is used when submitting a BatchInquiry transaction. When all card types are being requested, the value must be "99". This property is only valid for the iBatchTotalsByCardInquiry and iMerchantTotalsByCardInquiry InquiryType.

The following is a list of card mnemonics and their meanings.


VI	Visa
MC	MasterCard
AX	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.

ClientNumber Property (PTechHostSettle 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.

InquiryType Property (PTechHostSettle Module)

The type of batch inquiry to be submitted.

Syntax

Swift
Objective-C

public var inquiryType: PtechhostsettleInquiryTypes {
  get {...}
  set {...}
}

public enum PtechhostsettleInquiryTypes: Int32 {
  case iSimpleInquiry = 0
  case iTransactionDetailInquiry = 1
  case iBatchTotalsByCardInquiry = 2
  case iMerchantTotalsByCardInquiry = 3
}


@property (nonatomic,readwrite,assign,getter=inquiryType,setter=setInquiryType:) int inquiryType;

- (int)inquiryType;
- (void)setInquiryType :(int)newInquiryType;

Default Value

Remarks

This property is used when submitting a BatchInquiry transaction. The following table explains the inquiry types:


iSimpleInquiry	No enhanced reporting is requested. The Paymentech server will return basic information for at most four PaymentTypes.
iTransctionDetailInquiry	The Paymentech server will return each and every transaction currently contained in the open batch. This information will be contained in the TransactionDetails property.
iBatchTotalsByCardInquiry	The Paymentech server will return the totals of all transactions for each card type in the current open batch. This information will be contained in the TransactionTotals property.
iMerchantTotalsByCardInquiry	The Paymentech server will return the totals of all transactions for each card type in all of the currently open batches for the merchant indicated by the MerchantNumber.

If the Paymentech server cannot return all of the data requested in a single response, the MoreData property will be true. You should then set the RequestStatus property to rsSubsequentRequest and resubmit the BatchInquiry. Continue this until MoreData is False. If at any time you wish to start over at the beginning, set RequestStatus to rsInitialRequest and call BatchInquiry again.

MerchantNumber Property (PTechHostSettle 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.

MoreData Property (PTechHostSettle Module)

Indicates whether the Paymentech server has more data to return.

Syntax

Swift
Objective-C

public var moreData: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=moreData) BOOL moreData;

- (BOOL)moreData;

Default Value

False

Remarks

This property is used when submitting a BatchInquiry transaction with enhanced reporting. Additional transaction data will be returned for any BatchInquiry submitted with an InquiryType other than iSimpleInquiry.

If the Paymentech server cannot return all of the data requested in a single response, the MoreData property will be true. You should then set the RequestStatus to rsSubsequentRequest and re-submit the BatchInquiry. Continue this until MoreData is False. If at any time you wish to start over at the beginning, set RequestStatus to rsInitialRequest and call BatchInquiry again.

This property is read-only.

Password Property (PTechHostSettle 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.

PaymentTypes Property (PTechHostSettle Module)

Collection of payment types in the current batch.

Syntax

Swift
Objective-C

public var paymentTypes: Array<PTechPaymentType> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=paymentTypeCount) int paymentTypeCount;

- (int)paymentTypeCount;

- (NSString*)paymentTypeName:(int)paymentTypeIndex;

- (NSString*)paymentTypeNetAmount:(int)paymentTypeIndex;

- (NSString*)paymentTypeTransCount:(int)paymentTypeIndex;

Default Value

Remarks

This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class. This property will contain the number of payment types in the current batch. Each payment type has a , , and tied to it.

For instance, if the current batch contains only one American Express transaction for $10, after a Batch Inquiry: PaymentTypeCount = 1, (0) = "AE", (0) = "000001", and (0) = "10.00".

Proxy Property (PTechHostSettle 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.

RequestStatus Property (PTechHostSettle Module)

Used with enhanced BatchInquiry s to retrieve the next set of transaction data.

Syntax

Swift
Objective-C

public var requestStatus: PtechhostsettleRequestStatus {
  get {...}
  set {...}
}

public enum PtechhostsettleRequestStatus: Int32 {
  case rsInitialRequest = 0
  case rsSubsequentRequest = 1
}


@property (nonatomic,readwrite,assign,getter=requestStatus,setter=setRequestStatus:) int requestStatus;

- (int)requestStatus;
- (void)setRequestStatus :(int)newRequestStatus;

Default Value

Remarks

Response Property (PTechHostSettle Module)

Contains the response to the settlement.

Syntax

Swift
Objective-C

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


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

- (NSString*)responseBatchClose;

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

- (NSString*)responseBatchNetAmount;

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

- (NSString*)responseBatchNumber;

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

- (NSString*)responseBatchOpen;

@property (nonatomic,readonly,assign,getter=responseBatchTransCount) int responseBatchTransCount;

- (int)responseBatchTransCount;

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

- (NSString*)responseCode;

@property (nonatomic,readonly,assign,getter=responseInquiryCount) int responseInquiryCount;

- (int)responseInquiryCount;

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

- (NSString*)responseSequenceNumber;

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

- (NSString*)responseText;

Default Value

Remarks

This property will contain the response returned from the Paymentech server. It should be inspected (and logged) after a call to BatchInquiry or BatchRelease. The PTechSettleResponse type contains the following fields:


	Date and time the current batch was opened.
	Date and time this batch was closed.
	Net amount of the current batch.
	Number that identifies the batch that this transaction will be settled in.
	Total number of transactions in the batch.
	Indicates the success or failure of the transaction.
	Number of BatchInquirys performed on the current open batch.
	SequenceNumber echoed from the authorization.
	Contains a human-readable message explaining the code.

SequenceNumber Property (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle Module)

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

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

public enum PtechhostsettleSSLCertStoreTypes: 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 (PTechHostSettle 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 (PTechHostSettle Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

public enum PtechhostsettleSSLProviders: 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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.

TransactionDetails Property (PTechHostSettle Module)

Details about each transaction in the current open batch.

Syntax

Swift
Objective-C

public var transactionDetails: Array<PTechBatchDetails> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=detailsCount) int detailsCount;

- (int)detailsCount;

- (NSString*)detailsApprovalCode:(int)detailsIndex;

- (NSString*)detailsCardType:(int)detailsIndex;

- (int)detailsSequenceNumber:(int)detailsIndex;

- (NSString*)detailsTransAmount:(int)detailsIndex;

- (NSString*)detailsTransType:(int)detailsIndex;

Default Value

Remarks

When sending a BatchInquiry with the InquiryType set to iTransactionDetailInquiry, the Paymentech server will return each and every transaction currently contained in the open batch in a collection of PTechBatchDetails objects.

TransactionTotals Property (PTechHostSettle Module)

Totals of each card type that has been authorized in the current open batch.

Syntax

Swift
Objective-C

public var transactionTotals: Array<PTechBatchTotals> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=totalsCount) int totalsCount;

- (int)totalsCount;

- (NSString*)totalsCardType:(int)totalsIndex;

- (NSString*)totalsNetAmount:(int)totalsIndex;

- (int)totalsTransCount:(int)totalsIndex;

Default Value

Remarks

When sending a BatchInquiry with the InquiryType set to iBatchTotalsByCardInquiry or iMerchantTotalsByCardInquiry, the Paymentech server will return the totals of all transactions for each card type in the current open batch in a collection of PTechBatchTotals objects.

UserId Property (PTechHostSettle 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.

BatchInquiry Method (PTechHostSettle Module)

Retrieves the current state of the open batch.

Syntax

Swift
Objective-C

public func batchInquiry() throws -> Void

- (void)batchInquiry;

Remarks

A batch inquiry will provide the host batch totals to the Point Of Sale (POS). If the POS and the Host are out of balance, discrepancies can be corrected prior to the batch being released. A batch inquiry will not release the batch for settlement. Use the BatchRelease method or Paymentech's online merchant interface to settle the batch.

Batch Inquiry and Release response data will be returned in the ResponseBatchNumber, ResponseBatchNetAmount, ResponseBatchTransCount, ResponseBatchOpen, and ResponseBatchClose properties. Additional information concerning the type of transactions in the settlement will be broken down into the PaymentTypesName, PaymentTypesNetAmount and PaymentTypesTransCount properties.

class.BatchInquiry() class.BatchRelease(class.ResponseBatchNetAmount)

BatchRelease Method (PTechHostSettle Module)

Releases the current batch for settlement.

Syntax

Swift
Objective-C

public func batchRelease(netDeposit: String) throws -> Void

- (void)batchRelease:(NSString*)netDeposit;

Remarks

A batch release will provide the host batch totals to the POS and will release the batch for settlement. If there is a discrepancy between what the POS and the host have for totals, those discrepancies will need to be corrected by the merchant in a subsequent batch. To obtain the NetDeposit required for this method, first call BatchInquiry and compare the ResponseBatchNetAmount to your stored value to make sure there are no discrepancies before releasing the batch.

class.BatchInquiry() class.BatchRelease(class.ResponseBatchNetAmount)

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

Interrupt Method (PTechHostSettle 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 (PTechHostSettle 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.

DataPacketIn Event (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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 (PTechHostSettle 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.

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

PTechBatchDetails Type

Details of a transaction in the open batch.

Remarks

Each PTechBatchDetails in the collection will contain detailed information about a single transaction in the open batch. This includes the returned in the authorization response, the that was authorized, the sent in the original authorization, the transaction amount () that was authorized, and the type of the transaction ( - Sale, Return, etc).

Fields

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

Approval code of transaction pending settlement.

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

Credit card used in transaction pending settlement.

sequenceNumber
Int32 (read-only)
Default Value: 0

Sequence number of transaction pending settlement.

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

Authorized amount of transaction pending settlement.

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

Transaction type of transaction pending settlement.

One of the following 1-character transaction types may be returned:


S	Sale
R	Return
P	Prior Auth Sale
C	Cash Advance Sale

Constructors

public init()

PTechBatchTotals Type

Transaction totals by card type.

Remarks

Each PTechBatchTotals in the collection will contain the number of transactions and the net dollar amount of all transactions in the open batch that match the indicated .

Fields

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

Credit card used in transaction pending settlement.

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

Total dollar amount of all transactions in the open batch that match the indicated .

transCount
Int32 (read-only)
Default Value: 0

Total number of transactions in the open batch that match the indicated .

Constructors

public init()

PTechPaymentType Type

Indicates the number of transactions and the total dollar amount for a specific payment type.

Remarks

For example, 12 American Express transactions totaling $536 is indicated like this: = "AE", = "000012", and = "536.00".

Fields

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

Name of the payment type at the current index. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class. This property will contain the name for each payment type returned. Valid payment types include:


CR	Credit Card and Stored Value
DB	Debit Card Only
AE	American Express Only
EB	Electronic Benefits Transfer Only

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

Net transaction amount for the payment type. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class. This property will contain the net transaction amount for the payment type indicated by . This property will be in the range of "-999999.99" to "9999999.99" for each payment type.

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

Total number of transactions for the payment type. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class. This property will contain the total number of transactions for the payment type indicated by .

Constructors

public init()

PTechSettleResponse Type

Contains the response to the batch settlement..

Remarks

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

Fields

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

Date at which the current batch was closed. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

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

Net amount of the current batch. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class. This property will contain the net transaction totals of the currently open (or just released) batch. This value may be between the range "-9999999.99" to "9999999.99".

Note, when using the PTechManualSettle class to send manual batch settlements, this property will always be "00.00", because the Paymentech host is not maintaining the state of the batch.

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.

Note that when using the PTechManualSettle class to manually settle transactions via Paymentech's Terminal Capture System (TCS), this property will contain the original batch number incremented by one.

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

Date at which the current batch was opened. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

batchTransCount
Int32 (read-only)
Default Value: 0

Total number of transactions in the batch. This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTechHostSettle class, or after a SendSettlement sent using the PTechManualSettle class.

Note, when using the PTechManualSettle class to send manual batch settlements, this property will always be "0", because the Paymentech host is not maintaining the state of the batch.

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.

inquiryCount
Int32 (read-only)
Default Value: 0

Number of BatchInquirys performed on the current open batch. The number returned in this field indicates how many times a batch inquiry has been requested from the host.

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 property contains a response message returned from the Paymentech host, and is used by the terminal to display the Batch Inquiry or Release result. This property will contain human-readable text indicating whether the Inquiry or Release was successful, or it will contain a description of any error encountered.

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

Constructors

public init()

Config Settings (PTechHostSettle 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.

PTechHostSettle Config Settings

ErrorCode: Batch Management Error Code.

If the batch was rejected with an error (ResponseCode = "E"), this configuration setting may return an additional error code that describes the problem. This configuration setting is read-only.

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

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.