Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

  • Address
  • Agreement
  • AgreementDetails
  • AgreementStateDescriptor
  • AgreementTransaction
  • AgreementTransactions
  • AlternatePayment
  • Amount
  • Authorization
  • BankAccount
  • BankAccountsList
  • BankToken
  • BaseAddress
  • Billing
  • BillingAgreementToken
  • BillingInfo
  • CancelNotification
  • Capture
  • CarrierAccount
  • CarrierAccountToken
  • CartBase
  • ChargeModel
  • Cost
  • CountryCode
  • CreateProfileResponse
  • Credit
  • CreditCard
  • CreditCardHistory
  • CreditCardList
  • CreditCardToken
  • CreditFinancingOffered
  • Currency
  • CurrencyConversion
  • CustomAmount
  • DetailedRefund
  • Details
  • Error
  • ErrorDetails
  • ExtendedBankAccount
  • ExternalFunding
  • FileAttachment
  • FlowConfig
  • FmfDetails
  • FundingDetail
  • FundingInstrument
  • FundingOption
  • FundingSource
  • FuturePayment
  • HyperSchema
  • Image
  • Incentive
  • InputFields
  • InstallmentInfo
  • InstallmentOption
  • Invoice
  • InvoiceAddress
  • InvoiceItem
  • InvoiceNumber
  • InvoiceSearchResponse
  • Item
  • ItemList
  • Links
  • Measurement
  • MerchantInfo
  • MerchantPreferences
  • Metadata
  • NameValuePair
  • Notification
  • OpenIdAddress
  • OpenIdError
  • OpenIdSession
  • OpenIdTokeninfo
  • OpenIdUserinfo
  • Order
  • OverrideChargeModel
  • Participant
  • Patch
  • PatchRequest
  • Payee
  • Payer
  • PayerInfo
  • Payment
  • PaymentCard
  • PaymentCardToken
  • PaymentDefinition
  • PaymentDetail
  • PaymentExecution
  • PaymentHistory
  • PaymentInstruction
  • PaymentOptions
  • PaymentSummary
  • PaymentTerm
  • Payout
  • PayoutBatch
  • PayoutBatchHeader
  • PayoutItem
  • PayoutItemDetails
  • PayoutSenderBatchHeader
  • Phone
  • Plan
  • PlanList
  • PotentialPayerInfo
  • Presentation
  • PrivateLabelCard
  • ProcessorResponse
  • RecipientBankingInstruction
  • RedirectUrls
  • Refund
  • RefundDetail
  • RefundRequest
  • RelatedResources
  • Sale
  • Search
  • ShippingAddress
  • ShippingCost
  • ShippingInfo
  • Tax
  • Template
  • TemplateData
  • Templates
  • TemplateSettings
  • TemplateSettingsMetadata
  • Terms
  • Transaction
  • TransactionBase
  • Transactions
  • VerifyWebhookSignature
  • VerifyWebhookSignatureResponse
  • Webhook
  • WebhookEvent
  • WebhookEventList
  • WebhookEventType
  • WebhookEventTypeList
  • WebhookList
  • WebProfile

Class Incentive

Class Incentive

A resource representing a incentive.

PayPal\Common\PayPalModel
Extended by PayPal\Api\Incentive
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Incentive.php

Methods summary

public
# setId( string $id )

Identifier of the instrument in PayPal Wallet

Identifier of the instrument in PayPal Wallet

Parameters

$id

Returns


$this
public string
# getId( )

Identifier of the instrument in PayPal Wallet

Identifier of the instrument in PayPal Wallet

Returns

string
public
# setCode( string $code )

Code that identifies the incentive.

Code that identifies the incentive.

Parameters

$code

Returns


$this
public string
# getCode( )

Code that identifies the incentive.

Code that identifies the incentive.

Returns

string
public
# setName( string $name )

Name of the incentive.

Name of the incentive.

Parameters

$name

Returns


$this
public string
# getName( )

Name of the incentive.

Name of the incentive.

Returns

string
public
# setDescription( string $description )

Description of the incentive.

Description of the incentive.

Parameters

$description

Returns


$this
public string
# getDescription( )

Description of the incentive.

Description of the incentive.

Returns

string
public
# setMinimumPurchaseAmount( PayPal\Api\Currency $minimum_purchase_amount )

Indicates incentive is applicable for this minimum purchase amount.

Indicates incentive is applicable for this minimum purchase amount.

Parameters

$minimum_purchase_amount

Returns


$this
public PayPal\Api\Currency
# getMinimumPurchaseAmount( )

Indicates incentive is applicable for this minimum purchase amount.

Indicates incentive is applicable for this minimum purchase amount.

Returns

PayPal\Api\Currency
public
# setLogoImageUrl( string $logo_image_url )

Logo image url for the incentive.

Logo image url for the incentive.

Parameters

$logo_image_url

Returns


$this

Throws

InvalidArgumentException
public string
# getLogoImageUrl( )

Logo image url for the incentive.

Logo image url for the incentive.

Returns

string
public
# setExpiryDate( string $expiry_date )

expiry date of the incentive.

expiry date of the incentive.

Parameters

$expiry_date

Returns


$this
public string
# getExpiryDate( )

expiry date of the incentive.

expiry date of the incentive.

Returns

string
public
# setType( string $type )

Specifies type of incentive Valid Values: ["COUPON", "GIFT_CARD", "MERCHANT_SPECIFIC_BALANCE", "VOUCHER"]

Specifies type of incentive Valid Values: ["COUPON", "GIFT_CARD", "MERCHANT_SPECIFIC_BALANCE", "VOUCHER"]

Parameters

$type

Returns


$this
public string
# getType( )

Specifies type of incentive

Specifies type of incentive

Returns

string
public
# setTerms( string $terms )

URI to the associated terms

URI to the associated terms

Parameters

$terms

Returns


$this
public string
# getTerms( )

URI to the associated terms

URI to the associated terms

Returns

string

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

API documentation generated by ApiGen