PTReversal Component [Paymentech Integrator V6]
Properties
Methods
Events
Configuration Settings
The PTREVERSAL 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. This component may only be used to reverse authorizations and sales that were originally sent in Terminal Capture Mode (also known as manual settlement mode).
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
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 PTMANUALSETTLE 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 status of the reversal request will be stored in the Response property, with human-readable text appearing
in the Response 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 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. |
| 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. |
| 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 PTHOSTSETTLE component, or after a SendSettlement sent using the PTMANUALSETTLE 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. |
| ResponseData | Contains the entire contents of the Server response. |
| ResponseDebitSurcharge | Additional fee charged for debit transactions. |
| ResponseDebitTrace | This property is returned in the response to a debit card transaction. |
| 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 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.
| |
| 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. |
| Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
| |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| Authorization | The Authorization string to be sent to the server. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| 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. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| 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. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| 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). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
