Amount Breakdown

See https://developer.paypal.com/docs/api/orders/v2/#definition-Amount_breakdown.

Methods

AmountBreakdown::__construct()

Creates an amount breakdown object using constructor.

Signature

public function __construct(string $value, string $currency_code = 'USD');

Example

$amount = new AmountBreakdown('100.00', 'USD');

AmountBreakdown::of()

Creates an amount from a value and an optional currency code.

Signature

public static function of(string $value, string $currency_code = 'USD'): AmountBreakdown;

Example

$amount = AmountBreakdown::of('100.00', 'USD');

AmountBreakdown::getCurrencyCode()

Gets an amount currency code.

Signature

public function getCurrencyCode(): string;

Example

$amount = AmountBreakdown::of('100.00', 'USD');
$currency = $amount->getCurrencyCode(); // USD

AmountBreakdown::getValue()

Gets an amount value.

Signature

public function getValue(): string;

Example

$amount = AmountBreakdown::of('100.00', 'USD');
$value = $amount->getValue(); // '100.00'

AmountBreakdown::toArray()

Casts the AmountBreakdown an array representation, used when serializing an amount into http request.

Signature

public function toArray(): array;

Example

$amount = AmountBreakdown::of('100.00', 'USD');
$array = $amount->toArray(); 
// result
[   
    'value' => '100.00', 
    'currency_code' => 'USD'
];