2009
Table Of Contents
- Name-Value Pair API Developer Guide
- Preface
- This Document
- Intended Audience
- Revision History
- PayPal NVP API Overview
- Authorization and Capture API Operation Reference
- DoDirectPayment API
- Express Checkout API Operations
- GetTransactionDetails API
- MassPay API
- RefundTransaction API
- TransactionSearch API
- Recurring Payments and Reference Transactions API Operations
- DoNonReferencedCredit API
- ManagePendingTransactionStatu s API
- GetBalance API
- AddressVerify API
- API Error Codes
- General API Errors
- Validation Errors
- Direct Payment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- Mass Pay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Country Codes
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
MassPay API
MassPay Request
86 08 April 2009 Name-Value Pair API Developer Guide
MassPay Request Fields
MassPay Item Type Fields
Field Description
METHOD (Required) Must be MassPay.
EMAILSUBJECT (Optional) The subject line of the email that PayPal sends when the transaction is
completed. The subject line is the same for all recipients.
Character length and limitations: 255 single-byte alphanumeric characters.
CURRENCYCODE A three-character currency code. See “Currency Codes” on page 239.
RECEIVERTYPE (Optional) Indicates how you identify the recipients of payments in this call to
MassPay.
Must be EmailAddress or UserID
Field Description
L_EMAILn (See description) Email address of recipient.
NOTE: You must specify either L_EMAILn or L_RECEIVERIDn, but you must not
mix the two in the group of MassPay items. Use only one or the other, but not
both, in a single request.
These parameters must be ordered sequentially beginning with 0 (for example
L_EMAIL0, L_EMAIL1).
Character length and limitations: 127 single-byte characters maximum.
L_RECEIVERIDn (See description) Unique PayPal customer account number. This value corresponds to
the value of PayerID returned by GetTransactionDetails.
NOTE: You must specify either L_EMAILn or L_RECEIVERIDn, but you must not
mix the two in the group of MassPay items. Use only one or the other, but not
both, in a single request.
These parameters must be ordered sequentially beginning with 0 (for example
L_RECEIVERID0, L_RECEIVERID1).
Character length and limitations: 17 single-byte characters maximum.
L_AMTn (Required) Payment amount.
These parameters must be ordered sequentially beginning with 0 (for example
L_AMT0, L_AMT1).
NOTE: You cannot mix currencies in a single MassPayRequest. A single request
must include items that are of the same currency.
L_UNIQUEIDn (Optional) Transaction-specific identification number for tracking in an accounting
system.
These parameters must be ordered sequentially beginning with 0 (for example
L_UNIQUEID0, L_UNIQUEID1).
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.