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 InputFields

Class InputFields

Parameters for input fields customization.

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

Methods summary

public
# setAllowNote( boolean $allow_note )

Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.

Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.

Parameters

$allow_note

Returns


$this
public boolean
# getAllowNote( )

Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.

Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.

Returns

boolean
public
# 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.

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.

Parameters

$no_shipping

Returns


$this
public integer
# getNoShipping( )

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.

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.

Returns

integer
public
# 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.

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.

Parameters

$address_override

Returns


$this
public integer
# getAddressOverride( )

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.

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.

Returns

integer

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