Added the getTransactionAmount() method to the PaymentResponse in…

…terface

Changelog.md

@@ -106,6 +106,7 @@
  - `hasRemoteId()`
  - `getRemoteId()`
  - `isOffline()`
+- BC: Added the `getTransactionAmount()` method to the `PaymentResponse` interface
 - BC: Added the following methods to the `Payable` interface:
  - `getNumber()`
  - `getPayableRemoteId()`
@@ -121,6 +122,7 @@
  - `getBillingCountries()`
  - `getShippingCountries()`
 - Deprecated the `PaymentMethod::getConfiguration()` in favor of `configuration()`
+- Deprecated the `PaymentResponse::getAmountPaid()` method in favor of `getTransactionAmount()`
 - Added the `Schematized` interface
 - Added the nette/schema package requirement (v1.2.5+)
 - Fixed possible null return type on Billpayer::getName() when is_organization is true but the company name is null

src/Payment/Changelog.md

@@ -18,8 +18,10 @@
  - `hasRemoteId()`
  - `getRemoteId()`
  - `isOffline()`
+- BC: Added the `getTransactionAmount()` method to the `PaymentResponse` interface
 - BC: Changed the `PaymentMethod` interface into Configurable
 - Deprecated the `PaymentMethod::getConfiguration()` in favor of `configuration()`
+- Deprecated the `Payment::getAmountPaid()` method in favor of `getTransactionAmount()`
 
 ## 3.x Series
 

src/Payment/Contracts/Payment.php

@@ -24,9 +24,6 @@ public function getAmount(): float;
 
  public function getCurrency(): string;
 
- // "Transaction amount" would've been a better name
- // since the value returned here might represent
- // an amount of a full/partial refund as well
  public function getAmountPaid(): float;
 
  public function getStatus(): PaymentStatus;

src/Payment/Contracts/PaymentResponse.php

@@ -24,8 +24,11 @@ public function getMessage(): ?string;
 
  public function getTransactionId(): ?string;
 
+ /** @deprecated use getTransactionAmount() instead */
  public function getAmountPaid(): ?float;
 
+ public function getTransactionAmount(): float;
+
  public function getPaymentId(): string;
 
  public function getStatus(): PaymentStatus;

src/Payment/Models/PaymentHistory.php

@@ -60,7 +60,7 @@ public static function addPaymentResponse(
  'old_status' => $oldStatus ?: $payment->getStatus()->value(),
  'new_status' => $response->getStatus()->value(),
  'message' => $response->getMessage(),
- 'transaction_amount' => $response->getAmountPaid(),
+ 'transaction_amount' => $response->getTransactionAmount(),
  'native_status' => $response->getNativeStatus()->value(),
  'transaction_number' => $response->getTransactionId(),
  ]);

src/Payment/Processing/PaymentResponseHandler.php

@@ -53,9 +53,9 @@ public function writeResponseToHistory(): void
  public function updatePayment(): void
  {
  $this->payment->status = $this->newStatus;
- $amountPaid = $this->response->getAmountPaid();
- if (null !== $amountPaid) {
- $this->payment->amount_paid += $this->response->getAmountPaid();
+ $transactionAmount = $this->response->getTransactionAmount();
+ if (0.0 !== $transactionAmount) {
+ $this->payment->amount_paid += $transactionAmount;
  }
  $this->payment->status_message = $this->response->getMessage();
  $this->payment->save();

src/Payment/Responses/NullResponse.php

@@ -41,6 +41,11 @@ public function getAmountPaid(): ?float
  return null;
  }
 
+ public function getTransactionAmount(): float
+ {
+ return 0;
+ }
+
  public function getPaymentId(): string
  {
  return '';

src/Payment/Tests/Examples/SomePaymentResponse.php

@@ -26,7 +26,7 @@ class SomePaymentResponse implements PaymentResponse
 
  private string $transactionId;
 
- private ?float $amountPaid;
+ private ?float $transactionAmount;
 
  private string $paymentId;
 
@@ -38,7 +38,7 @@ public function __construct(
  string $message,
  bool $wasSuccessful,
  string $transactionId,
- ?float $amountPaid,
+ ?float $transactionAmount,
  string $paymentId,
  SomeNativeStatus $nativeStatus,
  PaymentStatus $status
@@ -47,7 +47,7 @@ public function __construct(
  $this->nativeStatus = $nativeStatus;
  $this->wasSuccessful = $wasSuccessful;
  $this->transactionId = $transactionId;
- $this->amountPaid = $amountPaid;
+ $this->transactionAmount = $transactionAmount;
  $this->paymentId = $paymentId;
  $this->status = $status;
  }
@@ -69,7 +69,12 @@ public function getTransactionId(): ?string
 
  public function getAmountPaid(): ?float
  {
- return $this->amountPaid;
+ return $this->getTransactionAmount();
+ }
+
+ public function getTransactionAmount(): float
+ {
+ return (float) $this->transactionAmount;
  }
 
  public function getPaymentId(): string

src/Payment/Tests/GatewaysTest.php

@@ -64,7 +64,7 @@ public function non_illuminate_request_type_request_objects_can_be_accepted_by_p
 
  $this->assertInstanceOf(PaymentResponse::class, $result);
  $this->assertEquals(PaymentStatus::PAID(), $result->getStatus());
- $this->assertEquals(27.99, $result->getAmountPaid());
+ $this->assertEquals(27.99, $result->getTransactionAmount());
  $this->assertEquals('C9278', $result->getTransactionId());
  }
 }

src/Payment/Tests/ResponseHandlerTest.php

@@ -146,7 +146,7 @@ public function it_creates_payment_history_entries()
  $this->assertEquals(PaymentStatus::TIMEOUT, $entry->new_status->value());
  $this->assertEquals(PaymentStatus::PENDING, $entry->old_status->value());
  $this->assertEquals('Timed out like a lion', $entry->message);
- $this->assertNull($entry->transaction_amount);
+ $this->assertEquals(0, $entry->transaction_amount);
  }
 
  /** @test */