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

AdaptivePreApproval Class

Properties   Methods   Events   Configuration Settings   Errors  

The AdaptivePreApproval component is used to create, retrieve, and cancel preapproval transactions.

Syntax

inpaypal.adaptivepreapproval()

Remarks

The sender of a payment must approve the transfer. The sender can log in to paypal.com to approve each payment, preapprove payments, or when the sender is your application, be implicitly approved to make payments. There are 3 kinds of payment approvals:

  • Explicit approval payments, in which the sender logs into paypal.com to approve each payment. Explicitly approving payments is the traditional way to pay with PayPal. This method is the only option unless the sender has set up a preapproval agreement or you, the API caller, are also the sender.
  • Preapproved payments, in which a sender logs into PayPal and sets up preapprovals that approve future payments; for example, for a specific vendor. The sender logs into paypal.com once to set up the preapproval. After the preapproval is set up, payments are considered approved, and specific approval is unnecessary.
  • Implicit approval payments, in which your application is both the sender of a payment and the caller of the Adaptive Payments Pay API. In this case, the payment is drawn from your own account, which eliminates the need for approval.
Use the CreatePreApproval method to set up a preapprovals for a specific maximum amount over a specific period of time and optionally, by any of the following constraints: the number of payments, a maximum per-payment amount, a specific day of the week or the month, and whether or not a PIN is required for each payment request.

To set up a preapproval request, you must specify values for the following required properties (in addition to your PayPal credentials):

StartingDateFirst date for which the preapproval is valid. It cannot be before today's date or after the EndingDate.
EndingDateLast date for which the preapproval is valid. It cannot be later than one year from the StartingDate.
MaxTotalPaymentAmountThe preapproved maximum total amount of all payments. It cannot exceed $2,000 USD or its equivalent in other currencies.
CurrencyCode The code for the currency in which the payment is made. You can specify only one currency, regardless of the number of recipients.
CancelURL URL to redirect the sender's browser to in the event he cancels the preapproval.
ReturnURL URL to redirect the sender's browser to after the sender has logged into PayPal and confirmed the preapproval.
ClientDetailsInformation about the sender to whom the preapproval will be sent.

Upon a successful CreatePreApproval request, the PreApprovalKey property will contain a key that may be used in the AdaptivePay class to identify this preapproval. It is also used when canceling or retrieving the details of a preapproval, by simply passing the value to the PreApprovalKey parameter of the CancelPreApproval or GetPreApprovalDetails methods.

Note: Preapproval requests require an advanced permission level.

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.
ApplicationIdYour application's identification, which is issued by PayPal.
ApprovedIndicates whether a preapproval request was approved.
AuthorizingAccountThird-party permission specification.
AddressCountThe number of records in the BillingAddress arrays.
BillingAddressAddressNameThe name of the person that is billed.
BillingAddressCityThe city for the billing address.
BillingAddressCountryCodeThe country code for the billing address.
BillingAddressLine1The street name for the billing address.
BillingAddressLine2An extra line for the street address.
BillingAddressPostalCodeThe postal code of the billing address.
BillingAddressStateThe state for the billing address.
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.
CurrentPaymentAmountThe current total of payments by the sender for this preapproval.
CurrentPaymentNumberThe current number of payments by the sender for this preapproval.
CurrentPeriodAttemptsThe current number of payments by the sender this period for this preapproval.
CurrentPeriodEndingDateEnding date for the current period. Time is currently not supported.
DateOfMonthThe day of the month on which a monthly payment is to be made.
DayOfWeekThe day of the week that a weekly payment is to be made.
DeviceIdClient's device ID.
DeviceIPClient's IP address.
EndingDateLast date for which the preapproval is valid.
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.
MaxAmountPerPaymentThe preapproved maximum amount per payment.
MaxPaymentsThe preapproved maximum number of payments.
MaxPaymentsPerPeriodThe preapproved maximum number of all payments per period.
MaxTotalPaymentAmountThe preapproved maximum total amount of all payments.
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.
PaymentPeriodThe payment period.
PreApprovalKeyReturned from PayPal and used to identify this preapproval.
PreApprovalStatusIndicates the status of the 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.
RequirePINIndicates whether a personal identification number is required.
ReturnURLThe URL the sender is returned to after completing a transaction.
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).
StartingDateFirst date for which the preapproval is valid.
TimeoutA timeout for the component.
TimeStampThe date on which the response was sent.
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.

CancelPreApprovalCancels an existing preapproval.
ConfigSets or retrieves a configuration setting .
CreatePreApprovalSets up a preapproval transaction with PayPal.
DoEventsProcesses events from the internal message queue.
GetPreApprovalDetailsRetrieves information about an existing preapproval.
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.
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 class 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.
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.

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