PayPal Integrator MassPay Component : MassPay OCX, MassPay .NET Component, MassPay Class, MassPay Bean, MassPay Object

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The MassPay component is the programmatic counterpart to the Mass Payment feature available through the PayPal website for merchants who make payments. You can use this component to pay just one recipient, up to a total of 250 recipients. The following example illustrates how to send a payment:

component.TransactionCount  = 1
component.RecipientEmail(0) = "testseller@test.com"
component.Amount(0)         = "14.95"
component.CurrencyCode(0)   = "USD"
component.Note(0)           = "Please send me size XL."
component.TransactionId(0)  = "55256342"
component.SendMassPayment()
debug.print component.Ack

The MassPay component has the following restrictions:

You can process up to 250 payments in a single SendMassPayment
You cannot mix currencies in a single mass payment. You must send separate requests for different currencies.
You must have enough funds in your PayPal account to cover the entire Mass Payment amount, plus the fee.
You must have a balance in your PayPal account in the currency indicated by the CurrencyCode property.
Use of the Mass Pay API triggers the sending of an Instant Payment Notification email to each recipient specified by RecipientEmail.
At present, the Mass Pay API is available only if you have a US merchant account.

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.
CurrencyCode	Type of currency you're paying with.
EmailSubject	Subject for the email sent to recipients.
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.
Password	Password for communicating with PayPal.
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 SSL certificate (PEM/base64 encoded).
SSLCertEncoded	The SSL 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 SSL certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
TransactionCount	The number of records in the Transaction arrays.
TransactionAmount	Amount to be sent to each recipient.
TransactionNote	Optional note for each recipient.
TransactionRecipientEmail	Email address of each recipient.
TransactionId	Optional merchant tracking number.
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	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.
Interrupt	Interrupt the current method.
LoadInputFile	Load mass payment file.
Reset	Reset the internal state of the component and all properties to their default values.
SendMassPayment	Request to distribute payments to multiple recipients.

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.


AuthorizingAccount	Authorizing Account Email Address for third-party API access.
Build	Returns the Build number contained in the response.
Request	Returns the raw request sent to the server.
Response	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.
SendReceiverIds	Treats RecipientEmail addresses as Receiver Id's instead.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
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.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseWinInet	If set, the WinInet API is used for retrieving the URL.
UseWinInetCookies	Controls whether to send and accept cookies when making HTTP requests through WinInet.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
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).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
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.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|