MassPay API Operation (SOAP)

Makes a payment to one or more PayPal account holders.

MassPay Request Message

MassPay Request Fields

Field

Description

EmailSubject

xs:string

(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

MassPayItem

ebl:MassPayItemType

(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.

ReceiverType

ebl:ReceiverInfoCodeType

(Optional) How you identify the recipients of payments in this call to MassPay. Applies to all recipients. Value is:


  • EmailAddress

  • UserID

  • PhoneNumber

Note: In the Sandbox environment, PhoneNumber is not supported.

MassPayItem Type

Field

Description

ReceiverEmail

ebl:EmailAddressType

(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.

ReceiverPhone

xs:string

(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.

ReceiverID

ebl:UserIDType

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

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.

Amount

cc:BasicAmountType

(Required) Payment amount. You must set the currencyID 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.

UniqueId

xs:string

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

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

Note

xs:string

(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.

Additional information