PHP Class PayPal\Api\Incentive

A resource representing a incentive.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getCode ( ) : string Code that identifies the incentive.
getDescription ( ) : string Description of the incentive.
getExpiryDate ( ) : string expiry date of the incentive.
getId ( ) : string Identifier of the instrument in PayPal Wallet
getLogoImageUrl ( ) : string Logo image url for the incentive.
getMinimumPurchaseAmount ( ) : PayPal\Api\Currency Indicates incentive is applicable for this minimum purchase amount.
getName ( ) : string Name of the incentive.
getTerms ( ) : string URI to the associated terms
getType ( ) : string Specifies type of incentive
setCode ( string $code ) Code that identifies the incentive.
setDescription ( string $description ) Description of the incentive.
setExpiryDate ( string $expiry_date ) expiry date of the incentive.
setId ( string $id ) Identifier of the instrument in PayPal Wallet
setLogoImageUrl ( string $logo_image_url ) Logo image url for the incentive.
setMinimumPurchaseAmount ( PayPal\Api\Currency $minimum_purchase_amount ) Indicates incentive is applicable for this minimum purchase amount.
setName ( string $name ) Name of the incentive.
setTerms ( string $terms ) URI to the associated terms
setType ( string $type ) Specifies type of incentive Valid Values: ["COUPON", "GIFT_CARD", "MERCHANT_SPECIFIC_BALANCE", "VOUCHER"]

Method Details

getCode() public method

Code that identifies the incentive.
public getCode ( ) : string
return string

getDescription() public method

Description of the incentive.
public getDescription ( ) : string
return string

getExpiryDate() public method

expiry date of the incentive.
public getExpiryDate ( ) : string
return string

getId() public method

Identifier of the instrument in PayPal Wallet
public getId ( ) : string
return string

getLogoImageUrl() public method

Logo image url for the incentive.
public getLogoImageUrl ( ) : string
return string

getMinimumPurchaseAmount() public method

Indicates incentive is applicable for this minimum purchase amount.
public getMinimumPurchaseAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getName() public method

Name of the incentive.
public getName ( ) : string
return string

getTerms() public method

URI to the associated terms
public getTerms ( ) : string
return string

getType() public method

Specifies type of incentive
public getType ( ) : string
return string

setCode() public method

Code that identifies the incentive.
public setCode ( string $code )
$code string

setDescription() public method

Description of the incentive.
public setDescription ( string $description )
$description string

setExpiryDate() public method

expiry date of the incentive.
public setExpiryDate ( string $expiry_date )
$expiry_date string

setId() public method

Identifier of the instrument in PayPal Wallet
public setId ( string $id )
$id string

setLogoImageUrl() public method

Logo image url for the incentive.
public setLogoImageUrl ( string $logo_image_url )
$logo_image_url string

setMinimumPurchaseAmount() public method

Indicates incentive is applicable for this minimum purchase amount.
public setMinimumPurchaseAmount ( PayPal\Api\Currency $minimum_purchase_amount )
$minimum_purchase_amount PayPal\Api\Currency

setName() public method

Name of the incentive.
public setName ( string $name )
$name string

setTerms() public method

URI to the associated terms
public setTerms ( string $terms )
$terms string

setType() public method

Specifies type of incentive Valid Values: ["COUPON", "GIFT_CARD", "MERCHANT_SPECIFIC_BALANCE", "VOUCHER"]
public setType ( string $type )
$type string