PHP Class PayPal\Api\CurrencyConversion

Object used to store the currency conversion rate.
Inheritance: extends PayPal\Common\PayPalModel
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.
getConversionDate ( ) : string Date of validity for the conversion rate.
getConversionType ( ) : string Field indicating conversion type applied.
getConversionTypeChangeable ( ) : boolean Allow Payer to change conversion type.
getFromAmount ( ) : string Amount participating in currency conversion, set to 1 as default
getFromCurrency ( ) : string 3 letter currency code
getLinks ( ) : PayPal\Api\Links[] Gets Links
getToAmount ( ) : string Amount resulting from currency conversion.
getToCurrency ( ) : string 3 letter currency code
getWebUrl ( ) : string Base URL to web applications endpoint
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setConversionDate ( string $conversion_date ) Date of validity for the conversion rate.
setConversionType ( string $conversion_type ) Field indicating conversion type applied.
setConversionTypeChangeable ( boolean $conversion_type_changeable ) Allow Payer to change conversion type.
setFromAmount ( string $from_amount ) Amount participating in currency conversion, set to 1 as default
setFromCurrency ( string $from_currency ) 3 letter currency code
setLinks ( PayPal\Api\Links[] $links ) Sets Links
setToAmount ( string $to_amount ) Amount resulting from currency conversion.
setToCurrency ( string $to_currency ) 3 letter currency code
setWebUrl ( string $web_url ) Base URL to web applications endpoint Valid Values: ["https://www.paypal.com/{country_code}/webapps/xocspartaweb/webflow/sparta/proxwebflow", "https://www.paypal.com/{country_code}/proxflow"]

Method Details

getConversionDate() public method

Date of validity for the conversion rate.
public getConversionDate ( ) : string
return string

getConversionType() public method

Field indicating conversion type applied.
public getConversionType ( ) : string
return string

getConversionTypeChangeable() public method

Allow Payer to change conversion type.
public getConversionTypeChangeable ( ) : boolean
return boolean

getFromAmount() public method

Amount participating in currency conversion, set to 1 as default
public getFromAmount ( ) : string
return string

getFromCurrency() public method

3 letter currency code
public getFromCurrency ( ) : string
return string

getToAmount() public method

Amount resulting from currency conversion.
public getToAmount ( ) : string
return string

getToCurrency() public method

3 letter currency code
public getToCurrency ( ) : string
return string

getWebUrl() public method

Base URL to web applications endpoint
Deprecation: Not publicly available
public getWebUrl ( ) : string
return string

setConversionDate() public method

Date of validity for the conversion rate.
public setConversionDate ( string $conversion_date )
$conversion_date string

setConversionType() public method

Valid Values: ["PAYPAL", "VENDOR"]
public setConversionType ( string $conversion_type )
$conversion_type string

setConversionTypeChangeable() public method

Allow Payer to change conversion type.
public setConversionTypeChangeable ( boolean $conversion_type_changeable )
$conversion_type_changeable boolean

setFromAmount() public method

Amount participating in currency conversion, set to 1 as default
public setFromAmount ( string $from_amount )
$from_amount string

setFromCurrency() public method

3 letter currency code
public setFromCurrency ( string $from_currency )
$from_currency string

setToAmount() public method

Amount resulting from currency conversion.
public setToAmount ( string $to_amount )
$to_amount string

setToCurrency() public method

3 letter currency code
public setToCurrency ( string $to_currency )
$to_currency string

setWebUrl() public method

Base URL to web applications endpoint Valid Values: ["https://www.paypal.com/{country_code}/webapps/xocspartaweb/webflow/sparta/proxwebflow", "https://www.paypal.com/{country_code}/proxflow"]
Deprecation: Not publicly available
public setWebUrl ( string $web_url )
$web_url string