Search: 
Available in: PAYPAL
TransactionSearch Component [IBiz PayPal Integrator V2]

Properties   Methods   Events   Configuration Settings  

The TransactionSearch component searches the merchant's PayPal account for transactions that meet the specified criteria.

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 TransactionSearch component allows the merchant to search his PayPal account for transactions that fall within a date range, by the buyer's name or email address, and auction item number, among other search criteria. After calling the Search method, the component will contain limited information about each transaction that matches. These details are returned in the properties that begin with "Result" (i.e. ResultPayerEmail, ResultStatus, etc). For more detailed information about the transaction the ResultTransactionId property may be passed to the TransactionDetails component.

After calling the Search method, up to 100 exact and partial matches are returned. For example, a PayerFirstName of "Jess" returns results for the names "Jessica" and "Jessie".

Please note that you must always set the StartDate before performing a search.

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.
Amount Search by transaction amount.
CardNumber Search by the Credit Card number used to make the transaction.
CurrencyCode Search by currency code.
EndDate The latest transaction date to be included in the search.
InvoiceId Search by the invoice identification key.
ItemNumber Search by the item number of the purchased goods.
Password Password for communicating with PayPal.
PayerEmail Search by the Payer's email address.
PayerFirstName Search by the Payer's first name.
PayerLastName Search by the Payer's last name.
PayerMiddleName Search by the Payer's middle name.
PayerSalutation Search by the Payer's salutation (Mr, Mrs, etc)
PayerSuffix Search by the Payer's suffix (Jr, Sr, etc)
ReceiptId Search by the PayPal Account optional Receipt Id.
RecipientEmail Search by the receiver's email address.
ResultCount Number of results returned by PayPal.
ResultFeeAmount The PayPal fee that was charged for the transaction.
ResultGrossAmount The total gross amount charged, including any profile shipping and taxes that were added.
ResultNetAmount The net amount received by the seller.
ResultPayerDisplayName Display name of the buyer.
ResultPayerEmail The email address of the buyer.
ResultStatus The status of the transaction.
ResultTimeStamp Date and time the transaction took place.
ResultTimeZone The time zone of the transaction.
ResultTransactionId The transaction id of the seller.
ResultType The type of the transaction.
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.
StartDate The earliest transaction date at which to start the search.
Status Search by status.
Timeout A timeout for the component.
TransactionClass Search by the classification of the transaction.
TransactionId Search by the Transaction Id.
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.

Config Sets or retrieves a component configuration setting.
Reset Reset the internal state of the component and all properties to their default values.
Search Request to search the merchant's PayPal Transaction History

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)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.