AdaptivePaymentDetails Component

Properties Methods Events Configuration Settings Errors

The AdaptivePaymentDetails component is used to retrieve information about transactions previously made with the ADAPTIVEPAY component.

Syntax

TiblAdaptivePaymentDetails

Remarks

Specify the payment you're interested in using either the PaymentKey, TransactionId, or TrackingId. It is not recommended to specify more than one of these properties, unless they identify the same payment. If the properties do not belong to the same payment, the TransactionId is used; next, PayPal uses the PaymentKey. If more than one of these is specified, the TrackingId is never used. After setting one of these three properties simply call GetPaymentDetails to retrieve the transaction.

Other than PayPal credentials, these are the only properties you may set in this component All of the remaining read-only properties describe the transaction you're retrieving.

Property List

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


Ack	Acknowledgement code received from PayPal.
ActionType	Whether the payment action is Pay or Create.
AllowedFundingTypes	Specifies the allowed funding types for the payment.
ApplicationId	Your application's identification, which is issued by PayPal.
AuthorizingAccount	Third-party permission specification.
CancelURL	URL the sender is redirected to upon canceling payment approval.
CurrencyCode	The currency that was used for the payment.
DeviceId	Client's device ID.
DeviceIP	Client's IP address.
FeesPayer	The payer of the PayPal fees.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
Idle	The current status of the component.
Memo	A note associated with the payment.
NotificationURL	The URL to which you want all IPN messages for this payment to be sent.
Password	Password for communicating with PayPal.
PaymentInfoCount	The number of records in the PaymentInfo arrays.
PaymentInfoPendingRefund	Indicates whether the payment has a pending refund.
PaymentInfoRecipientAmount	Payment made to the receiver.
PaymentInfoRecipientEmail	Email address of the receiver of the payment.
PaymentInfoRecipientInvoiceId	The invoice number for the payment.
PaymentInfoRecipientPaymentType	The transaction subtype for the payment.
PaymentInfoRecipientPhoneCountryCode	The telephone country code of the RecipientPhoneNumber .
PaymentInfoRecipientPhoneExtension	An extension for the RecipientPhoneNumber .
PaymentInfoRecipientPhoneNumber	The receiver's mobile phone number.
PaymentInfoRecipientPrimary	Indicates whether the recipient is the primary receiver.
PaymentInfoRefundedAmount	The total amount refunded for this payment since the payment occurred.
PaymentInfoSenderTransactionId	The transaction identification number of the sender of the payment.
PaymentInfoSenderTransactionStatus	The transaction status of the payment.
PaymentInfoTransactionId	PayPal transaction ID for this payment to the specified receiver.
PaymentInfoTransactionStatus	The PayPal transaction status.
PaymentKey	Token used to identify a payment.
PaymentStatus	The status of the payment.
PreApprovalKey	The key associated with a preapproval for this payment.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
ReturnURL	The URL the sender is returned to after completing a transaction.
ReverseOnError	Indicates whether to reverse all parallel payments if an error is encountered.
SenderEmail	Sender's email address.
Signature	Value to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If 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.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
TimeStamp	The date on which the response was sent.
TrackingId	User-generated unique tracking number.
TransactionId	The PayPal transaction ID associated with the payment.
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 further details.


Config	Sets or retrieves a configuration setting .
DoEvents	Processes events from the internal message queue.
GetPaymentDetails	Retrieves details about a payment transaction.
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.

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.


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.
Warning	Information about errors during data delivery.

Configuration Settings

The following is a list of configuration settings for the component 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.