public function PaymentInterface::getBalance in Commerce Core 8.2

Gets the payment balance.

The balance represents the payment amount minus the refunded amount.

Return value

\Drupal\commerce_price\Price|null The payment balance, or NULL if the payment does not have an amount yet.

1 method overrides PaymentInterface::getBalance()

Payment::getBalance in modules/payment/src/Entity/Payment.php

Gets the payment balance.

File

modules/payment/src/Entity/PaymentInterface.php, line 144

Class

PaymentInterface

Defines the interface for payments.

Namespace

Drupal\commerce_payment\Entity

Code

public function getBalance();