PHP Class PayPal\Api\Amount

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

Public Methods

Method Description
getCurrency ( ) : string 3-letter currency code. PayPal does not support all currencies.
getDetails ( ) : Details Additional details of the payment amount.
getTotal ( ) : string Total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee. 10 characters max with support for 2 decimal places.
setCurrency ( string $currency ) 3-letter currency code. PayPal does not support all currencies.
setDetails ( Details $details ) Additional details of the payment amount.
setTotal ( string | double $total ) Total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee. 10 characters max with support for 2 decimal places.

Method Details

getCurrency() public method

3-letter currency code. PayPal does not support all currencies.
public getCurrency ( ) : string
return string

getDetails() public method

Additional details of the payment amount.
public getDetails ( ) : Details
return Details

getTotal() public method

Total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee. 10 characters max with support for 2 decimal places.
public getTotal ( ) : string
return string

setCurrency() public method

3-letter currency code. PayPal does not support all currencies.
public setCurrency ( string $currency )
$currency string

setDetails() public method

Additional details of the payment amount.
public setDetails ( Details $details )
$details Details

setTotal() public method

Total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee. 10 characters max with support for 2 decimal places.
public setTotal ( string | double $total )
$total string | double