MassPay API Operation (SOAP)

API

Last updated: Sept 18th, 6:47pm

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.

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

MassPayItem Type

Field

Description

ReceiverEmail

ebl:EmailAddressType

(See note) Email address of recipient.

Character length and limitations: 127 single-byte characters maximum.

ReceiverPhone

xs:string

(See note) Phone number of recipient.

ReceiverID

ebl:UserIDType

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

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.

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

MassPay Response Fields

The elements returned are the same as for AbstractResponseType.

Additional information