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 CarrierAccount

Class CarrierAccount

Payment instrument that enables carrier billing.

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

Methods summary

public
# setId( string $id )

The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.

The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.

Parameters

$id

Returns


$this
public string
# getId( )

The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.

The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.

Returns

string
public
# setPhoneNumber( string $phone_number )

The phone number of the payer, in E.164 format.

The phone number of the payer, in E.164 format.

Parameters

$phone_number

Returns


$this
public string
# getPhoneNumber( )

The phone number of the payer, in E.164 format.

The phone number of the payer, in E.164 format.

Returns

string
public
# setExternalCustomerId( string $external_customer_id )

The ID of the customer, as created by the merchant.

The ID of the customer, as created by the merchant.

Parameters

$external_customer_id

Returns


$this
public string
# getExternalCustomerId( )

The ID of the customer, as created by the merchant.

The ID of the customer, as created by the merchant.

Returns

string
public
# setPhoneSource( string $phone_source )

The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED. Valid Values: ["READ_FROM_DEVICE", "USER_PROVIDED"]

The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED. Valid Values: ["READ_FROM_DEVICE", "USER_PROVIDED"]

Parameters

$phone_source

Returns


$this
public string
# getPhoneSource( )

The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED.

The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED.

Returns

string
public
# setCountryCode( PayPal\Api\CountryCode $country_code )

The ISO 3166-1 alpha-2 country code where the phone number is registered.

The ISO 3166-1 alpha-2 country code where the phone number is registered.

Parameters

$country_code

Returns


$this
public PayPal\Api\CountryCode
# getCountryCode( )

The ISO 3166-1 alpha-2 country code where the phone number is registered.

The ISO 3166-1 alpha-2 country code where the phone number is registered.

Returns

PayPal\Api\CountryCode

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