PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

ReAuthCapture Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

ReAuthCapture

Remarks

The ReAuthCapture class consists of three basic functions which may be performed on transactions previously authorized with either the DirectPayment or ExpressCheckout classs.

VoidTransactionVoids a previously authorized transaction.
CaptureSettles a previously authorized transaction and obtains payment for either the complete amount or any portion of it.
ReAuthorizeRe-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 class, with the request's PaymentAction set to Authorization.
  • With the Authorize method of the DirectPayment class.
  • 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 class Once that is accomplished you may void, capture, or re-authorize transactions.

First set the User to your API name, and Password to the password for that API. Set the Signature property to the API signature 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.

To use these methods in this class, 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)

Or


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

Or


  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 class with short descriptions. Click on the links for further details.

AckAcknowledgement code received from PayPal.
AuthorizationIdThe authorization identification number of the payment.
CurrencyCodeType of currency in which you are accepting payments.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
IsPartialCaptureIndicates if this capture is for the full amount of payment you authorized.
NoteAn informational note about this settlement that will be displayed in the payer's transaction history.
PasswordPassword for communicating with PayPal.
PaymentDateThis is the time/date stamp of payment.
PaymentExchangeRateExchange rate if a currency conversion occurred.
PaymentFeeAmountPayPal fee amount charged for the transaction.
PaymentGrossAmountThe final amount charged.
PaymentTypeIndicates whether the payment is instant or delayed.
PaymentPendingReasonThe reason the payment is pending.
PaymentSettleAmountAmount deposited in your PayPal account after a currency conversion.
PaymentStatusStatus of the payment.
PaymentTaxAmountTax charged on the transaction.
PaymentTransactionIdUnique transaction ID of the payment.
PaymentTransactionTypeThe type of transaction.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
URLURL all PayPal payment transactions are posted to.
UserUser name for communicating with Paypal.

Method List


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

AddCustomFieldThis adds a custom name-value pair to be sent with the next request.
CaptureCompletely or partially settles a previously authorized transaction.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
GetResponseVarIt is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.
InterruptInterrupt the current method.
ReAuthorizeReauthorize the transaction.
ResetReset the internal state of the component and all properties to their default values.
VoidTransactionVoids a prior authorization.

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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

PaymentProtectionEligibilityIf the PaymentPendingReason is PaymentReview this will return the protection in force for the transaction.
AuthorizingAccountAuthorizing Account Email Address for third-party API access.
AuthAccessTokenThe access token returned by the PayPal Permission Service's GetAccessToken operation.
AuthApplicationIdThe Application ID for the application making a request to the PayPal Permissions Service.
AuthAuthHeaderThe PayPal Permissions Service authentication header.
AuthAuthHeaderNameThe name of the authentication header generated with the PayPal Permissions Service.
AuthCallbackURLThe URL where PayPal will post the RequestToken and VerificationCode.
AuthPasswordAPI Password for the PayPal Permissions Service.
AuthRequestTokenThe request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
AuthRequestURLThe URL for the PayPal Permissions Service operation being requested.
AuthScopeScope of permissions to be requested for PayPal Permissions Service.
AuthSignatureAPI Signature for the PayPal Permissions Service.
AuthTokenSecretThe token secret returned by the PayPal Permission Service's GetAccessToken operation.
AuthUsernameAPI Username for the PayPal Permissions Service.
AuthVerificationCodeThe verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
BuildReturns the Build number contained in the response.
RawRequestReturns the raw request sent to the server.
RawResponseReturns the full response.
ResponseVersionReturns the Version number contained in the response.
VersionAllows the user to set the Version number in the request.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0