/n software PayPal masspay Component : masspay OCX, masspay .NET Component, masspay Class, masspay Bean, masspay Object

Available in: PAYPAL

MassPay Component [IBiz PayPal Integrator V2]

Properties Methods Events Configuration Settings

The MassPay component is used to pay multiple recipients with funds from a PayPal account.

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 complete descriptions.


Ack	Acknowledgement code received from PayPal.
Amount	Amount to be sent to each recipient.
CurrencyCode	Type of currency you're paying with.
EmailSubject	Subject for the email sent to recipients.
Note	Optional note for each recipient.
Password	Password for communicating with PayPal.
RecipientEmail	Email address of each recipient.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
Signature	Value to use with PayPal's Signature Authentication scheme.
Timeout	A timeout for the component.
TransactionCount	Number of transactions in the mass payment.
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 complete descriptions.


Config	Sets or retrieves a component configuration setting.
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 complete descriptions.


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 complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AuthorizingAccount	Authorizing Account Email Address for third-party API access.
Build	Returns the Build number contained in the response.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FaultCode	Returns the SOAP fault code, if any.
FaultString	Returns the error message associated with the SOAP fault code.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
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).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic 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 Basic authentication is to be used for the proxy.
ResponseVersion	Returns the Version number contained in the response.
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
SendReceiverIds	Treats addresses as Receiver Id's instead.
SocketHandle	The handle of the main socket used by the component.
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
UserAgent	Information about the user agent (browser).
Version	Allows the user to set the Version number in the request.
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)