PTechReversal Class
Properties Methods Events Configuration Settings Errors
The PTECHREVERSAL component is used to reverse a transaction that was previously authorized with the Paymentech NetConnect system on the Tampa platform. This immediately releases the funds in the cardholder's open-to-buy that were blocked by the original authorization.
Syntax
PTechReversal
Remarks
Setting up the class and reversing a transaction is easy. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your IndustryType and PINCapability at this time.
After the merchant information is setup, enter the data from the transaction you wish to reverse. Note that the transaction must be a currently open authorization, and cannot have already been settled via the PTechManualSettle class. To reverse an authorization, set the CardNumber, CardExpMonth, CardExpYear, IndustryType, and POSRetrievalNumber which were sent in the original transaction. Also indicate the type of the original authorization (Auth-only or Sale) in the OriginalTransactionType property. The OriginalTransactionAmount should be set to the amount originally sent in the TransactionAmount property of the class that authorized the transaction. It does not matter if the amount actually authorized was less, the originally submitted amount must be sent in the OriginalTransactionAmount property.
For example:
class.IndustryType = itRetail class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.OriginalTransactionType = ttAuthOnly class.OriginalTransactionAmount = "1.00" class.POSRetrievalNumber = "1234567890" class.Reverse()
The status of the reversal request will be stored in the ResponseCode property, with human-readable text appearing in the ResponseText property. There are several other Response properties which will contain data that should be logged.
Reversal transactions must NOT be added to the batch settlement, and the authorization which was reversed by this class MUST be removed from the batch. Settling a reversed transaction will result in transfer of funds from the customer's credit card to your merchant account, so care must be taken to ensure that reversed transaction are not included in the manual settlement.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
CardExpMonth | Expiration month of the credit card specified by CardNumber . |
CardExpYear | Expiration year of the credit card specified by CardNumber . |
CardNumber | Credit card used in the transaction that is now being reversed. |
ClientNumber | Merchant configuration property, assigned by Paymentech. |
IndustryType | Determines the merchant's industry type. |
MerchantNumber | A unique number used to identify the merchant, assigned by Paymentech. |
OriginalTransactionAmount | Transaction amount sent in the original sale or auth-only transaction. |
OriginalTransactionType | Indicates whether the original transaction was an auth-only or a sale. |
Password | Password for authentication with the NetConnect Server . |
PINCapability | Indicates if the terminal device supports a PIN pad. |
POSRetrievalNumber | Merchant-generated reference number from the original transaction. |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
ResponseDebitSurcharge | Additional fee charged for debit transactions. |
ResponseDebitTrace | This property is returned in the response to a debit card transaction. |
ResponseApprovalCode | Contains an authorization code when a transaction has been approved, or an error code. |
ResponseAuthorizedAmount | Used for partial authorizations. |
ResponseAuthSource | Indicates the source of the authorization code stored in ApprovalCode . |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseBatchNumber | Current open batch number This property is returned after sending a BatchInquiry or BatchRelease transaction with the PTECHHOSTSETTLE component, or after a SendSettlement sent using the PTECHMANUALSETTLE component. |
ResponseCardLevel | This property contains a two-character code created by Visa during the authorization process. |
ResponseCardType | Type of the credit card. |
ResponseCode | Indicates the status of the authorization request. |
ResponseCVVResult | Contains the returned CVV result code if it was requested. |
ResponseNetworkId | Authorizing network Identifier which indicates which network approved this transaction. |
ResponseRetrievalNumber | Reference number returned from the Paymentech host. |
ResponseSequenceNumber | SequenceNumber echoed from the authorization. |
ResponseText | Approval/Decline/Error text message information This property contains a response or display text message, and is used by the terminal to display the authorization result. |
ReversalReason | Reason the transaction is being reversed. |
SequenceNumber | Sequence number of the transaction. |
Server | The URL for the PaymenTech NetConnect server. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
TerminalNumber | Terminal number assigned by Paymentech. |
Timeout | A timeout for the component. |
UserId | UserId for authentication with the NetConnect Server . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting . |
Interrupt | Interrupt the current method. |
Reset | Clears all properties to their default values. |
Reverse | Reverses a previously authorized transaction. |
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.
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
SettlementMode | Indicates whether the component uses Paymentech's Host Capture or Terminal Capture system. |
ResponsePOSRetrievalNumber | POS Retrieval Number sent in the request, echoed back in the response. |
AllowPartialReversals | Indicates whether a partial reversal will be performed. |
ApprovalCode | The Approval code returned in the response to the authorization linked to this transaction. |
SystemInformation | System Information field for Batch Inquiry and Release transactions. |
EMVData | The EMV data returned from a Pin Pad after reading an EMV card. |
EMVEntryDataSource | The EMV Data Entry Source (DES). |
ResponseEMVData | The response EMV data. |
ResponseEMVCardAuthCode | The ChaseNet and Visa card authentication results code. |
ResponseEMVDownloadIndicator | Whether EMV parameters should be updated. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
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. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
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. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
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 TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
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). |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |