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 Payer

Class Payer

A resource representing a Payer that funds a payment.

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

Methods summary

public
# setPaymentMethod( string $payment_method )

Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card. Valid Values: ["credit_card", "bank", "paypal", "pay_upon_invoice", "carrier", "alternate_payment"]

Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card. Valid Values: ["credit_card", "bank", "paypal", "pay_upon_invoice", "carrier", "alternate_payment"]

Parameters

$payment_method

Returns


$this
public string
# getPaymentMethod( )

Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.

Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.

Returns

string
public
# setStatus( string $status )

Status of payer's PayPal Account. Valid Values: ["VERIFIED", "UNVERIFIED"]

Status of payer's PayPal Account. Valid Values: ["VERIFIED", "UNVERIFIED"]

Parameters

$status

Returns


$this
public string
# getStatus( )

Status of payer's PayPal Account.

Status of payer's PayPal Account.

Returns

string
public
# setAccountType( string $account_type )

Type of account relationship payer has with PayPal. Valid Values: ["BUSINESS", "PERSONAL", "PREMIER"]

Type of account relationship payer has with PayPal. Valid Values: ["BUSINESS", "PERSONAL", "PREMIER"]

Deprecated

Not publicly available

Parameters

$account_type

Returns


$this
public string
# getAccountType( )

Type of account relationship payer has with PayPal.

Type of account relationship payer has with PayPal.

Deprecated

Not publicly available

Returns

string
public
# setAccountAge( string $account_age )

Duration since the payer established account relationship with PayPal in days.

Duration since the payer established account relationship with PayPal in days.

Deprecated

Not publicly available

Parameters

$account_age

Returns


$this
public string
# getAccountAge( )

Duration since the payer established account relationship with PayPal in days.

Duration since the payer established account relationship with PayPal in days.

Deprecated

Not publicly available

Returns

string
public
# setFundingInstruments( PayPal\Api\FundingInstrument[] $funding_instruments )

List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

Parameters

$funding_instruments

Returns


$this
public PayPal\Api\FundingInstrument[]
# getFundingInstruments( )

List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

Returns

PayPal\Api\FundingInstrument[]
public
# addFundingInstrument( PayPal\Api\FundingInstrument $fundingInstrument )

Append FundingInstruments to the list.

Append FundingInstruments to the list.

Parameters

$fundingInstrument

Returns


$this
public
# removeFundingInstrument( PayPal\Api\FundingInstrument $fundingInstrument )

Remove FundingInstruments from the list.

Remove FundingInstruments from the list.

Parameters

$fundingInstrument

Returns


$this
public
# setFundingOptionId( string $funding_option_id )

Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

Deprecated

Not publicly available

Parameters

$funding_option_id

Returns


$this
public string
# getFundingOptionId( )

Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.

Deprecated

Not publicly available

Returns

string
public
# setFundingOption( PayPal\Api\FundingOption $funding_option )

Default funding option available for the payment

Default funding option available for the payment

Deprecated

Not publicly available

Parameters

$funding_option

Returns


$this
public PayPal\Api\FundingOption
# getFundingOption( )

Default funding option available for the payment

Default funding option available for the payment

Deprecated

Not publicly available

Returns

PayPal\Api\FundingOption
public
# setExternalSelectedFundingInstrumentType( string $external_selected_funding_instrument_type )

Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button Valid Values: ["CREDIT", "PAY_UPON_INVOICE"]

Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button Valid Values: ["CREDIT", "PAY_UPON_INVOICE"]

Parameters

$external_selected_funding_instrument_type

Returns


$this
public string
# getExternalSelectedFundingInstrumentType( )

Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button

Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button

Returns

string
public
# setRelatedFundingOption( PayPal\Api\FundingOption $related_funding_option )

Funding option related to default funding option.

Funding option related to default funding option.

Deprecated

Not publicly available

Parameters

$related_funding_option

Returns


$this
public PayPal\Api\FundingOption
# getRelatedFundingOption( )

Funding option related to default funding option.

Funding option related to default funding option.

Deprecated

Not publicly available

Returns

PayPal\Api\FundingOption
public
# setPayerInfo( PayPal\Api\PayerInfo $payer_info )

Information related to the Payer.

Information related to the Payer.

Parameters

$payer_info

Returns


$this
public PayPal\Api\PayerInfo
# getPayerInfo( )

Information related to the Payer.

Information related to the Payer.

Returns

PayPal\Api\PayerInfo

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