TransactionSearch Bean
Properties Methods Events Configuration Settings Errors
The TransactionSearch component searches the merchant's PayPal account for transactions that meet the specified criteria.
Syntax
InPayPal.Transactionsearch
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 "Result" properties (i.e. PayerEmail, Status, etc). For more detailed information about the transaction the TransactionId 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 FirstName 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 bean with short descriptions. Click on the links for further details.
| Ack | Acknowledgement code received from PayPal. |
| Firewall | A set of properties related to firewall access. |
| Idle | The current status of the component. |
| Password | Password for communicating with PayPal. |
| Proxy | A set of properties related to proxy access. |
| Results | The transactions returned by PayPal's search. |
| SearchCriteria | Set this to the criteria to search for. |
| Signature | Value to use with PayPal's Signature Authentication scheme. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| 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 bean with short descriptions. Click on the links for further details.
| addCustomField | This adds a custom name-value pair to be sent with the next request. |
| config | Sets or retrieves a configuration setting . |
| doEvents | Processes events from the internal message queue. |
| getResponseVar | It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties. |
| interrupt | Interrupt the current method. |
| 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 bean 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. |
Configuration Settings
The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.
| AuthorizingAccount | Authorizing Account Email Address for third-party API access. |
| AuthAccessToken | The access token returned by the PayPal Permission Service's GetAccessToken operation. |
| AuthApplicationId | The Application ID for the application making a request to the PayPal Permissions Service. |
| AuthAuthHeader | The PayPal Permissions Service authentication header. |
| AuthAuthHeaderName | The name of the authentication header generated with the PayPal Permissions Service. |
| AuthCallbackURL | The URL where PayPal will post the RequestToken and VerificationCode. |
| AuthPassword | API Password for the PayPal Permissions Service. |
| AuthRequestToken | The request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service. |
| AuthRequestURL | The URL for the PayPal Permissions Service operation being requested. |
| AuthScope | Scope of permissions to be requested for PayPal Permissions Service. |
| AuthSignature | API Signature for the PayPal Permissions Service. |
| AuthTokenSecret | The token secret returned by the PayPal Permission Service's GetAccessToken operation. |
| AuthUsername | API Username for the PayPal Permissions Service. |
| AuthVerificationCode | The verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service. |
| Build | Returns the Build number contained in the response. |
| RawRequest | Returns the raw request sent to the server. |
| RawResponse | Returns the full response. |
| ResponseVersion | Returns the Version number contained in the response. |
| Version | Allows the user to set the Version number in the request. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| 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. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| 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. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| 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). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| 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. |