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 PayerInfo

Class PayerInfo

A resource representing a information about Payer.

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

Methods summary

public
# setEmail( string $email )

Email address representing the payer. 127 characters max.

Email address representing the payer. 127 characters max.

Parameters

$email

Returns


$this
public string
# getEmail( )

Email address representing the payer. 127 characters max.

Email address representing the payer. 127 characters max.

Returns

string
public
# setExternalRememberMeId( string $external_remember_me_id )

External Remember Me id representing the payer

External Remember Me id representing the payer

Parameters

$external_remember_me_id

Returns


$this
public string
# getExternalRememberMeId( )

External Remember Me id representing the payer

External Remember Me id representing the payer

Returns

string
public
# setAccountNumber( string $account_number )

Account Number representing the Payer

Account Number representing the Payer

Deprecated

Use #setBuyerAccountNumberInstead

Parameters

$account_number

Returns


$this
public string
# getAccountNumber( )

Account Number representing the Payer

Account Number representing the Payer

Deprecated

Use #getBuyerAccountNumberInstead
Not publicly available

Returns

string
public
# setBuyerAccountNumber( string $buyer_account_number )

Account Number representing the Payer

Account Number representing the Payer

Parameters

$buyer_account_number

Returns


$this
public string
# getBuyerAccountNumber( )

Account Number representing the Payer

Account Number representing the Payer

Returns

string
public
# setSalutation( string $salutation )

Salutation of the payer.

Salutation of the payer.

Parameters

$salutation

Returns


$this
public string
# getSalutation( )

Salutation of the payer.

Salutation of the payer.

Returns

string
public
# setFirstName( string $first_name )

First name of the payer.

First name of the payer.

Parameters

$first_name

Returns


$this
public string
# getFirstName( )

First name of the payer.

First name of the payer.

Returns

string
public
# setMiddleName( string $middle_name )

Middle name of the payer.

Middle name of the payer.

Parameters

$middle_name

Returns


$this
public string
# getMiddleName( )

Middle name of the payer.

Middle name of the payer.

Returns

string
public
# setLastName( string $last_name )

Last name of the payer.

Last name of the payer.

Parameters

$last_name

Returns


$this
public string
# getLastName( )

Last name of the payer.

Last name of the payer.

Returns

string
public
# setSuffix( string $suffix )

Suffix of the payer.

Suffix of the payer.

Parameters

$suffix

Returns


$this
public string
# getSuffix( )

Suffix of the payer.

Suffix of the payer.

Returns

string
public
# setPayerId( string $payer_id )

PayPal assigned encrypted Payer ID.

PayPal assigned encrypted Payer ID.

Parameters

$payer_id

Returns


$this
public string
# getPayerId( )

PayPal assigned encrypted Payer ID.

PayPal assigned encrypted Payer ID.

Returns

string
public
# setPhone( string $phone )

Phone number representing the payer. 20 characters max.

Phone number representing the payer. 20 characters max.

Parameters

$phone

Returns


$this
public string
# getPhone( )

Phone number representing the payer. 20 characters max.

Phone number representing the payer. 20 characters max.

Returns

string
public
# setPhoneType( string $phone_type )

Phone type Valid Values: ["HOME", "WORK", "MOBILE", "OTHER"]

Phone type Valid Values: ["HOME", "WORK", "MOBILE", "OTHER"]

Parameters

$phone_type

Returns


$this
public string
# getPhoneType( )

Phone type

Phone type

Returns

string
public
# setBirthDate( string $birth_date )

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).

Parameters

$birth_date

Returns


$this
public string
# getBirthDate( )

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).

Returns

string
public
# setTaxId( string $tax_id )

Payer’s tax ID. Only supported when the payment_method is set to paypal.

Payer’s tax ID. Only supported when the payment_method is set to paypal.

Parameters

$tax_id

Returns


$this
public string
# getTaxId( )

Payer’s tax ID. Only supported when the payment_method is set to paypal.

Payer’s tax ID. Only supported when the payment_method is set to paypal.

Returns

string
public
# setTaxIdType( string $tax_id_type )

Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal. Valid Values: ["BR_CPF", "BR_CNPJ"]

Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal. Valid Values: ["BR_CPF", "BR_CNPJ"]

Parameters

$tax_id_type

Returns


$this
public string
# getTaxIdType( )

Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal.

Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal.

Returns

string
public
# setCountryCode( string $country_code )

Two-letter registered country code of the payer to identify the buyer country.

Two-letter registered country code of the payer to identify the buyer country.

Parameters

$country_code

Returns


$this
public string
# getCountryCode( )

Two-letter registered country code of the payer to identify the buyer country.

Two-letter registered country code of the payer to identify the buyer country.

Returns

string
public
# setBillingAddress( PayPal\Api\Address $billing_address )

Billing address of the Payer.

Billing address of the Payer.

Parameters

$billing_address

Returns


$this
public PayPal\Api\Address
# getBillingAddress( )

Billing address of the Payer.

Billing address of the Payer.

Returns

PayPal\Api\Address
public
# setShippingAddress( PayPal\Api\ShippingAddress $shipping_address )

Deprecated

[DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session.

Parameters

$shipping_address

Returns


$this
public PayPal\Api\ShippingAddress
# getShippingAddress( )

Deprecated

[DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session.

Returns

PayPal\Api\ShippingAddress

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