/n software PayPal reauthcapture Component : reauthcapture OCX, reauthcapture .NET Component, reauthcapture Class, reauthcapture Bean, reauthcapture Object

Available in: PAYPAL

ReAuthCapture Component [IBiz PayPal Integrator V2]

Properties Methods Events Configuration Settings

Capture, void, or re-authorize a previous transaction.

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

The ReAuthCapture component consists of three basic functions which may be performed on transactions previously authorized with either the DIRECTPAYMENT or EXPRESSCHECKOUT components.


VoidTransaction	Voids a previously authorized transaction.
Capture	Settles a previously authorized transaction and obtains payment for either the complete amount or any portion of it.
ReAuthorize	Re-authorizes a previous transaction for a larger amount. To check the availability of a PayPal member's funds to make a payment higher than you originally authorized, up to 115% of the originally authorized amount (not to exceed an increase of $75 USD) and up to $10,000 USD.

All of these methods require a previously authorized transaction. You can authorize a transaction in several ways:

From the Merchant Tools tab of your PayPal merchant account.
With the CheckoutPayment method of the EXPRESSCHECKOUT component, with the request's PaymentAction set to "aAuthorization".
With the Authorize method of the DIRECTPAYMENT component.
With a shopping cart transaction (such as one that uses PayPal Website Payments) with the paymentaction HTML variable set to authorization.

You must have a PayPal account set up with API access to use this component Once that is accomplished you may void, capture, or re-authorize transactions.

First set the Username to your API name, and Password to the password for that API. Set the SSLCertStore to the PEM-encoded API certificate you received from PayPal. Then you may set the transaction properties, such as OrderTotal, CardNumber, CardExpMonth, CardExpYear, etc. Then call either Sale or Authorize. The Ack property will indicate the success or failure of the transaction.

For example:

component.Username = "youraccount_api1.nsoftware.com" component.Password = "password" component.SSLCertStoreType = sstPEMKey component.SSLCertStore = "-----BEGIN RSA PRIVATE KEY-----MIICXAIBAAKBgQC5KK..." component.SSLCertSubject = "*"

To use these methods in this component, you must save the transaction Id from the original transaction, and pass it into the AuthorizationId parameter of any of these methods. For example:

ReAuthCapture1.VoidTransaction("64J61164793525252") MsgBox(ReAuthCapture1.Ack)

ReAuthCapture1.Capture("64J61164793525252", "12.88") MsgBox(ReAuthCapture1.Ack)

ReAuthCapture1.ReAuthorize("64J61164793525252", "16.88") MsgBox(ReAuthCapture1.Ack)

Note that these operations may ONLY be performed on a previously authorized transaction. A Sale transaction cannot be voided, captured, or re-authorized.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Ack	Acknowledgement code received from PayPal.
AuthorizationId	The authorization identification number of the payment.
CurrencyCode	Type of currency in which you are accepting payments.
IsPartialCapture	Indicates if this capture is for the full amount of payment you authorized.
Note	An informational note about this settlement that will be displayed in the payer's transaction history.
Password	Password for communicating with PayPal.
PaymentDate	Time/date stamp of payment.
PaymentExchangeRate	Exchange rate if a currency conversion occurred.
PaymentFeeAmount	PayPal fee amount charged for the transaction.
PaymentGrossAmount	The final amount charged.
PaymentPendingReason	The reason the payment is pending.
PaymentSettleAmount	Amount deposited in your PayPal account after a currency conversion.
PaymentStatus	Status of the payment.
PaymentTaxAmount	Tax charged on the transaction.
PaymentTransactionId	Unique transaction ID of the payment.
PaymentTransactionType	The type of transaction.
PaymentType	Indicates whether the payment is instant or delayed.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
Signature	Value to use with PayPal's Signature Authentication scheme.
Timeout	A timeout for the component.
URL	URL all PayPal transactions are posted to.
User	User name for communicating with Paypal.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


Capture	Completely or partially settles a previously authorized transaction.
Config	Sets or retrieves a component configuration setting.
ReAuthorize	Reauthorize the transaction.
Reset	Reset the internal state of the component and all properties to their default values.
VoidTransaction	Voids a prior authorization.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


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 complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AuthorizingAccount	Authorizing Account Email Address for third-party API access.
Build	Returns the Build number contained in the response.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FaultCode	Returns the SOAP fault code, if any.
FaultString	Returns the error message associated with the SOAP fault code.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
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).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic 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 Basic authentication is to be used for the proxy.
ResponseVersion	Returns the Version number contained in the response.
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
SocketHandle	The handle of the main socket used by the component.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
Version	Allows the user to set the Version number in the request.
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)