PHP Class PayPal\Api\CarrierAccount

Payment instrument that enables carrier billing.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getCountryCode ( ) : CountryCode The ISO 3166-1 alpha-2 country code where the phone number is registered.
getExternalCustomerId ( ) : string The ID of the customer, as created by the merchant.
getId ( ) : string The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.
getPhoneNumber ( ) : string The phone number of the payer, in E.164 format.
getPhoneSource ( ) : string The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED.
setCountryCode ( CountryCode $country_code ) The ISO 3166-1 alpha-2 country code where the phone number is registered.
setExternalCustomerId ( string $external_customer_id ) The ID of the customer, as created by the merchant.
setId ( string $id ) The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.
setPhoneNumber ( string $phone_number ) The phone number of the payer, in E.164 format.
setPhoneSource ( string $phone_source ) The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED.

Method Details

getCountryCode() public method

The ISO 3166-1 alpha-2 country code where the phone number is registered.
public getCountryCode ( ) : CountryCode
return CountryCode

getExternalCustomerId() public method

The ID of the customer, as created by the merchant.
public getExternalCustomerId ( ) : string
return string

getId() public method

The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.
public getId ( ) : string
return string

getPhoneNumber() public method

The phone number of the payer, in E.164 format.
public getPhoneNumber ( ) : string
return string

getPhoneSource() public method

The method used to obtain the phone number. Value is READ_FROM_DEVICE or USER_PROVIDED.
public getPhoneSource ( ) : string
return string

setCountryCode() public method

The ISO 3166-1 alpha-2 country code where the phone number is registered.
public setCountryCode ( CountryCode $country_code )
$country_code CountryCode

setExternalCustomerId() public method

The ID of the customer, as created by the merchant.
public setExternalCustomerId ( string $external_customer_id )
$external_customer_id string

setId() public method

The ID of the carrier account of the payer. Use in subsequent REST API calls. For example, to make payments.
public setId ( string $id )
$id string

setPhoneNumber() public method

The phone number of the payer, in E.164 format.
public setPhoneNumber ( string $phone_number )
$phone_number string

setPhoneSource() public method

Valid Values: ["READ_FROM_DEVICE", "USER_PROVIDED"]
public setPhoneSource ( string $phone_source )
$phone_source string