The Net Tools Company - 800.225.4190
Search: 
Available in: PAYPAL
TransactionDetails Component [PayPal Integrator V3]

Properties   Methods   Events   Configuration Settings  

The TransactionDetails component retrieves all information about a single 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 TransactionDetails component is used to retrieve information about payments to the merchant's PayPal account. The properties returned by PayPal will indicate the items purchased, the quantity of those items, the payer's name and address, the price paid, and other information pertinent to the transaction.

Property List


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

AckAcknowledgement code received from PayPal.
AuctionBuyerIdAuction buyer's Id.
AuctionClosingDateDate auction ended.
CurrencyCodeCurrency code of the GrossAmount.
CustomCustom field as originally set by the merchant.
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.
InvoiceIdInvoice number as originally set by the merchant.
ItemCountThe number of records in the Item arrays.
ItemAmountAmount of charged on payment.
ItemDescriptionPaypal item description for the shopping cart.
ItemNameName of the item purchased.
ItemNumberItem number set by the merchant.
ItemOptionsPaypal item options for the shopping cart.
ItemQuantityQuantity of items ordered.
ItemSalesTaxAmount of tax charged on payment.
MemoNote entered by customer when paying for item.
PasswordPassword for communicating with PayPal.
PayerAddressNameName appearing with payer's address information.
PayerAddressStatusStatus of the payer's address.
PayerBusinessPayer's business email address.
PayerCityPayer's city name.
PayerCountryCodePayer's country code corresponding to CountryName .
PayerCountryNamePayer's country name.
PayerEmailEmail address of the payer.
PayerFirstNamePayer's first name.
PayerIdUnique encrypted PayPal customer account number.
PayerLastNamePayer's last name.
PayerMiddleNamePayer's middle name.
PayerSalutationPayer's salutation.
PayerStatePayer's state or province name.
PayerStatusIndicates whether the payer is verified or not.
PayerStreet1Payer's street address (first line).
PayerStreet2Payer's street address (second line).
PayerSuffixPayer's name suffix.
PayerZipPayer's United States ZIP code or other country-specific postal code.
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.
ReasonCodeThe reason for a reversal.
ReceiptIdThe Receipt Id.
RecipientEmailPrimary email address of the payment recipient (the seller).
RecipientIdUnique account Id of the payment recipient (the seller).
SalesTaxThe amount of tax charged on the payment.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncodedThe SSL certificate (PEM/base64 encoded).
SSLCertEncodedThe SSL 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 SSL certificate (PEM/base64 encoded).
SubscriptionAmountSubscription information returned by Paypal.
SubscriptionPeriodSubscription information returned by Paypal.
TimeoutA timeout for the component.
URLURL all PayPal transactions are posted to.
UserUser 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 further details.

AddCustomFieldThis adds a custom name-value pair to be sent with the next request.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetTransactionDetailsGets details about a payment.
InterruptInterrupt the current method.
ResetReset the internal state of the component and all properties to their default values.

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.

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

ParentTransactionIdThe Parent Id of the returned transaction.
PaymentProtectionEligibilityIf the PaymentPendingReason is PaymentReview this will return the protection in force for the transaction.
AuthorizingAccountAuthorizing Account Email Address for third-party API access.
BuildReturns the Build number contained in the response.
RequestReturns the raw request sent to the server.
ResponseReturns 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.
AuthorizationThe Authorization string to be sent to the server.
EncodeURLIf set to true the URL will be encoded by the component.
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.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
UseWinInetIf set, the WinInet API is used for retrieving the URL.
UseWinInetCookiesControls whether to send and accept cookies when making HTTP requests through WinInet.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallUserA user name if authentication is to be used connecting through a firewall.
FirewallTypeDetermines the type of firewall to connect through.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
| About | Privacy Policy | Terms of Use |
© Copyright 2011 /n software inc.