PHP Class PayPal\Api\PayerInfo

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

Public Methods

Method Description
getAccountNumber ( ) : string Account Number representing the Payer
getBillingAddress ( ) : Address Billing address of the Payer.
getBirthDate ( ) : string Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
getBuyerAccountNumber ( ) : string Account Number representing the Payer
getCountryCode ( ) : string Two-letter registered country code of the payer to identify the buyer country.
getEmail ( ) : string Email address representing the payer. 127 characters max.
getExternalRememberMeId ( ) : string External Remember Me id representing the payer
getFirstName ( ) : string First name of the payer.
getLastName ( ) : string Last name of the payer.
getMiddleName ( ) : string Middle name of the payer.
getPayerId ( ) : string PayPal assigned encrypted Payer ID.
getPhone ( ) : string Phone number representing the payer. 20 characters max.
getPhoneType ( ) : string Phone type
getSalutation ( ) : string Salutation of the payer.
getShippingAddress ( ) : ShippingAddress
getSuffix ( ) : string Suffix of the payer.
getTaxId ( ) : string Payer’s tax ID. Only supported when the payment_method is set to paypal.
getTaxIdType ( ) : string Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal.
setAccountNumber ( string $account_number ) Account Number representing the Payer
setBillingAddress ( Address $billing_address ) Billing address of the Payer.
setBirthDate ( string $birth_date ) Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
setBuyerAccountNumber ( string $buyer_account_number ) Account Number representing the Payer
setCountryCode ( string $country_code ) Two-letter registered country code of the payer to identify the buyer country.
setEmail ( string $email ) Email address representing the payer. 127 characters max.
setExternalRememberMeId ( string $external_remember_me_id ) External Remember Me id representing the payer
setFirstName ( string $first_name ) First name of the payer.
setLastName ( string $last_name ) Last name of the payer.
setMiddleName ( string $middle_name ) Middle name of the payer.
setPayerId ( string $payer_id ) PayPal assigned encrypted Payer ID.
setPhone ( string $phone ) Phone number representing the payer. 20 characters max.
setPhoneType ( string $phone_type ) Phone type Valid Values: ["HOME", "WORK", "MOBILE", "OTHER"]
setSalutation ( string $salutation ) Salutation of the payer.
setShippingAddress ( ShippingAddress $shipping_address )
setSuffix ( string $suffix ) Suffix of the payer.
setTaxId ( string $tax_id ) Payer’s tax ID. Only supported when the payment_method is set to paypal.
setTaxIdType ( string $tax_id_type ) Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal.

Method Details

getAccountNumber() public method

Account Number representing the Payer
Deprecation: Use #getBuyerAccountNumberInstead
Deprecation: Not publicly available
public getAccountNumber ( ) : string
return string

getBillingAddress() public method

Billing address of the Payer.
public getBillingAddress ( ) : Address
return Address

getBirthDate() public method

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
public getBirthDate ( ) : string
return string

getBuyerAccountNumber() public method

Account Number representing the Payer
public getBuyerAccountNumber ( ) : string
return string

getCountryCode() public method

Two-letter registered country code of the payer to identify the buyer country.
public getCountryCode ( ) : string
return string

getEmail() public method

Email address representing the payer. 127 characters max.
public getEmail ( ) : string
return string

getExternalRememberMeId() public method

External Remember Me id representing the payer
public getExternalRememberMeId ( ) : string
return string

getFirstName() public method

First name of the payer.
public getFirstName ( ) : string
return string

getLastName() public method

Last name of the payer.
public getLastName ( ) : string
return string

getMiddleName() public method

Middle name of the payer.
public getMiddleName ( ) : string
return string

getPayerId() public method

PayPal assigned encrypted Payer ID.
public getPayerId ( ) : string
return string

getPhone() public method

Phone number representing the payer. 20 characters max.
public getPhone ( ) : string
return string

getPhoneType() public method

Phone type
public getPhoneType ( ) : string
return string

getSalutation() public method

Salutation of the payer.
public getSalutation ( ) : string
return string

getShippingAddress() public method

Deprecation: [DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session.
public getShippingAddress ( ) : ShippingAddress
return ShippingAddress

getSuffix() public method

Suffix of the payer.
public getSuffix ( ) : string
return string

getTaxId() public method

Payer’s tax ID. Only supported when the payment_method is set to paypal.
public getTaxId ( ) : string
return string

getTaxIdType() public method

Payer’s tax ID type. Allowed values: BR_CPF or BR_CNPJ. Only supported when the payment_method is set to paypal.
public getTaxIdType ( ) : string
return string

setAccountNumber() public method

Account Number representing the Payer
Deprecation: Use #setBuyerAccountNumberInstead
public setAccountNumber ( string $account_number )
$account_number string

setBillingAddress() public method

Billing address of the Payer.
public setBillingAddress ( Address $billing_address )
$billing_address Address

setBirthDate() public method

Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
public setBirthDate ( string $birth_date )
$birth_date string

setBuyerAccountNumber() public method

Account Number representing the Payer
public setBuyerAccountNumber ( string $buyer_account_number )
$buyer_account_number string

setCountryCode() public method

Two-letter registered country code of the payer to identify the buyer country.
public setCountryCode ( string $country_code )
$country_code string

setEmail() public method

Email address representing the payer. 127 characters max.
public setEmail ( string $email )
$email string

setExternalRememberMeId() public method

External Remember Me id representing the payer
public setExternalRememberMeId ( string $external_remember_me_id )
$external_remember_me_id string

setFirstName() public method

First name of the payer.
public setFirstName ( string $first_name )
$first_name string

setLastName() public method

Last name of the payer.
public setLastName ( string $last_name )
$last_name string

setMiddleName() public method

Middle name of the payer.
public setMiddleName ( string $middle_name )
$middle_name string

setPayerId() public method

PayPal assigned encrypted Payer ID.
public setPayerId ( string $payer_id )
$payer_id string

setPhone() public method

Phone number representing the payer. 20 characters max.
public setPhone ( string $phone )
$phone string

setPhoneType() public method

Phone type Valid Values: ["HOME", "WORK", "MOBILE", "OTHER"]
public setPhoneType ( string $phone_type )
$phone_type string

setSalutation() public method

Salutation of the payer.
public setSalutation ( string $salutation )
$salutation string

setShippingAddress() public method

Deprecation: [DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session.
public setShippingAddress ( ShippingAddress $shipping_address )
$shipping_address ShippingAddress

setSuffix() public method

Suffix of the payer.
public setSuffix ( string $suffix )
$suffix string

setTaxId() public method

Payer’s tax ID. Only supported when the payment_method is set to paypal.
public setTaxId ( string $tax_id )
$tax_id string

setTaxIdType() public method

Valid Values: ["BR_CPF", "BR_CNPJ"]
public setTaxIdType ( string $tax_id_type )
$tax_id_type string