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

AdaptivePay Class

Properties   Methods   Events   Configuration Settings   Errors  

The AdaptivePay component is used to make simple payments, chained payments, or parallel payments. These payments can be explicitly approved, preapproved, or implicitly approved.

Syntax

inpaypal.adaptivepay()

Remarks

In an adaptive payment, the sender and recipient refer to the sender and receivers of funds, not the originator and recipient of the payment request. In the case of a simple payment, the recipient (merchant) sends the payment request to the sender (the merchant's customer), who then logs into PayPal and approves the transaction.

Chained and parallel payments are only slightly more complicated. In a parallel payment the sender makes a payment to multiple different recipients in one request. For instance, take a shopping cart that aggregates items from different merchants. When the customer approves the payment request he sees how his payment is being split up between several different merchants.

However, in a chained payment the customer sees only the primary recipient, but behind the scenes multiple recipients receive money. For instance, if you have your products drop-shipped from a warehouse off-site, you can transfer the shipping portion of the payment to them immediately, or you can immediately pay a commission to your sales representative.

This is useful because even though multiple recipients are receiving funds, you are only charged PayPal fees for one transaction.

To make a payment, set at least one Recipients (RecipientEmail and RecipientAmount), the CurrencyCode, CancelURL, and ReturnURL, and then call Pay. To make a parallel payment, set multiple Recipients and to make a chained payment make one (and only one) of the Recipients primary by setting the RecipientPrimary property to True.

For implicit approval, set the SenderEmail property. If you have a Preapproval set up, you can use the preapproval to avoid explicit approval. In that case set the PreApprovalKey and PreApprovalPIN properties instead.

If you need to change any default payment settings, use the CreatePayment method instead. Pass the PaymentKey you receive to the SetPaymentOptions method to update the default payment settings for that transaction. Then call ExecutePayment once you're ready to fulfill the payment.

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.
AllowedFundingTypesSpecifies the allowed funding types for the payment.
ApplicationIdYour application's identification, which is issued by PayPal.
AuthorizingAccountThird-party permission specification.
CancelURLURL the sender is redirected to upon canceling payment approval.
ClientDetailsApplicationYour application's identification.
ClientDetailsCustomerIdYour identification for this sender.
ClientDetailsCustomerTypeYour identification of the type of customer.
ClientDetailsDeviceIdSender's device Id.
ClientDetailsGeoLocationSender's geographic location.
ClientDetailsIPAddressSender's IP address.
ClientDetailsModelA sub-identification of the application.
ClientDetailsPartnerNameYour organization's name or Id.
CurrencyCodeThe currency being used for this payment.
DeviceIdClient's device ID.
DeviceIPClient's IP address.
FeesPayerThe payer of the PayPal fees.
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.
MemoA note associated with the payment.
NotificationURLThe URL to which you want all IPN messages for this payment to be sent.
PasswordPassword for communicating with PayPal.
PaymentKeyToken returned by Paypal, used to identify the transaction.
PaymentOptionsCountryCodeThe two-character country code of the home country of the end consumer.
PaymentOptionsCustomerIdThe unique identifier assigned to the consumer by the institution.
PaymentOptionsDisplayNameThe full name of the customer as known by the institution.
PaymentOptionsEmailThe email address of the consumer as known by the institution.
PaymentOptionsFirstNameThe first name of the consumer as known by the institution.
PaymentOptionsHeaderImageURLThe URL where the image is stored that appears in the header of customer emails.
PaymentOptionsInstitutionIdThe unique identifier assigned to the institution.
PaymentOptionsLastNameThe last name of the consumer as known by the institution.
PaymentOptionsMarketingImageURLThe URL where the marketing image is stored that appears in customer emails.
PaymentStatusThe status of the payment.
PreApprovalKeyThe key associated with a preapproval for this payment.
PreApprovalPINThe personal identification number received by the sender when signing up for a preapproval.
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.
RecipientCountThe number of records in the Recipient arrays.
RecipientAmountAmount to be paid to the recipient.
RecipientEmailRecipient's email address This property is required.
RecipientInvoiceIdThe invoice number for the payment.
RecipientPaymentTypeThe transaction subtype for the payment.
RecipientPhoneCountryCodeThe telephone country code of the receiver's phone number.
RecipientPhoneExtensionAn extension for the PhoneNumber .
RecipientPhoneNumberThe recipient's phone number.
RecipientPrimaryIndicates whether the recipient is the primary receiver.
ReturnURLThe URL the sender is returned to after completing a transaction.
ReverseOnErrorIndicates whether to reverse all parallel payments if an error is encountered.
SenderEmailSender's email address.
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.
TimeStampThe date on which the response was sent.
TrackingIdUser-generated unique tracking number.
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 class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
CreatePaymentCreates a payment to be executed at a later time.
DoEventsProcesses events from the internal message queue.
ExecutePaymentRuns a payment that was previously created.
GetPaymentOptionsRetrieves the payment options for a previously created transaction.
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.
PayCreates and executes a new payment.
ResetReset the internal state of the component and all properties to their default values.
SetPaymentOptionsSets the payment options for newly created transactions.

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.
PayErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
WarningInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

DelayedChainedPaymentsDetermines whether to perform a delayed chained payment.
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