TSYSHCAdjustment Class

Properties Methods Events Config Settings Errors

The TSYSHCAdjustment class is used to adjust a previously authorized transaction. This class makes adjusting transactions very easy.

Syntax

TSYSHCAdjustment

Remarks

This class allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHCAdjustment class makes adjusting transactions very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the class and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:

TSYSHCAdjustment1.GenKey = "gen_key_value" TSYSHCAdjustment1.MerchantId = "merchant_id" TSYSHCAdjustment1.RoutingId = "routing_id"

Next, set properties that contain details about the transaction. At a minimum, you must set a RetrievalNumber and OriginalAmount.

TSYSHCAdjustment1.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber TSYSHCAdjustment1.OriginalAmount = "1250"

When processing a Level 2 Corporate Purchasing card transaction you need to set the Card properties which will enable the component to send the proper card-specific Level2 fields. For instance:

TSYSHCAdjustment1.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?" TSYSHCAdjustment1.Card.EntryDataSource = edsTrack1

If you wish to settle an amount that is different than the original authorized amount, you can set SettleAmount to the value you wish to settle. Note that this value can only be less than or equal to the OriginalAmount.

TSYSHCAdjustment1.SettleAmount = "1000"

Finally, submit the adjustment by calling AdjustTransaction. TSYSHCAdjustment1.AdjustTransaction()

When the class receives a response from the Vital/TSYS servers, the result of the adjustment will be displayed in several Response properties. The Code indicates whether the transaction adjustment was successful. The remaining properties provide additional information about the transaction.

Once the adjustment details are successfully added, the transaction will be added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr class.

Property List

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


CaptureMode	The capture mode to be used when performing an authorization or adjustment.
Card	Contains the customer's credit card information.
ClearingSequenceCount	The total number of installment payments.
ClearingSequenceNumber	The payment number of the total number of installment payments.
GenKey	The unique GenKey value used to identify a POS device.
GoodsIndicator	Used to identify the type of goods purchased over the Internet.
InvoiceNumber	Invoice number for the purchase.
Level2	Level2 Corporate Purchasing Card data.
MerchantId	The unique ID that associates the POS device with the merchant account.
OriginalAmount	The original authorized amount for the transaction to be adjusted.
Response	Contains the response to an adjustment request.
RetrievalNumber	The retrieval reference number (RRN) used to identify a transaction.
RoutingId	The Routing ID assigned to the merchant by TSYS.
SettleAmount	The final settlement amount.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the class.
TransactionDesc	Soft (Dynamic) Descriptor.
TransactionNumber	Sequence number of this transaction.

Method List

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


AdjustTransaction	Sends an adjustment request.
Config	Sets or retrieves a configuration setting.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.

Event List

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


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

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


Language	Indicates the language to be used in formatting the authorization response text message.
RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
ServerURL	The server to which transactions are posted.
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 class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class 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 class.
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 class.
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.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
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 class 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.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
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 class 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.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
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 certificates 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.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

CaptureMode Property (TSYSHCAdjustment Class)

The capture mode to be used when performing an authorization or adjustment.

Syntax

ANSI (Cross Platform)
int GetCaptureMode();
int SetCaptureMode(int iCaptureMode);

Unicode (Windows)
INT GetCaptureMode();
INT SetCaptureMode(INT iCaptureMode);

Possible Values

CM_NORMAL(0), 
CM_DELAY(1), 
CM_HOLD(2), 
CM_CAPTURE(3)

