Search: 
Available in: PAYPAL
MassPay Component [PayPal Integrator V3]

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 further details.

AckAcknowledgement code received from PayPal.
CurrencyCodeType of currency you're paying with.
EmailSubjectSubject for the email sent to recipients.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
PasswordPassword for communicating with PayPal.
ProxyA set of properties related to proxy access.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TransactionsThe transactions in the mass payment.
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 component with short descriptions. Click on the links for further details.

AddCustomFieldThis adds a custom name-value pair to be sent with the next request.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
LoadInputFileLoad mass payment file.
ResetReset the internal state of the component and all properties to their default values.
SendMassPaymentRequest 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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

AuthorizingAccountAuthorizing Account Email Address for third-party API access
BuildReturns the Build number contained in the response
RequestReturns the raw request sent to the server
ResponseReturns the full response
ResponseVersionReturns the Version number contained in the response
VersionAllows the user to set the Version number in the request
SendCustomRequestSends a custom request to the server
SendReceiverIdsTreats RecipientEmail addresses as Receiver Id's instead
AcceptEncodingUsed to tell the server which types of content encodings the client supports
AllowHTTPCompressionThis property enables HTTP compression for receiving data
AuthorizationThe Authorization string to be sent to the server
EncodeURLIf set to true the URL will be encoded by the component
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
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
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
UsePlatformHTTPClientWhether or not to use the platform HTTP client
UserAgentInformation about the user agent (browser)
UseWinInetIf set, the WinInet API is used for retrieving the URL
UseWinInetCookiesControls whether to send and accept cookies when making HTTP requests through WinInet
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
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
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only)

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.