MassPay API Operation (SOAP)
Last updated: Sept 18th, 6:47pm
Important: NVP/SOAP is a legacy integration method. We still provide support, but a newer version of these solutions exists. If you're starting a new integration, we recommend using our JavaScript SDK or Payouts REST API.
Makes a payment to one or more PayPal account holders.
MassPay Request Message
MassPay Request Fields
|
Field |
Description |
|---|---|
|
|
(Optional) The subject line of the email that PayPal sends when the transaction completes. The subject line is the same for all recipients. Character length and limitations: 255 single-byte alphanumeric characters |
|
(Required) Details of each payment. Note: A single MassPayRequest can include up to 250 MassPayItems. See MassPayItem type below for a list of fields that you repeat for each recipient. |
|
|
|
(Optional) How you identify the recipients of payments in this call to
Note: In the sandbox environment, PhoneNumber is not supported. |
MassPayItem Type
|
Field |
Description |
|---|---|
|
|
(See note) Email address of recipient. Note: You must specify either ReceiverEmail, ReceiverPhone, or ReceiverID depending on the value passed for ReceiverType, and all MassPay items in a single request must use the same field to identify recipients.Character length and limitations: 127 single-byte characters maximum. |
|
|
(See note) Phone number of recipient. Note: You must specify either ReceiverEmail, ReceiverPhone, or ReceiverID depending on the value passed for ReceiverType, and all MassPay items in a single request must use the same field to identify recipients. |
|
|
(See note) Unique PayPal customer account number. This value corresponds to the value of Note: You must specify either ReceiverEmail, ReceiverPhone, or ReceiverID depending on the value passed for ReceiverType, and all MassPay items in a single request must use the same field to identify recipients.Character length and limitations: 17 single-byte characters maximum. |
|
|
(Required) Payment amount. You must set the Note: You cannot mix currencies in a single MassPay request. A single request must include items that are of the same currency. |
|
|
(Optional) Transaction-specific identification number for tracking in an accounting system. Character length and limitations: 30 single-byte characters. No whitespace allowed. |
|
|
(Optional) Custom note for each recipient. Character length and limitations: 4000 single-byte alphanumeric characters |
MassPay Response Message
Note: Only the fields described in this documentation are available for use.
MassPay Response Fields
The elements returned are the same as for AbstractResponseType.