PHP Class PayPal\Api\FundingSource

specifies the funding source details.
Inheritance: extends FundingInstrument
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addLink ( PayPal\Api\Links $links ) Append Links to the list.
getAdditionalText ( ) : string Additional text relevant to funding source.
getAmount ( ) : PayPal\Api\Currency Total anticipated amount of money to be pulled from instrument.
getExtends ( ) : FundingInstrument Gets Extends
getFundingDetail ( ) : FundingDetail Additional detail of the funding.
getFundingInstrumentType ( ) : string Instrument type for this funding source
getFundingMode ( ) : string specifies funding mode of the instrument
getLegalText ( ) : string Localized legal text relevant to funding source.
getLinks ( ) : PayPal\Api\Links[] Gets Links
getNegativeBalanceAmount ( ) : PayPal\Api\Currency Additional amount to be pulled from the instrument to recover a negative balance on the buyer's account that is owed to PayPal.
getSoftDescriptor ( ) : string Soft descriptor used when charging this funding source.
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setAdditionalText ( string $additional_text ) Additional text relevant to funding source.
setAmount ( PayPal\Api\Currency $amount ) Total anticipated amount of money to be pulled from instrument.
setExtends ( FundingInstrument $extends ) Sets Extends
setFundingDetail ( FundingDetail $funding_detail ) Additional detail of the funding.
setFundingInstrumentType ( string $funding_instrument_type ) Instrument type for this funding source Valid Values: ["BALANCE", "PAYMENT_CARD", "BANK_ACCOUNT", "CREDIT", "INCENTIVE", "EXTERNAL_FUNDING", "TAB"]
setFundingMode ( string $funding_mode ) specifies funding mode of the instrument Valid Values: ["INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK", "PAY_UPON_INVOICE"]
setLegalText ( string $legal_text ) Localized legal text relevant to funding source.
setLinks ( PayPal\Api\Links[] $links ) Sets Links
setNegativeBalanceAmount ( PayPal\Api\Currency $negative_balance_amount ) Additional amount to be pulled from the instrument to recover a negative balance on the buyer's account that is owed to PayPal.
setSoftDescriptor ( string $soft_descriptor ) Soft descriptor used when charging this funding source.

Method Details

getAdditionalText() public method

Additional text relevant to funding source.
public getAdditionalText ( ) : string
return string

getAmount() public method

Total anticipated amount of money to be pulled from instrument.
public getAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getExtends() public method

Gets Extends
Deprecation: Unused
public getExtends ( ) : FundingInstrument
return FundingInstrument

getFundingDetail() public method

Additional detail of the funding.
public getFundingDetail ( ) : FundingDetail
return FundingDetail

getFundingInstrumentType() public method

Instrument type for this funding source
public getFundingInstrumentType ( ) : string
return string

getFundingMode() public method

specifies funding mode of the instrument
public getFundingMode ( ) : string
return string

getLegalText() public method

Localized legal text relevant to funding source.
public getLegalText ( ) : string
return string

getNegativeBalanceAmount() public method

Additional amount to be pulled from the instrument to recover a negative balance on the buyer's account that is owed to PayPal.
public getNegativeBalanceAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getSoftDescriptor() public method

Soft descriptor used when charging this funding source.
public getSoftDescriptor ( ) : string
return string

setAdditionalText() public method

Additional text relevant to funding source.
public setAdditionalText ( string $additional_text )
$additional_text string

setAmount() public method

Total anticipated amount of money to be pulled from instrument.
public setAmount ( PayPal\Api\Currency $amount )
$amount PayPal\Api\Currency

setExtends() public method

Sets Extends
Deprecation: Unused
public setExtends ( FundingInstrument $extends )
$extends FundingInstrument

setFundingDetail() public method

Additional detail of the funding.
public setFundingDetail ( FundingDetail $funding_detail )
$funding_detail FundingDetail

setFundingInstrumentType() public method

Instrument type for this funding source Valid Values: ["BALANCE", "PAYMENT_CARD", "BANK_ACCOUNT", "CREDIT", "INCENTIVE", "EXTERNAL_FUNDING", "TAB"]
public setFundingInstrumentType ( string $funding_instrument_type )
$funding_instrument_type string

setFundingMode() public method

specifies funding mode of the instrument Valid Values: ["INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK", "PAY_UPON_INVOICE"]
public setFundingMode ( string $funding_mode )
$funding_mode string

setLegalText() public method

Localized legal text relevant to funding source.
public setLegalText ( string $legal_text )
$legal_text string

setNegativeBalanceAmount() public method

Additional amount to be pulled from the instrument to recover a negative balance on the buyer's account that is owed to PayPal.
public setNegativeBalanceAmount ( PayPal\Api\Currency $negative_balance_amount )
$negative_balance_amount PayPal\Api\Currency

setSoftDescriptor() public method

Soft descriptor used when charging this funding source.
public setSoftDescriptor ( string $soft_descriptor )
$soft_descriptor string