PTechReversal Component
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
nsoftware.InPayDirect.Ptechreversal
Remarks
Setting up the component 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 component. 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 component 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:
component.IndustryType = itRetail component.CardNumber = "4444333322221111" component.CardExpMonth = 1 component.CardExpYear = 2010 component.OriginalTransactionType = ttAuthOnly component.OriginalTransactionAmount = "1.00" component.POSRetrievalNumber = "1234567890" component.Reverse()
The result of the reversal request will be stored in the Response property. The Code field will contain the status of the request and the Text field will contain the human-readable response message. The contents of the Response should be logged after a successful transaction.
Reversal transactions must NOT be added to the batch settlement, and the authorization which was reversed by this component 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 component 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. |
Proxy | A set of properties related to proxy access. |
Response | Contains the response to an authorization. |
ReversalReason | Reason the transaction is being reversed. |
SequenceNumber | Sequence number of the transaction. |
Server | The URL for the PaymenTech NetConnect server. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
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 component 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 component 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 component 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. |