Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • PayPal\Api\Address
  • PayPal\Api\Agreement
  • PayPal\Api\AgreementDetails
  • PayPal\Api\AgreementStateDescriptor
  • PayPal\Api\AgreementTransaction
  • PayPal\Api\AgreementTransactions
  • PayPal\Api\AlternatePayment
  • PayPal\Api\Amount
  • PayPal\Api\Authorization
  • PayPal\Api\BankAccount
  • PayPal\Api\BankAccountsList
  • PayPal\Api\BankToken
  • PayPal\Api\BaseAddress
  • PayPal\Api\Billing
  • PayPal\Api\BillingAgreementToken
  • PayPal\Api\BillingInfo
  • PayPal\Api\CancelNotification
  • PayPal\Api\Capture
  • PayPal\Api\CarrierAccount
  • PayPal\Api\CarrierAccountToken
  • PayPal\Api\CartBase
  • PayPal\Api\ChargeModel
  • PayPal\Api\Cost
  • PayPal\Api\CountryCode
  • PayPal\Api\CreateProfileResponse
  • PayPal\Api\Credit
  • PayPal\Api\CreditCard
  • PayPal\Api\CreditCardHistory
  • PayPal\Api\CreditCardList
  • PayPal\Api\CreditCardToken
  • PayPal\Api\CreditFinancingOffered
  • PayPal\Api\Currency
  • PayPal\Api\CurrencyConversion
  • PayPal\Api\CustomAmount
  • PayPal\Api\DetailedRefund
  • PayPal\Api\Details
  • PayPal\Api\Error
  • PayPal\Api\ErrorDetails
  • PayPal\Api\ExtendedBankAccount
  • PayPal\Api\ExternalFunding
  • PayPal\Api\FileAttachment
  • PayPal\Api\FlowConfig
  • PayPal\Api\FmfDetails
  • PayPal\Api\FundingDetail
  • PayPal\Api\FundingInstrument
  • PayPal\Api\FundingOption
  • PayPal\Api\FundingSource
  • PayPal\Api\FuturePayment
  • PayPal\Api\HyperSchema
  • PayPal\Api\Image
  • PayPal\Api\Incentive
  • PayPal\Api\InputFields
  • PayPal\Api\InstallmentInfo
  • PayPal\Api\InstallmentOption
  • PayPal\Api\Invoice
  • PayPal\Api\InvoiceAddress
  • PayPal\Api\InvoiceItem
  • PayPal\Api\InvoiceNumber
  • PayPal\Api\InvoiceSearchResponse
  • PayPal\Api\Item
  • PayPal\Api\ItemList
  • PayPal\Api\Links
  • PayPal\Api\Measurement
  • PayPal\Api\MerchantInfo
  • PayPal\Api\MerchantPreferences
  • PayPal\Api\Metadata
  • PayPal\Api\NameValuePair
  • PayPal\Api\Notification
  • PayPal\Api\OpenIdAddress
  • PayPal\Api\OpenIdError
  • PayPal\Api\OpenIdSession
  • PayPal\Api\OpenIdTokeninfo
  • PayPal\Api\OpenIdUserinfo
  • PayPal\Api\Order
  • PayPal\Api\OverrideChargeModel
  • PayPal\Api\Participant
  • PayPal\Api\Patch
  • PayPal\Api\PatchRequest
  • PayPal\Api\Payee
  • PayPal\Api\Payer
  • PayPal\Api\PayerInfo
  • PayPal\Api\Payment
  • PayPal\Api\PaymentCard
  • PayPal\Api\PaymentCardToken
  • PayPal\Api\PaymentDefinition
  • PayPal\Api\PaymentDetail
  • PayPal\Api\PaymentExecution
  • PayPal\Api\PaymentHistory
  • PayPal\Api\PaymentInstruction
  • PayPal\Api\PaymentOptions
  • PayPal\Api\PaymentSummary
  • PayPal\Api\PaymentTerm
  • PayPal\Api\Payout
  • PayPal\Api\PayoutBatch
  • PayPal\Api\PayoutBatchHeader
  • PayPal\Api\PayoutItem
  • PayPal\Api\PayoutItemDetails
  • PayPal\Api\PayoutSenderBatchHeader
  • PayPal\Api\Phone
  • PayPal\Api\Plan
  • PayPal\Api\PlanList
  • PayPal\Api\PotentialPayerInfo
  • PayPal\Api\Presentation
  • PayPal\Api\PrivateLabelCard
  • PayPal\Api\ProcessorResponse
  • PayPal\Api\RecipientBankingInstruction
  • PayPal\Api\RedirectUrls
  • PayPal\Api\Refund
  • PayPal\Api\RefundDetail
  • PayPal\Api\RefundRequest
  • PayPal\Api\RelatedResources
  • PayPal\Api\Sale
  • PayPal\Api\Search
  • PayPal\Api\ShippingAddress
  • PayPal\Api\ShippingCost
  • PayPal\Api\ShippingInfo
  • PayPal\Api\Tax
  • PayPal\Api\Template
  • PayPal\Api\TemplateData
  • PayPal\Api\Templates
  • PayPal\Api\TemplateSettings
  • PayPal\Api\TemplateSettingsMetadata
  • PayPal\Api\Terms
  • PayPal\Api\Transaction
  • PayPal\Api\TransactionBase
  • PayPal\Api\Transactions
  • PayPal\Api\VerifyWebhookSignature
  • PayPal\Api\VerifyWebhookSignatureResponse
  • PayPal\Api\Webhook
  • PayPal\Api\WebhookEvent
  • PayPal\Api\WebhookEventList
  • PayPal\Api\WebhookEventType
  • PayPal\Api\WebhookEventTypeList
  • PayPal\Api\WebhookList
  • PayPal\Api\WebProfile
  • PayPal\Auth\OAuthTokenCredential
  • PayPal\Cache\AuthorizationCache
  • PayPal\Common\ArrayUtil
  • PayPal\Common\PayPalModel
  • PayPal\Common\PayPalResourceModel
  • PayPal\Common\PayPalUserAgent
  • PayPal\Common\ReflectionUtil
  • PayPal\Converter\FormatConverter
  • PayPal\Core\PayPalConfigManager
  • PayPal\Core\PayPalConstants
  • PayPal\Core\PayPalCredentialManager
  • PayPal\Core\PayPalHttpConfig
  • PayPal\Core\PayPalHttpConnection
  • PayPal\Core\PayPalLoggingManager
  • PayPal\Handler\OauthHandler
  • PayPal\Handler\RestHandler
  • PayPal\Log\PayPalDefaultLogFactory
  • PayPal\Log\PayPalLogger
  • PayPal\Rest\ApiContext
  • PayPal\Security\Cipher
  • PayPal\Transport\PayPalRestCall
  • PayPal\Validation\ArgumentValidator
  • PayPal\Validation\JsonValidator
  • PayPal\Validation\NumericValidator
  • PayPal\Validation\UrlValidator