int dpaymentssdk_tsyshcadjustment_getcapturemode(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcapturemode(void* lpObj, int iCaptureMode);

int GetCaptureMode();
int SetCaptureMode(int iCaptureMode);

Default Value

Remarks

This property is used to specify the capture mode to be used when performing an authorization or an adjustment transaction.

Possible values are:


Normal (0)	The transaction will be added to the current batch, as specified by BatchNumber, if successfully authorized.
Delay (1)	Indicates that the transaction should not be captured in the current batch without adjustment. If the transaction is adjusted before the current batch closes, then the transaction will be captured in the current batch. If the transaction is not adjusted before the current batch closes, the transaction will be captured in the next batch with or without adjustment.
Hold (2)	When Hold is specified in an original authorization transaction, it will be excluded from batch closing processing.
Capture (3)	When Capture is specified in an adjustment transaction, the batch processing exclusion will be removed in which the transaction will be captured in the current batch.

If you wish to add Level 3 data, you will want to set CaptureMode to Delay (1) when issuing the initial authorization. Then once the Level 3 request is successfully issued, the transaction will be captured in the next batch close event.

Note: To use the Hold and Capture modes, the merchant must be established as a Hold Capture participant.

Note: To use the Delay mode, the merchant must be established as a Delay Capture participant.

Data Type

Integer

Card Property (TSYSHCAdjustment Class)

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard* GetCard();
int SetCard(DPaymentsSDKCCCard* val);

int dpaymentssdk_tsyshcadjustment_getcardtype(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardtype(void* lpObj, int iCardType);

char* dpaymentssdk_tsyshcadjustment_getcardcvvdata(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

int dpaymentssdk_tsyshcadjustment_getcardcvvpresence(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int dpaymentssdk_tsyshcadjustment_getcardentrydatasource(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int dpaymentssdk_tsyshcadjustment_getcardexpmonth(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardexpmonth(void* lpObj, int iCardExpMonth);

int dpaymentssdk_tsyshcadjustment_getcardexpyear(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardexpyear(void* lpObj, int iCardExpYear);

int dpaymentssdk_tsyshcadjustment_getcardisencrypted(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

char* dpaymentssdk_tsyshcadjustment_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

char* dpaymentssdk_tsyshcadjustment_getcardnumber(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setcardnumber(void* lpObj, const char* lpszCardNumber);

int GetCardType();
int SetCardType(int iCardType);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

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 MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

Data Type

DPaymentsSDKCCCard

ClearingSequenceCount Property (TSYSHCAdjustment Class)

The total number of installment payments.

Syntax

ANSI (Cross Platform)
int GetClearingSequenceCount();
int SetClearingSequenceCount(int iClearingSequenceCount);

Unicode (Windows)
INT GetClearingSequenceCount();
INT SetClearingSequenceCount(INT iClearingSequenceCount);

int dpaymentssdk_tsyshcadjustment_getclearingsequencecount(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setclearingsequencecount(void* lpObj, int iClearingSequenceCount);

int GetClearingSequenceCount();
int SetClearingSequenceCount(int iClearingSequenceCount);

Default Value

Remarks

This property is used when processing installment payments to specify the total number of transactions in the sequence.

Below is an example of using installment payments (for a total of 3 payments) and what ClearingSequenceNumber and ClearingSequenceCount should be set to for each payment.


Record	ClearingSequenceNumber	ClearingSequenceCount
First Payment of 3	1	3
Second Payment of 3	2	3
Third Payment of 3	3	3

Data Type

Integer

ClearingSequenceNumber Property (TSYSHCAdjustment Class)

The payment number of the total number of installment payments.

Syntax

ANSI (Cross Platform)
int GetClearingSequenceNumber();
int SetClearingSequenceNumber(int iClearingSequenceNumber);

Unicode (Windows)
INT GetClearingSequenceNumber();
INT SetClearingSequenceNumber(INT iClearingSequenceNumber);

int dpaymentssdk_tsyshcadjustment_getclearingsequencenumber(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setclearingsequencenumber(void* lpObj, int iClearingSequenceNumber);

int GetClearingSequenceNumber();
int SetClearingSequenceNumber(int iClearingSequenceNumber);

Default Value

Remarks

This property is used to specify the payment number that the current payment represents in the total count of installment payments to be made (represented by ClearingSequenceCount).

Below is an example of using installment payments (for a total of 3 payments) and what ClearingSequenceNumber and ClearingSequenceCount should be set to for each payment.


Record	ClearingSequenceNumber	ClearingSequenceCount
First Payment of 3	1	3
Second Payment of 3	2	3
Third Payment of 3	3	3

Data Type

Integer

GenKey Property (TSYSHCAdjustment Class)

The unique GenKey value used to identify a POS device.

Syntax

ANSI (Cross Platform)
char* GetGenKey();
int SetGenKey(const char* lpszGenKey);

Unicode (Windows)
LPWSTR GetGenKey();
INT SetGenKey(LPCWSTR lpszGenKey);

char* dpaymentssdk_tsyshcadjustment_getgenkey(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setgenkey(void* lpObj, const char* lpszGenKey);

QString GetGenKey();
int SetGenKey(QString qsGenKey);

Default Value

Remarks

This property is used to specify the unique GenKey value used to identify the POS device to the host capture system. This property is required to be specified in every transaction performed.

Your GenKey value is obtained from the host capture system when you successfully authenticate your POS device, which can be accomplished by calling AuthenticateDevice. Once retrieved, your GenKey value must be stored in the POS device.

Data Type

String

GoodsIndicator Property (TSYSHCAdjustment Class)

Used to identify the type of goods purchased over the Internet.

Syntax

ANSI (Cross Platform)
int GetGoodsIndicator();
int SetGoodsIndicator(int iGoodsIndicator);

Unicode (Windows)
INT GetGoodsIndicator();
INT SetGoodsIndicator(INT iGoodsIndicator);

Possible Values

TGI_NOT_USED(0), 
TGI_DIGITAL_GOODS(1), 
TGI_PHYSICAL_GOODS(2)

int dpaymentssdk_tsyshcadjustment_getgoodsindicator(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setgoodsindicator(void* lpObj, int iGoodsIndicator);

int GetGoodsIndicator();
int SetGoodsIndicator(int iGoodsIndicator);

Default Value

Remarks

This property is used to identify the type of goods purchased over the Internet. Supported types are shown below.


tgiNotUsed (0)	GoodsIndicator is not used.
tgiDigitalGoods (1)	Customer purchased digital goods (for instance, an application that was electronically delivered).
tgiPhysicalGoods (2)	Customer purchased actual physical goods, which were then shipped to the customer.

Data Type

Integer

InvoiceNumber Property (TSYSHCAdjustment Class)

Invoice number for the purchase.

Syntax

ANSI (Cross Platform)
char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber);

Unicode (Windows)
LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);

char* dpaymentssdk_tsyshcadjustment_getinvoicenumber(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);

Default Value

Remarks

This property is used to specify the merchant assigned invoice number for the e-Commerce (card not present) purchase.

Data Type

String

Level2 Property (TSYSHCAdjustment Class)

Level2 Corporate Purchasing Card data.

Syntax

DPaymentsSDKTSYSHCLevel2* GetLevel2();
int SetLevel2(DPaymentsSDKTSYSHCLevel2* val);

char* dpaymentssdk_tsyshcadjustment_getlevel2amexchargedescriptor(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2amexchargedescriptor(void* lpObj, const char* lpszLevel2AmexChargeDescriptor);

char* dpaymentssdk_tsyshcadjustment_getlevel2amexchargedescriptor2(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2amexchargedescriptor2(void* lpObj, const char* lpszLevel2AmexChargeDescriptor2);

char* dpaymentssdk_tsyshcadjustment_getlevel2amexchargedescriptor3(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2amexchargedescriptor3(void* lpObj, const char* lpszLevel2AmexChargeDescriptor3);

char* dpaymentssdk_tsyshcadjustment_getlevel2amexchargedescriptor4(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2amexchargedescriptor4(void* lpObj, const char* lpszLevel2AmexChargeDescriptor4);

char* dpaymentssdk_tsyshcadjustment_getlevel2amexrequestername(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2amexrequestername(void* lpObj, const char* lpszLevel2AmexRequesterName);

char* dpaymentssdk_tsyshcadjustment_getlevel2amexshippedtozip(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2amexshippedtozip(void* lpObj, const char* lpszLevel2AmexShippedToZip);

int dpaymentssdk_tsyshcadjustment_getlevel2istaxexempt(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2istaxexempt(void* lpObj, int bLevel2IsTaxExempt);

char* dpaymentssdk_tsyshcadjustment_getlevel2purchaseordernumber(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2purchaseordernumber(void* lpObj, const char* lpszLevel2PurchaseOrderNumber);

char* dpaymentssdk_tsyshcadjustment_getlevel2taxamount(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setlevel2taxamount(void* lpObj, const char* lpszLevel2TaxAmount);

QString GetLevel2AmexChargeDescriptor();
int SetLevel2AmexChargeDescriptor(QString qsLevel2AmexChargeDescriptor);

QString GetLevel2AmexChargeDescriptor2();
int SetLevel2AmexChargeDescriptor2(QString qsLevel2AmexChargeDescriptor2);

QString GetLevel2AmexChargeDescriptor3();
int SetLevel2AmexChargeDescriptor3(QString qsLevel2AmexChargeDescriptor3);

QString GetLevel2AmexChargeDescriptor4();
int SetLevel2AmexChargeDescriptor4(QString qsLevel2AmexChargeDescriptor4);

QString GetLevel2AmexRequesterName();
int SetLevel2AmexRequesterName(QString qsLevel2AmexRequesterName);

QString GetLevel2AmexShippedToZip();
int SetLevel2AmexShippedToZip(QString qsLevel2AmexShippedToZip);

bool GetLevel2IsTaxExempt();
int SetLevel2IsTaxExempt(bool bLevel2IsTaxExempt);

QString GetLevel2PurchaseOrderNumber();
int SetLevel2PurchaseOrderNumber(QString qsLevel2PurchaseOrderNumber);

QString GetLevel2TaxAmount();
int SetLevel2TaxAmount(QString qsLevel2TaxAmount);

Remarks

This property allows you to specify Corporate Purchasing Card data to create Level2 transactions. The TSYSHCLevel2 type contains the following fields:


AmexRequesterName	The name of the requestor, if different than the cardholder. (AMEX Level2 only)
AmexShippedToZip	The zip code to which the commodity was shipped. (AMEX Level2 only)
AmexChargeDescriptor	Description of this transaction. (AMEX Level2 only)
AmexChargeDescriptor2	Description of this transaction. (AMEX Level2 only)
AmexChargeDescriptor3	Description of this transaction. (AMEX Level2 only)
AmexChargeDescriptor4	Description of this transaction. (AMEX Level2 only)
IsTaxExempt	Identifies the tax exempt status of the purchasing card. (VISA and MasterCard)
PurchaseOrderNumber	Optional customer-specified purchase order number. (VISA and MasterCard)
TaxAmount	Sales tax charged in addition to the original TransactionAmount. (VISA and MasterCard)

Data Type

DPaymentsSDKTSYSHCLevel2

MerchantId Property (TSYSHCAdjustment Class)

The unique ID that associates the POS device with the merchant account.

Syntax

ANSI (Cross Platform)
char* GetMerchantId();
int SetMerchantId(const char* lpszMerchantId);

Unicode (Windows)
LPWSTR GetMerchantId();
INT SetMerchantId(LPCWSTR lpszMerchantId);

char* dpaymentssdk_tsyshcadjustment_getmerchantid(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setmerchantid(void* lpObj, const char* lpszMerchantId);

QString GetMerchantId();
int SetMerchantId(QString qsMerchantId);

Default Value

Remarks

The unique ID, also known as the POS ID, that associates the POS device with the merchant account.

This property is required to be specified in every transaction performed.

Data Type

String

OriginalAmount Property (TSYSHCAdjustment Class)

The original authorized amount for the transaction to be adjusted.

Syntax

ANSI (Cross Platform)
char* GetOriginalAmount();
int SetOriginalAmount(const char* lpszOriginalAmount);

Unicode (Windows)
LPWSTR GetOriginalAmount();
INT SetOriginalAmount(LPCWSTR lpszOriginalAmount);

char* dpaymentssdk_tsyshcadjustment_getoriginalamount(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setoriginalamount(void* lpObj, const char* lpszOriginalAmount);

QString GetOriginalAmount();
int SetOriginalAmount(QString qsOriginalAmount);

Default Value

Remarks

This property is used to specify the original transaction amount. This property is required, along with either RetrievalNumber or TransactionNumber, when calling AdjustTransaction so that the Host Capture system can identify the transaction.

The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10.

The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode. In the United States, the number of allowable significant digits is seven. Thus the maximum t transaction amount; is "9999999", yielding a US dollar amount of $99,999.99.

Note: This field may not contain a negative number.

Data Type

String

Response Property (TSYSHCAdjustment Class)

Contains the response to an adjustment request.

Syntax

DPaymentsSDKTSYSHCAdjustmentResponse* GetResponse();

int dpaymentssdk_tsyshcadjustment_getresponsebatchnumber(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getresponsecode(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getresponseretrievalnumber(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getresponsetext(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getresponsetransactiondate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getresponsetransactionnumber(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getresponsetransactiontime(void* lpObj);

int GetResponseBatchNumber();

QString GetResponseCode();

QString GetResponseRetrievalNumber();

QString GetResponseText();

QString GetResponseTransactionDate();

QString GetResponseTransactionNumber();

QString GetResponseTransactionTime();

Remarks

This property will contain the response returned from the TSYS server. It should be inspected (and logged) after an adjustment to determine if the transaction was approved. The TSYSHCAdjustmentResponse type contains the following fields:


BatchNumber	Contains the incrementing ID assigned by TSYS to identify a merchant batch.
RetrievalNumber	This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.
TransactionDate	Local transaction date returned from the server in MMDDYY format.
TransactionTime	Local transaction time returned from the server in HHMMSS format.
TransactionNumber	Check this field against the original Transaction Number.
Code	Indicates the status of the authorization request.
Text	Text information that describes each response code.

This property is read-only.

Data Type

DPaymentsSDKTSYSHCAdjustmentResponse

RetrievalNumber Property (TSYSHCAdjustment Class)

The retrieval reference number (RRN) used to identify a transaction.

Syntax

ANSI (Cross Platform)
char* GetRetrievalNumber();
int SetRetrievalNumber(const char* lpszRetrievalNumber);

Unicode (Windows)
LPWSTR GetRetrievalNumber();
INT SetRetrievalNumber(LPCWSTR lpszRetrievalNumber);

char* dpaymentssdk_tsyshcadjustment_getretrievalnumber(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setretrievalnumber(void* lpObj, const char* lpszRetrievalNumber);

QString GetRetrievalNumber();
int SetRetrievalNumber(QString qsRetrievalNumber);

Default Value

Remarks

This property is used to specify the retrieval reference number (RRN) for the transaction that you wish to retrieve or adjust. This value is used by the Host Capture system to identify the transaction.

Note either RetrievalNumber or TransactionNumber may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the RetrievalNumber will be used and the TransactionNumber ignored.

In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.

Data Type

String

RoutingId Property (TSYSHCAdjustment Class)

The Routing ID assigned to the merchant by TSYS.

Syntax

ANSI (Cross Platform)
char* GetRoutingId();
int SetRoutingId(const char* lpszRoutingId);

Unicode (Windows)
LPWSTR GetRoutingId();
INT SetRoutingId(LPCWSTR lpszRoutingId);

char* dpaymentssdk_tsyshcadjustment_getroutingid(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setroutingid(void* lpObj, const char* lpszRoutingId);

QString GetRoutingId();
int SetRoutingId(QString qsRoutingId);

Default Value

Remarks

This property is used to specify the six alphanumeric character routing ID assigned to you via TSYS.

This property is required to be set for every transaction request.

Data Type

String

SettleAmount Property (TSYSHCAdjustment Class)

The final settlement amount.

Syntax

ANSI (Cross Platform)
char* GetSettleAmount();
int SetSettleAmount(const char* lpszSettleAmount);

Unicode (Windows)
LPWSTR GetSettleAmount();
INT SetSettleAmount(LPCWSTR lpszSettleAmount);

char* dpaymentssdk_tsyshcadjustment_getsettleamount(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsettleamount(void* lpObj, const char* lpszSettleAmount);

QString GetSettleAmount();
int SetSettleAmount(QString qsSettleAmount);

Default Value

Remarks

This property is used to specify the final settlement (transaction) amount.

Note: The final settlement amount can only be decreased. Thus SettlementAmount must be less than OriginalAmount. If you do not wish to adjust the settlement amount, you can should not set SettlementAmount.

Data Type

String

SSLAcceptServerCert Property (TSYSHCAdjustment Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

DPaymentsSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertissuer(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertprivatekey(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertpublickey(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslacceptservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dpaymentssdk_tsyshcadjustment_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertstorepassword(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dpaymentssdk_tsyshcadjustment_getsslacceptservercertstoretype(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertusage(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslacceptservercertusageflags(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertversion(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslacceptservercertsubject(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dpaymentssdk_tsyshcadjustment_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_tsyshcadjustment_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DPaymentsSDKCertificate

SSLCert Property (TSYSHCAdjustment Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

DPaymentsSDKCertificate* GetSSLCert();
int SetSSLCert(DPaymentsSDKCertificate* val);

char* dpaymentssdk_tsyshcadjustment_getsslcerteffectivedate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertexpirationdate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertfingerprint(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertissuer(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertprivatekey(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslcertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertpublickey(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslcertpublickeylength(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertserialnumber(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_tsyshcadjustment_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dpaymentssdk_tsyshcadjustment_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dpaymentssdk_tsyshcadjustment_getsslcertstoretype(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dpaymentssdk_tsyshcadjustment_getsslcertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertusage(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslcertusageflags(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertversion(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslcertsubject(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dpaymentssdk_tsyshcadjustment_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_tsyshcadjustment_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DPaymentsSDKCertificate

SSLProvider Property (TSYSHCAdjustment Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_tsyshcadjustment_getsslprovider(void* lpObj);
int dpaymentssdk_tsyshcadjustment_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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 as follows:


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

Data Type

Integer

SSLServerCert Property (TSYSHCAdjustment Class)

The server certificate for the last established connection.

Syntax

DPaymentsSDKCertificate* GetSSLServerCert();

char* dpaymentssdk_tsyshcadjustment_getsslservercerteffectivedate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertexpirationdate(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertextendedkeyusage(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertfingerprint(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertfingerprintsha1(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertfingerprintsha256(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertissuer(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertprivatekey(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslservercertprivatekeyavailable(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertprivatekeycontainer(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertpublickey(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertpublickeyalgorithm(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslservercertpublickeylength(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertserialnumber(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertsignaturealgorithm(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dpaymentssdk_tsyshcadjustment_getsslservercertstorepassword(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslservercertstoretype(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertsubjectaltnames(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertthumbprintmd5(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertthumbprintsha1(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertthumbprintsha256(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertusage(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslservercertusageflags(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertversion(void* lpObj);

char* dpaymentssdk_tsyshcadjustment_getsslservercertsubject(void* lpObj);

int dpaymentssdk_tsyshcadjustment_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DPaymentsSDKCertificate

Timeout Property (TSYSHCAdjustment Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_tsyshcadjustment_gettimeout(void* lpObj);
int dpaymentssdk_tsyshcadjustment_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionDesc Property (TSYSHCAdjustment Class)

Soft (Dynamic) Descriptor.

Syntax

ANSI (Cross Platform)
char* GetTransactionDesc();
int SetTransactionDesc(const char* lpszTransactionDesc);

Unicode (Windows)
LPWSTR GetTransactionDesc();
INT SetTransactionDesc(LPCWSTR lpszTransactionDesc);

char* dpaymentssdk_tsyshcadjustment_gettransactiondesc(void* lpObj);
int dpaymentssdk_tsyshcadjustment_settransactiondesc(void* lpObj, const char* lpszTransactionDesc);

QString GetTransactionDesc();
int SetTransactionDesc(QString qsTransactionDesc);

Default Value

Remarks

This property allows a merchant to specify a description about the transaction.

The maximum length of this property is 25 characters (alphanumeric and special characters).

Data Type

String

TransactionNumber Property (TSYSHCAdjustment Class)

Sequence number of this transaction.

Syntax

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Unicode (Windows)
INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);

int dpaymentssdk_tsyshcadjustment_gettransactionnumber(void* lpObj);
int dpaymentssdk_tsyshcadjustment_settransactionnumber(void* lpObj, int iTransactionNumber);

int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

Remarks

This number must be unique, it's used to identify the transaction in order to operate on it in the future.

This field contains a terminal-generated transaction sequence number to be submitted in all authorization request messages. This number is echoed back to the terminal in the TransactionNumber for the purpose of assisting in the matching of authorization request and response messages.

The maximum length of this property is 8 characters.

TSYS suggests the following application rules for the format of TransactionNumber:

Format the TransactionNumber as "DDSSS", where DD is the current day of the month and SSS is a sequence of numbers from 001-999.
Configure the sequence number for 2-5 positions so the sequence number can increment through a single day without rolling over.
Allow the sequence to increment and roll-over. Do not program the TransactionNumber to reset when a batch close occurs.

In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.

Data Type

Integer

AdjustTransaction Method (TSYSHCAdjustment Class)

Sends an adjustment request.

Syntax

ANSI (Cross Platform)
int AdjustTransaction();

Unicode (Windows)
INT AdjustTransaction();

int dpaymentssdk_tsyshcadjustment_adjusttransaction(void* lpObj);

int AdjustTransaction();

Remarks

This method allows you to adjust a previously authorized transaction. It can be used to decrease the final SettlementAmount and adjust non-financial fields. If the adjustment request was successful, the Code property will contain "200". Response will contain additional details about the authorization request.

Minimum required properties:

GenKey
MerchantId
RoutingId
OriginalAmount
RetrievalNumber or TransactionNumber

In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.

If a timeout occurs during the adjustment request, you will want to use the TSYSHCTransactionDetails class to issue a GetDetails request. If the request was received by the TSYS server, the GetDetails response will contain the adjusted values and no other steps are necessary. If the request was not received by the TSYS server, the GetDetails response will show that the adjusted values were not updated. Therefore the adjustment request should be resent.

Note that AdjustTransaction cannot be used to add a tip amount. If you wish to add a tip, you must use AdjustTip.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (TSYSHCAdjustment Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_tsyshcadjustment_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (TSYSHCAdjustment Class)

Interrupts the current action.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_tsyshcadjustment_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

Reset Method (TSYSHCAdjustment Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_tsyshcadjustment_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

Error Event (TSYSHCAdjustment Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(TSYSHCAdjustmentErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TSYSHCAdjustmentErrorEventParams;


Unicode (Windows)
virtual INT FireError(TSYSHCAdjustmentErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TSYSHCAdjustmentErrorEventParams;

#define EID_TSYSHCADJUSTMENT_ERROR 1

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TSYSHCAdjustmentErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TSYSHCAdjustmentErrorEventParams *e);

// Or, subclass TSYSHCAdjustment and override this emitter function.
virtual int FireError(TSYSHCAdjustmentErrorEventParams *e) {...}

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 (TSYSHCAdjustment Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(TSYSHCAdjustmentSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} TSYSHCAdjustmentSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(TSYSHCAdjustmentSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} TSYSHCAdjustmentSSLServerAuthenticationEventParams;

#define EID_TSYSHCADJUSTMENT_SSLSERVERAUTHENTICATION 2

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class TSYSHCAdjustmentSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(TSYSHCAdjustmentSSLServerAuthenticationEventParams *e);

// Or, subclass TSYSHCAdjustment and override this emitter function.
virtual int FireSSLServerAuthentication(TSYSHCAdjustmentSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (TSYSHCAdjustment Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(TSYSHCAdjustmentSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} TSYSHCAdjustmentSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(TSYSHCAdjustmentSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} TSYSHCAdjustmentSSLStatusEventParams;

#define EID_TSYSHCADJUSTMENT_SSLSTATUS 3

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class TSYSHCAdjustmentSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(TSYSHCAdjustmentSSLStatusEventParams *e);

// Or, subclass TSYSHCAdjustment and override this emitter function.
virtual int FireSSLStatus(TSYSHCAdjustmentSSLStatusEventParams *e) {...}

Remarks

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

CCCard Type

Contains the customer's credit card information.

Syntax

DPaymentsSDKCCCard (declared in dpaymentssdk.h)

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 MagneticStripe 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 EntryDataSource to indicate which track is stored in the MagneticStripe 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 Number, ExpMonth, and ExpYear fields, and EntryDataSource 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 EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, 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 EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will fails with an error because none is present.

The following fields are available:

CardType
CVVData
CVVPresence
EntryDataSource
ExpMonth
ExpYear
IsEncrypted
MagneticStripe
Number

Fields

CardType
int
Default Value: 0

Type of credit card being used in this transaction. This field contains the customer's credit card type. This is automatically computed after the Number 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
char*
Default Value: ""

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

This alphanumeric field 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 field which can be used to determine if the customer is actually in possession of the credit card.

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

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

CVVPresence
int
Default Value: 0

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

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

Available values are:

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

EntryDataSource
int
Default Value: 0

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


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. (Number, ExpMonth, and ExpYear are sent).
edsKiosk (9)	Automated kiosk transaction. Track1 or Track2 data must be sent in MagneticStripe, 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
int
Default Value: 1

Expiration month of the credit card specified in Number.

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

ExpYear
int
Default Value: 2000

Expiration year of the credit card specified in Number.

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

IsEncrypted
int
Default Value: FALSE

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

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

MagneticStripe
char*
Default Value: ""

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

If EntryDataSource is not one of the manually entered enumerations, then this field 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 field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.

The following example shows how to set the MagneticStripe and EntryDataSource fields 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
char*
Default Value: ""

Customer's credit card number for the transaction.

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

Constructors

CCCard()

CCCard(const char* lpszNumber, int iExpMonth, int iExpYear)

CCCard(const char* lpszMagneticStripe, int iEntryDataSource)

Certificate Type

This is the digital certificate being used.

Syntax

DPaymentsSDKCertificate (declared in dpaymentssdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

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 field 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 (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 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 PKCS#11 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 Store and set StorePassword 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.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

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 field 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=example@email.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname 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.

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

TSYSHCAdjustmentResponse Type

Contains the response to the adjustment.

Syntax

DPaymentsSDKTSYSHCAdjustmentResponse (declared in dpaymentssdk.h)

Remarks

This type contains the results of an adjustment transaction made with the TSYSHCAdjustment, TSYSHCLevel3, or TSYSHCReversal class. The fields contained by this type are listed below.

The following fields are available:

BatchNumber
Code
RetrievalNumber
Text
TransactionDate
TransactionNumber
TransactionTime

Fields

BatchNumber
int (read-only)
Default Value: 0

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.

Code
char* (read-only)
Default Value: ""

Indicates the status of the authorization request.

This field contains the response code indicating the status of the authorization request. The Point of Sale (POS) system must evaluate this response code and NOT the Text to determine nature of a response message. A response code of "00" represents an approval. A response code of "10" indicates that the transaction was partially approved for a lesser amount (AuthorizedAmount). All other response codes represent non-approved requests. Do NOT interpret all non-approved response codes as "DECLINED".

A list of valid result Codes are listed in the table of contents.

RetrievalNumber
char* (read-only)
Default Value: ""

This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement.

This field contains a 12-character value reflecting the transaction Retrieval Reference Number returned by the authorizing system. The Point of Sale (POS) system should record the Retrieval Reference Number received in the original authorization response.

Text
char* (read-only)
Default Value: ""

Text information that describes each response code.

This field contains a 16-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language.

The English-language response text messages are listed in the table of contents.

TransactionDate
char* (read-only)
Default Value: ""

Local transaction date returned from the server in MMddyy format.

This six digit field contains a local transaction date calculated by the authorization center using the time zone differential specified by the Merchant's Time Zone;. This field should be recorded and submitted in the Batch Settlement.

TransactionNumber
char* (read-only)
Default Value: ""

Check this field against the original Transaction Number.

This field should be compared to the TransactionNumber in order to match a response with a given authorization request when in Interleaved mode (Timeout = 0). If running in non-interleaved (synchronous) mode, this field should always be identical to TransactionNumber. If it is not, the transaction must not be settled in the Batch Settlement.

TransactionTime
char* (read-only)
Default Value: ""

Local transaction time returned from the server in HHmmss format.

This six digit field contains the Local Transaction Time returned by the authorizing system. This field should be recorded and submitted in the Batch Settlement.

Constructors

TSYSHCAdjustmentResponse()

TSYSHCLevel2 Type

Contains the Corporate Purchasing Card data to create Level2 transactions.

Syntax

DPaymentsSDKTSYSHCLevel2 (declared in dpaymentssdk.h)

Remarks

Contains the Corporate Purchasing Card data to create Level2 transactions.The fields contained by this type are listed below.

The following fields are available:

AmexChargeDescriptor
AmexChargeDescriptor2
AmexChargeDescriptor3
AmexChargeDescriptor4
AmexRequesterName
AmexShippedToZip
IsTaxExempt
PurchaseOrderNumber
TaxAmount

Fields

AmexChargeDescriptor
char*
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

AmexChargeDescriptor2
char*
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

AmexChargeDescriptor3
char*
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

AmexChargeDescriptor4
char*
Default Value: ""

Description of this transaction.

This property may contain up to 40 characters of free text (Spaces allowed) when sending Level II data for an American Express purchasing card.

AmexRequesterName
char*
Default Value: ""

The name of the requestor, if different than the cardholder.

This field contains the name of the requester, if the Card member is not the person that ordered or purchased the product or service.

The maximum length for this field is 38 characters.

AmexShippedToZip
char*
Default Value: ""

The zip code to which the commodity was shipped.

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place. This is only used when sending Level II data for an American Express purchasing card.

The maximum length for this field is 6 characters.

IsTaxExempt
int
Default Value: FALSE

Identifies the characteristics of the amount appearing in TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status.

When set to "True", the purchasing card will be indicated as being tax-exempt. When set to "False", the amount of TaxAmount will be indicated as being Local Sales Tax.

Note: This field cannot be set to "True" if there is a TaxAmount set.

PurchaseOrderNumber
char*
Default Value: ""

Optional customer-specified purchase order number.

This field contains a Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder. The maximum length is 25 characters.

TaxAmount
char*
Default Value: ""

Sales tax charged in addition to the original TransactionAmount

Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Constructors

TSYSHCLevel2()

Config Settings (TSYSHCAdjustment Class)

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.

TSYSHCAdjustment Config Settings

Language: Indicates the language to be used in formatting the authorization response text message.

This field allows you to specify the two-character indicator to indicate the format of the authorization response text message. The current possible values are:


00	English
01	Spanish
02	Portuguese

RawRequest: Returns the request sent to the server for debugging purposes.

After an operation this setting may be queried to return the request as it was sent to the server. This is useful for debugging purposes.

RawResponse: Returns the response received from the server for debugging purposes.

After an operation this setting may be queried to return the response as it was received from the server. This is useful for debugging purposes.

ServerURL: The server to which transactions are posted.

This is name of the server to which all transactions are posted. Do not use an IP address, use the actual name, as a server's IP address may change. The default (Live) TSYS server is "https://ssl2.vitalps.net/scripts/gateway.dll?transact", but you may use "https://ssltest.tsysacquiring.net/scripts/gateway.dll?transact" for testing.

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 fails with an error 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 fails with an error.

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 fails with an error 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") or HTTP/3 ("3.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 true, 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 false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

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 CRLF ("\r\n") .

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 User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

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