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 FundingInstrument

Class FundingInstrument

A resource representing a Payer's funding instrument. An instance of this schema is valid if and only if it is valid against exactly one of these supported properties

PayPal\Common\PayPalModel
Extended by PayPal\Api\FundingInstrument

Direct known subclasses

PayPal\Api\FundingSource

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

Methods summary

public
# setCreditCard( PayPal\Api\CreditCard $credit_card )

Credit Card instrument.

Credit Card instrument.

Parameters

$credit_card

Returns


$this
public PayPal\Api\CreditCard
# getCreditCard( )

Credit Card instrument.

Credit Card instrument.

Returns

PayPal\Api\CreditCard
public
# setCreditCardToken( PayPal\Api\CreditCardToken $credit_card_token )

PayPal vaulted credit Card instrument.

PayPal vaulted credit Card instrument.

Parameters

$credit_card_token

Returns


$this
public PayPal\Api\CreditCardToken
# getCreditCardToken( )

PayPal vaulted credit Card instrument.

PayPal vaulted credit Card instrument.

Returns

PayPal\Api\CreditCardToken
public
# setPaymentCard( PayPal\Api\PaymentCard $payment_card )

Payment Card information.

Payment Card information.

Parameters

$payment_card

Returns


$this
public PayPal\Api\PaymentCard
# getPaymentCard( )

Payment Card information.

Payment Card information.

Returns

PayPal\Api\PaymentCard
public
# setBankAccount( PayPal\Api\ExtendedBankAccount $bank_account )

Bank Account information.

Bank Account information.

Deprecated

Not publicly available

Parameters

$bank_account

Returns


$this
public PayPal\Api\ExtendedBankAccount
# getBankAccount( )

Bank Account information.

Bank Account information.

Deprecated

Not publicly available

Returns

PayPal\Api\ExtendedBankAccount
public
# setBankAccountToken( PayPal\Api\BankToken $bank_account_token )

Vaulted bank account instrument.

Vaulted bank account instrument.

Deprecated

Not publicly available

Parameters

$bank_account_token

Returns


$this
public PayPal\Api\BankToken
# getBankAccountToken( )

Vaulted bank account instrument.

Vaulted bank account instrument.

Deprecated

Not publicly available

Returns

PayPal\Api\BankToken
public
# setCredit( PayPal\Api\Credit $credit )

PayPal credit funding instrument.

PayPal credit funding instrument.

Deprecated

Not publicly available

Parameters

$credit

Returns


$this
public PayPal\Api\Credit
# getCredit( )

PayPal credit funding instrument.

PayPal credit funding instrument.

Deprecated

Not publicly available

Returns

PayPal\Api\Credit
public
# setIncentive( PayPal\Api\Incentive $incentive )

Incentive funding instrument.

Incentive funding instrument.

Deprecated

Not publicly available

Parameters

$incentive

Returns


$this
public PayPal\Api\Incentive
# getIncentive( )

Incentive funding instrument.

Incentive funding instrument.

Deprecated

Not publicly available

Returns

PayPal\Api\Incentive
public
# setExternalFunding( PayPal\Api\ExternalFunding $external_funding )

External funding instrument.

External funding instrument.

Deprecated

Not publicly available

Parameters

$external_funding

Returns


$this
public PayPal\Api\ExternalFunding
# getExternalFunding( )

External funding instrument.

External funding instrument.

Deprecated

Not publicly available

Returns

PayPal\Api\ExternalFunding
public
# setCarrierAccountToken( PayPal\Api\CarrierAccountToken $carrier_account_token )

Carrier account token instrument.

Carrier account token instrument.

Deprecated

Not publicly available

Parameters

$carrier_account_token

Returns


$this
public PayPal\Api\CarrierAccountToken
# getCarrierAccountToken( )

Carrier account token instrument.

Carrier account token instrument.

Deprecated

Not publicly available

Returns

PayPal\Api\CarrierAccountToken
public
# setCarrierAccount( PayPal\Api\CarrierAccount $carrier_account )

Carrier account instrument

Carrier account instrument

Deprecated

Not publicly available

Parameters

$carrier_account

Returns


$this
public PayPal\Api\CarrierAccount
# getCarrierAccount( )

Carrier account instrument

Carrier account instrument

Deprecated

Not publicly available

Returns

PayPal\Api\CarrierAccount
public
# setPrivateLabelCard( PayPal\Api\PrivateLabelCard $private_label_card )

Private Label Card funding instrument. These are store cards provided by merchants to drive business with value to customer with convenience and rewards.

Private Label Card funding instrument. These are store cards provided by merchants to drive business with value to customer with convenience and rewards.

Deprecated

Not publicly available

Parameters

$private_label_card

Returns


$this
public PayPal\Api\PrivateLabelCard
# getPrivateLabelCard( )

Private Label Card funding instrument. These are store cards provided by merchants to drive business with value to customer with convenience and rewards.

Private Label Card funding instrument. These are store cards provided by merchants to drive business with value to customer with convenience and rewards.

Deprecated

Not publicly available

Returns

PayPal\Api\PrivateLabelCard
public
# setBilling( PayPal\Api\Billing $billing )

Billing instrument that references pre-approval information for the payment

Billing instrument that references pre-approval information for the payment

Parameters

$billing

Returns


$this
public PayPal\Api\Billing
# getBilling( )

Billing instrument that references pre-approval information for the payment

Billing instrument that references pre-approval information for the payment

Returns

PayPal\Api\Billing
public
# setAlternatePayment( PayPal\Api\AlternatePayment $alternate_payment )

Alternate Payment information - Mostly regional payment providers. For e.g iDEAL in Netherlands

Alternate Payment information - Mostly regional payment providers. For e.g iDEAL in Netherlands

Deprecated

Not publicly available

Parameters

$alternate_payment

Returns


$this
public PayPal\Api\AlternatePayment
# getAlternatePayment( )

Alternate Payment information - Mostly regional payment providers. For e.g iDEAL in Netherlands

Alternate Payment information - Mostly regional payment providers. For e.g iDEAL in Netherlands

Deprecated

Not publicly available

Returns

PayPal\Api\AlternatePayment

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