PHP Class PayPal\PayPalAPI\MassPayRequestItemType

Inheritance: extends PayPal\Core\PPXmlMessage
Mostra file Open project: paypal/merchant-sdk-php

Public Properties

Property Type Description
$Amount PayPal\CoreComponentTypes\BasicAmountType Payment amount. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Required You cannot mix currencies in a single MassPayRequest. A single request must include items that are of the same currency.
$Note string Custom note for each recipient. Optional Character length and limitations: 4,000 single-byte alphanumeric characters
$ReceiverEmail string Email address of recipient. Required You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients. Character length and limitations: 127 single-byte characters maximum.
$ReceiverID string Unique PayPal customer account number. This value corresponds to the value of PayerID returned by GetTransactionDetails. Required You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients. Character length and limitations: 17 single-byte characters maximum.
$ReceiverPhone string Phone number of recipient. Required You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients.
$UniqueId string Transaction-specific identification number for tracking in an accounting system. Optional Character length and limitations: 30 single-byte characters. No whitespace allowed.

Public Methods

Method Description
__construct ( $Amount = null ) Constructor with arguments

Method Details

__construct() public method

Constructor with arguments
public __construct ( $Amount = null )

Property Details

$Amount public_oe property

Payment amount. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Required You cannot mix currencies in a single MassPayRequest. A single request must include items that are of the same currency.
public BasicAmountType,PayPal\CoreComponentTypes $Amount
return PayPal\CoreComponentTypes\BasicAmountType

$Note public_oe property

Custom note for each recipient. Optional Character length and limitations: 4,000 single-byte alphanumeric characters
public string $Note
return string

$ReceiverEmail public_oe property

Email address of recipient. Required You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients. Character length and limitations: 127 single-byte characters maximum.
public string $ReceiverEmail
return string

$ReceiverID public_oe property

Unique PayPal customer account number. This value corresponds to the value of PayerID returned by GetTransactionDetails. Required You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients. Character length and limitations: 17 single-byte characters maximum.
public string $ReceiverID
return string

$ReceiverPhone public_oe property

Phone number of recipient. Required You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients.
public string $ReceiverPhone
return string

$UniqueId public_oe property

Transaction-specific identification number for tracking in an accounting system. Optional Character length and limitations: 30 single-byte characters. No whitespace allowed.
public string $UniqueId
return string