MassPay API Operation (NVP)

The MassPay API operation makes a payment to one or more PayPal account holders.

MassPay Request Message

MassPay Request Fields

Field

Description

METHOD

(Required) Must be MassPay.

EMAILSUBJECT

(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

CURRENCYCODE

(Required) Currency code.

Character length and limitations: 3 single-byte characters

Set the CURRENCYCODE attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Note You cannot mix currencies in a single MassPay request. A single request must include items that are of the same currency.

RECEIVERTYPE

(Optional) How you identify the recipients of payments in this call to MassPay. It is one of the following values:

  • EmailAddress

  • UserID

  • PhoneNumber

It is the same for all recipients.

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.

MassPayItem Type

Field

Description

L_EMAILn

(See note) Email address of recipient.

Note You must specify either L_EMAILn, L_RECEIVERPHONEn, or L_RECEIVERIDndepending 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.

L_RECEIVERPHONEn

(See note) Phone number of recipient.

Note You must specify either L_EMAILn, L_RECEIVERPHONEn, or L_RECEIVERIDndepending on the value passed for RECEIVERTYPE, and all MassPay items in a single request must use the same field to identify recipients.

L_RECEIVERIDn

(See note) Unique PayPal customer account number. This value corresponds to the value of PAYERID returned by GetTransactionDetails.

Note You must specify either L_EMAILn, L_RECEIVERPHONEn, or L_RECEIVERIDndepending 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.

L_AMTn

(Required) Payment amount.

L_UNIQUEIDn

(Optional) Transaction-specific identification number for tracking in an accounting system.

Character length and limitations: 30 single-byte characters. No whitespace allowed.

L_NOTEn

(Optional) Custom note for each recipient.

Character length and limitations: 4,000 single-byte alphanumeric characters

MassPay Response Message

MassPay Response Fields

The fields in the response are the standard response header fields.