PHP Class PayPal\Api\InputFields

Parameters for input fields customization.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getAddressOverride ( ) : integer Indicates whether to display the shipping address that is passed to this call rather than the one on file with PayPal for this buyer on the PayPal experience pages. Valid value is 0 or 1. Set to 0 to display the shipping address on file. Set to 1 to display the shipping address supplied to this call; the buyer cannot edit this shipping address.
getAllowNote ( ) : boolean Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.
getNoShipping ( ) : integer Indicates whether PayPal displays shipping address fields on the experience pages. Valid value is 0, 1, or 2. Set to 0 to display the shipping address on the PayPal pages. Set to 1 to redact shipping address fields from the PayPal pages. Set to 2 to not pass the shipping address but instead get it from the buyer's account profile. For digital goods, this field is required and value must be 1.
setAddressOverride ( integer $address_override ) Indicates whether to display the shipping address that is passed to this call rather than the one on file with PayPal for this buyer on the PayPal experience pages. Valid value is 0 or 1. Set to 0 to display the shipping address on file. Set to 1 to display the shipping address supplied to this call; the buyer cannot edit this shipping address.
setAllowNote ( boolean $allow_note ) Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.
setNoShipping ( integer $no_shipping ) Indicates whether PayPal displays shipping address fields on the experience pages. Valid value is 0, 1, or 2. Set to 0 to display the shipping address on the PayPal pages. Set to 1 to redact shipping address fields from the PayPal pages. Set to 2 to not pass the shipping address but instead get it from the buyer's account profile. For digital goods, this field is required and value must be 1.

Method Details

getAddressOverride() public method

Indicates whether to display the shipping address that is passed to this call rather than the one on file with PayPal for this buyer on the PayPal experience pages. Valid value is 0 or 1. Set to 0 to display the shipping address on file. Set to 1 to display the shipping address supplied to this call; the buyer cannot edit this shipping address.
public getAddressOverride ( ) : integer
return integer

getAllowNote() public method

Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.
public getAllowNote ( ) : boolean
return boolean

getNoShipping() public method

Indicates whether PayPal displays shipping address fields on the experience pages. Valid value is 0, 1, or 2. Set to 0 to display the shipping address on the PayPal pages. Set to 1 to redact shipping address fields from the PayPal pages. Set to 2 to not pass the shipping address but instead get it from the buyer's account profile. For digital goods, this field is required and value must be 1.
public getNoShipping ( ) : integer
return integer

setAddressOverride() public method

Indicates whether to display the shipping address that is passed to this call rather than the one on file with PayPal for this buyer on the PayPal experience pages. Valid value is 0 or 1. Set to 0 to display the shipping address on file. Set to 1 to display the shipping address supplied to this call; the buyer cannot edit this shipping address.
public setAddressOverride ( integer $address_override )
$address_override integer

setAllowNote() public method

Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.
public setAllowNote ( boolean $allow_note )
$allow_note boolean

setNoShipping() public method

Indicates whether PayPal displays shipping address fields on the experience pages. Valid value is 0, 1, or 2. Set to 0 to display the shipping address on the PayPal pages. Set to 1 to redact shipping address fields from the PayPal pages. Set to 2 to not pass the shipping address but instead get it from the buyer's account profile. For digital goods, this field is required and value must be 1.
public setNoShipping ( integer $no_shipping )
$no_shipping integer