RecurringPayments Component

Properties Methods Events Configuration Settings Errors

Create and manage profiles for recurring payments through PayPal.

Syntax

TiblRecurringPayments

Remarks

The RecurringPayments component allows you to create and manage profiles for buyers which contain recurring payments. RecurringPayments allows you to use your PayPal account to setup subscriptions or other defined recurring billing arrangements for your customers.

First set the User to your API name, and Password to the password for that API. Set the Signature property to the API signature you received from PayPal. Then you may set profile settings depending on what operation you may be performing. Profile settings such as : BillingDetails, AutoBill, Description, etc. may be used when CreateProfile or UpdateProfile is called. These properties will be populated when GetProfile is called. The profiles are identified to PayPal by their ProfileId, which is assigned by PayPal when the profile is created.

When creating a profile, you may use a credit card or a billing agreement that was previously created using the ExpressCheckout component. For more information on creating a new profile, see CreateProfile.

Other operations that may be performed on recurring payments profiles are CancelProfile, ReactivateProfile, SuspendProfile, and BillOutstandingAmount.

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.
AdditionalBillingCycles	The number of additional billing cycles for PayPal to add to the current profile.
AutoBill	Whether PayPal should automatically bill the outstanding balance in the next billing cycle.
BillingAmount	The amount to be billed for each billing cycle.
BillingCurrencyCode	Type of currency in which you are accepting payments.
BillingFrequency	The number of billing periods that make up one billing cycle.
BillingPeriod	This property contains the unit for billing during the billing cycle.
BillingShippingAmount	The shipping amount associated with each billing cycle.
BillingStartDate	Set this property to the date at which billing should begin for the current profile.
BillingTaxAmount	The tax amount associated with each billing cycle.
BillingTotalCycles	The number of billing cycles for the payment period.
CardType	This property specifies the type of the credit card specified in Number .
CardCVV	Three digit security code on back of card (optional).
CardExpMonth	This property contains the expiration month of the customer's credit card.
CardExpYear	This property contains the 4 digit expiration year of the customer's credit card.
CardNumber	This property contains the customer's credit card number for this transaction.
CollectedAmount	The total current collected amount.
CyclesCompleted	The number of completed billing cycles.
CyclesRemaining	The number of remaining billing cycles.
Description	The recurring payment description.
FailedInitialAmountAction	The action to take when the initial amount is not paid.
FailedPaymentCount	Number of failed payments.
FinalPaymentDueDate	Due date of the last scheduled payment.
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.
InitialAmount	The amount due at the creation of the profile.
LastPaymentAmount	The last payment amount received from this profile.
LastPaymentDate	The date of the last received payment from this profile.
MaxFailedPayments	The max number of failed payments.
NextBillingDate	The next billing date.
Note	The reason for the current action.
OutstandingBalance	The outstanding balance of the profile.
Password	Password for communicating with PayPal.
PayerBusiness	Payer's business email address.
PayerCity	Payer's city name.
PayerCountryCode	Payer's country code.
PayerEmail	Email address of the payer.
PayerFirstName	Payer's first name.
PayerId	Unique encrypted PayPal customer account number.
PayerLastName	Payer's last name.
PayerMiddleName	Payer's middle name.
PayerPhoneNumber	The buyer's phone number.
PayerSalutation	Payer's salutation.
PayerState	Payer's state or province name.
PayerStatus	Indicates whether the payer is verified or not.
PayerStreet1	Payer's street address (first line).
PayerStreet2	Payer's street address (second line).
PayerSuffix	Payer's name suffix.
PayerZip	Payer's United States ZIP code or other country-specific postal code.
ProfileId	The id of the profile.
ProfileReferenceId	The merchant's reference id.
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.
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).
Status	The status of the profile.
SubscriberName	Name of the subscriber.
Timeout	A timeout for the component.
Token	This property is used to reference a specific Express Checkout transaction in the PayPal network.
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.


AddCustomField	Adds a custom name-value pair to be sent with the next request.
BillOutstandingAmount	This method will bill the outstanding amount.
CancelProfile	This will cancel the profile.
Config	Sets or retrieves a configuration setting .
CreateProfile	This method creates a new recurring payments profile.
DoEvents	Processes events from the internal message queue.
GetProfile	This method returns the requested profile.
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.
ReactivateProfile	This will reactivate the profile.
Reset	Reset the internal state of the component and all properties to their default values.
SuspendProfile	This will suspend the profile.
UpdateProfile	This method updates the specified profile.

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.

Configuration Settings

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


AddressStatus	Status of the street address associated with the profile.
IssueNumber	Issue number of Maestro or Solo card.
OptionalCollectedAmount	The total current collected amount for optional payments.
ShipToCity	Payer's shipping city.
ShipToCountryCode	Payer's shipping country code.
ShipToName	Payer's shipping name.
ShipToPayerAddress	Shipping address same as billing address.
ShipToPhoneNumber	Payer's shipping phone number.
ShipToState	Payer's shipping state.
ShipToStreet	First line of the payer's shipping street address.
ShipToStreet2	Second line of the payer's shipping street address.
ShipToZip	Payer's shipping postal code.
StartMonth	Month that Maestro or Solo card was issued.
StartYear	Year that Maestro or Solo card was issued.
TrialBillingAmount	The amount to be billed per billing cycle in the trial period.
TrialBillingFrequency	The number of billing periods that make up a billing cycle in the trial period.
TrialBillingPeriod	The unit of billing during the billing cycle in the trial period.
TrialBillingTotalCycles	The number of billing cycles in the trial period.
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.