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 BaseAddress

Class BaseAddress

Base Address object used as billing address in a payment or extended for Shipping Address.

PayPal\Common\PayPalModel
Extended by PayPal\Api\BaseAddress

Direct known subclasses

PayPal\Api\Address, PayPal\Api\InvoiceAddress

Indirect known subclasses

PayPal\Api\ShippingAddress

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/BaseAddress.php

Methods summary

public
# setLine1( string $line1 )

Line 1 of the Address (eg. number, street, etc).

Line 1 of the Address (eg. number, street, etc).

Parameters

$line1

Returns


$this
public string
# getLine1( )

Line 1 of the Address (eg. number, street, etc).

Line 1 of the Address (eg. number, street, etc).

Returns

string
public
# setLine2( string $line2 )

Optional line 2 of the Address (eg. suite, apt #, etc.).

Optional line 2 of the Address (eg. suite, apt #, etc.).

Parameters

$line2

Returns


$this
public string
# getLine2( )

Optional line 2 of the Address (eg. suite, apt #, etc.).

Optional line 2 of the Address (eg. suite, apt #, etc.).

Returns

string
public
# setCity( string $city )

City name.

City name.

Parameters

$city

Returns


$this
public string
# getCity( )

City name.

City name.

Returns

string
public
# setCountryCode( string $country_code )

2 letter country code.

2 letter country code.

Parameters

$country_code

Returns


$this
public string
# getCountryCode( )

2 letter country code.

2 letter country code.

Returns

string
public
# setPostalCode( string $postal_code )

Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.

Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.

Parameters

$postal_code

Returns


$this
public string
# getPostalCode( )

Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.

Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.

Returns

string
public
# setState( string $state )

2 letter code for US states, and the equivalent for other countries.

2 letter code for US states, and the equivalent for other countries.

Parameters

$state

Returns


$this
public string
# getState( )

2 letter code for US states, and the equivalent for other countries.

2 letter code for US states, and the equivalent for other countries.

Returns

string
public
# setNormalizationStatus( string $normalization_status )

Address normalization status Valid Values: ["UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"]

Address normalization status Valid Values: ["UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"]

Parameters

$normalization_status

Returns


$this
public string
# getNormalizationStatus( )

Address normalization status

Address normalization status

Returns

string
public
# setStatus( string $status )

Address status Valid Values: ["CONFIRMED", "UNCONFIRMED"]

Address status Valid Values: ["CONFIRMED", "UNCONFIRMED"]

Parameters

$status

Returns


$this
public string
# getStatus( )

Address status

Address status

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