PHP Class PayPal\Api\Payer

Inheritance: extends PayPal\Common\PPModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addFundingInstrument ( FundingInstrument $fundingInstrument ) Append FundingInstruments to the list.
getAccountAge ( ) : string Duration since the payer established account relationship with PayPal in days.
getAccountType ( ) : string Type of account relationship payer has with PayPal.
getExternalSelectedFundingInstrumentType ( ) : string Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button
getFundingInstruments ( ) : FundingInstrument[] List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
getFundingOption ( ) : PayPal\Api\FundingOption Default funding option available for the payment
getFundingOptionId ( ) : string Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
getPayerInfo ( ) : PayerInfo Information related to the Payer.
getPaymentMethod ( ) : string Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
getRelatedFundingOption ( ) : PayPal\Api\FundingOption Funding option related to default funding option.
getStatus ( ) : string Status of payer's PayPal Account.
removeFundingInstrument ( FundingInstrument $fundingInstrument ) Remove FundingInstruments from the list.
setAccountAge ( string $account_age ) Duration since the payer established account relationship with PayPal in days.
setAccountType ( string $account_type ) Type of account relationship payer has with PayPal.
setExternalSelectedFundingInstrumentType ( string $external_selected_funding_instrument_type ) Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button Valid Values: ["CREDIT", "PAY_UPON_INVOICE"]
setFundingInstruments ( FundingInstrument[] $funding_instruments ) List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
setFundingOption ( PayPal\Api\FundingOption $funding_option ) Default funding option available for the payment
setFundingOptionId ( string $funding_option_id ) Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
setPayerInfo ( PayerInfo $payer_info ) Information related to the Payer.
setPaymentMethod ( string $payment_method ) Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
setRelatedFundingOption ( PayPal\Api\FundingOption $related_funding_option ) Funding option related to default funding option.
setStatus ( string $status ) Status of payer's PayPal Account.

Method Details

addFundingInstrument() public method

Append FundingInstruments to the list.
public addFundingInstrument ( FundingInstrument $fundingInstrument )
$fundingInstrument FundingInstrument

getAccountAge() public method

Duration since the payer established account relationship with PayPal in days.
Deprecation: Not publicly available
public getAccountAge ( ) : string
return string

getAccountType() public method

Type of account relationship payer has with PayPal.
Deprecation: Not publicly available
public getAccountType ( ) : string
return string

getExternalSelectedFundingInstrumentType() public method

Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button
public getExternalSelectedFundingInstrumentType ( ) : string
return string

getFundingInstruments() public method

List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
public getFundingInstruments ( ) : FundingInstrument[]
return FundingInstrument[]

getFundingOption() public method

Default funding option available for the payment
Deprecation: Not publicly available
public getFundingOption ( ) : PayPal\Api\FundingOption
return PayPal\Api\FundingOption

getFundingOptionId() public method

Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
Deprecation: Not publicly available
public getFundingOptionId ( ) : string
return string

getPayerInfo() public method

Information related to the Payer.
public getPayerInfo ( ) : PayerInfo
return PayerInfo

getPaymentMethod() public method

Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
public getPaymentMethod ( ) : string
return string

getRelatedFundingOption() public method

Funding option related to default funding option.
Deprecation: Not publicly available
public getRelatedFundingOption ( ) : PayPal\Api\FundingOption
return PayPal\Api\FundingOption

getStatus() public method

Status of payer's PayPal Account.
public getStatus ( ) : string
return string

removeFundingInstrument() public method

Remove FundingInstruments from the list.
public removeFundingInstrument ( FundingInstrument $fundingInstrument )
$fundingInstrument FundingInstrument

setAccountAge() public method

Duration since the payer established account relationship with PayPal in days.
Deprecation: Not publicly available
public setAccountAge ( string $account_age )
$account_age string

setAccountType() public method

Valid Values: ["BUSINESS", "PERSONAL", "PREMIER"]
Deprecation: Not publicly available
public setAccountType ( string $account_type )
$account_type string

setExternalSelectedFundingInstrumentType() public method

Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button Valid Values: ["CREDIT", "PAY_UPON_INVOICE"]
public setExternalSelectedFundingInstrumentType ( string $external_selected_funding_instrument_type )
$external_selected_funding_instrument_type string

setFundingInstruments() public method

List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
public setFundingInstruments ( FundingInstrument[] $funding_instruments )
$funding_instruments FundingInstrument[]

setFundingOption() public method

Default funding option available for the payment
Deprecation: Not publicly available
public setFundingOption ( PayPal\Api\FundingOption $funding_option )
$funding_option PayPal\Api\FundingOption

setFundingOptionId() public method

Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
Deprecation: Not publicly available
public setFundingOptionId ( string $funding_option_id )
$funding_option_id string

setPayerInfo() public method

Information related to the Payer.
public setPayerInfo ( PayerInfo $payer_info )
$payer_info PayerInfo

setPaymentMethod() public method

Valid Values: ["credit_card", "bank", "paypal", "pay_upon_invoice", "carrier", "alternate_payment"]
public setPaymentMethod ( string $payment_method )
$payment_method string

setRelatedFundingOption() public method

Funding option related to default funding option.
Deprecation: Not publicly available
public setRelatedFundingOption ( PayPal\Api\FundingOption $related_funding_option )
$related_funding_option PayPal\Api\FundingOption

setStatus() public method

Valid Values: ["VERIFIED", "UNVERIFIED"]
public setStatus ( string $status )
$status string