Interfaces

  • PayPal\Handler\IPayPalHandler
  • PayPal\Log\PayPalLogFactory
  • PayPal\Rest\IResource

Exceptions

  • PayPal\Exception\PayPalConfigurationException
  • PayPal\Exception\PayPalConnectionException
  • PayPal\Exception\PayPalInvalidCredentialException
  • PayPal\Exception\PayPalMissingCredentialException
  1 <?php
  2 
  3 namespace PayPal\Api;
  4 
  5 use PayPal\Common\PayPalModel;
  6 
  7 /**
  8  * Class CarrierAccount
  9  *
 10  * Payment instrument that enables carrier billing.
 11  *
 12  * @package PayPal\Api
 13  *
 14  * @property string id
 15  * @property string phone_number
 16  * @property string external_customer_id
 17  * @property string phone_source
 18  * @property \PayPal\Api\CountryCode country_code
 19  */
 20 class CarrierAccount extends PayPalModel
 21 {
 22     /**
 23      * The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.
 24      *
 25      * @param string $id
 26      * 
 27      * @return $this
 28      */
 29     public function setId($id)
 30     {
 31         $this->id = $id;
 32         return $this;
 33     }
 34 
 35     /**
 36      * The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.
 37      *
 38      * @return string
 39      */
 40     public function getId()
 41     {
 42         return $this->id;
 43     }
 44 
 45     /**
 46      * The phone number of the payer, in E.164 format.
 47      *
 48      * @param string $phone_number
 49      * 
 50      * @return $this
 51      */
 52     public function setPhoneNumber($phone_number)
 53     {
 54         $this->phone_number = $phone_number;
 55         return $this;
 56     }
 57 
 58     /**
 59      * The phone number of the payer, in E.164 format.
 60      *
 61      * @return string
 62      */
 63     public function getPhoneNumber()
 64     {
 65         return $this->phone_number;
 66     }
 67 
 68     /**
 69      * The ID of the customer, as created by the merchant.
 70      *
 71      * @param string $external_customer_id
 72      * 
 73      * @return $this
 74      */
 75     public function setExternalCustomerId($external_customer_id)
 76     {
 77         $this->external_customer_id = $external_customer_id;
 78         return $this;
 79     }
 80 
 81     /**
 82      * The ID of the customer, as created by the merchant.
 83      *
 84      * @return string
 85      */
 86     public function getExternalCustomerId()
 87     {
 88         return $this->external_customer_id;
 89     }
 90 
 91     /**
 92      * The method used to obtain the phone number. Value is `READ_FROM_DEVICE` or `USER_PROVIDED`.
 93      * Valid Values: ["READ_FROM_DEVICE", "USER_PROVIDED"]
 94      *
 95      * @param string $phone_source
 96      * 
 97      * @return $this
 98      */
 99     public function setPhoneSource($phone_source)
100     {
101         $this->phone_source = $phone_source;
102         return $this;
103     }
104 
105     /**
106      * The method used to obtain the phone number. Value is `READ_FROM_DEVICE` or `USER_PROVIDED`.
107      *
108      * @return string
109      */
110     public function getPhoneSource()
111     {
112         return $this->phone_source;
113     }
114 
115     /**
116      * The ISO 3166-1 alpha-2 country code where the phone number is registered.
117      *
118      * @param \PayPal\Api\CountryCode $country_code
119      * 
120      * @return $this
121      */
122     public function setCountryCode($country_code)
123     {
124         $this->country_code = $country_code;
125         return $this;
126     }
127 
128     /**
129      * The ISO 3166-1 alpha-2 country code where the phone number is registered.
130      *
131      * @return \PayPal\Api\CountryCode
132      */
133     public function getCountryCode()
134     {
135         return $this->country_code;
136     }
137 
138 }
139 
API documentation generated by ApiGen