feat: add authorization_type and payment_plan to hosted, link and session payment requests

lib/Checkout/Payments/Hosted/HostedPaymentsSessionRequest.php

@@ -174,4 +174,19 @@
      * @var array values of AmountAllocations
      */
     public $amount_allocations;
+
+    /**
+     * The authorization type.
+     * [Optional]
+     * Allowed values: "Final", "Estimated". Defaults to "Final".
+     * @var string|null $authorization_type
+     */
+    public $authorization_type;
+
+    /**
+     * The payment plan details. To be used when the payment_type is Recurring.
+     * [Optional]
+     * @var \Checkout\Payments\PaymentPlan|null $payment_plan
+     */
+    public $payment_plan;
 }

lib/Checkout/Payments/Links/PaymentLinkRequest.php

@@ -182,4 +182,19 @@
      * @var array values of AmountAllocations
      */
     public $amount_allocations;
+
+    /**
+     * The authorization type.
+     * [Optional]
+     * Allowed values: "Final", "Estimated". Defaults to "Final".
+     * @var string|null $authorization_type
+     */
+    public $authorization_type;
+
+    /**
+     * The payment plan details. To be used when the payment_type is Recurring.
+     * [Optional]
+     * @var \Checkout\Payments\PaymentPlan|null $payment_plan
+     */
+    public $payment_plan;
 }

lib/Checkout/Payments/PaymentPlan.php

@@ -4,6 +4,14 @@
 
 class PaymentPlan
 {
+    /**
+     * Specifies whether the amount is fixed or variable for each recurrence.
+     * [Optional]
+     * Allowed values: "Fixed", "Variable".
+     * @var string|null $amount_variability
+     */
+    public $amount_variability;
+
     /**
      * Indicates the minimum number of days between payments.
      * [Optional]

lib/Checkout/Payments/Sessions/PaymentSessionsRequest.php

@@ -175,4 +175,19 @@
      * @var string
      */
     public $ip_address;
+
+    /**
+     * The authorization type.
+     * [Optional]
+     * Allowed values: "Final", "Estimated". Defaults to "Final".
+     * @var string|null $authorization_type
+     */
+    public $authorization_type;
+
+    /**
+     * The payment plan details. To be used when the payment_type is Recurring.
+     * [Optional]
+     * @var \Checkout\Payments\PaymentPlan|null $payment_plan
+     */
+    public $payment_plan;
 }

test/Checkout/Tests/Payments/PaymentRequestFieldsSerializationTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Checkout\Tests\Payments;
+
+use Checkout\JsonSerializer;
+use Checkout\Payments\Hosted\HostedPaymentsSessionRequest;
+use Checkout\Payments\Links\PaymentLinkRequest;
+use Checkout\Payments\PaymentPlan;
+use Checkout\Payments\Sessions\PaymentSessionsRequest;
+use PHPUnit\Framework\TestCase;
+
+class PaymentRequestFieldsSerializationTest extends TestCase
+{
+    private function paymentPlan()
+    {
+        $plan = new PaymentPlan();
+        $plan->amount_variability = 'Variable';
+        $plan->days_between_payments = 28;
+        $plan->total_number_of_payments = 5;
+        $plan->current_payment_number = 3;
+        return $plan;
+    }
+
+    public function testHostedPaymentsSessionRequestSerializesAuthorizationTypeAndPaymentPlan()
+    {
+        $request = new HostedPaymentsSessionRequest();
+        $request->authorization_type = "Estimated";
+        $request->payment_plan = $this->paymentPlan();
+
+        $decoded = json_decode((new JsonSerializer())->serialize($request), true);
+
+        $this->assertSame("Estimated", $decoded['authorization_type']);
+        $this->assertSame('Variable', $decoded['payment_plan']['amount_variability']);
+        $this->assertSame(28, $decoded['payment_plan']['days_between_payments']);
+        $this->assertSame(5, $decoded['payment_plan']['total_number_of_payments']);
+    }
+
+    public function testPaymentLinkRequestSerializesAuthorizationTypeAndPaymentPlan()
+    {
+        $request = new PaymentLinkRequest();
+        $request->authorization_type = "Final";
+        $request->payment_plan = $this->paymentPlan();
+
+        $decoded = json_decode((new JsonSerializer())->serialize($request), true);
+
+        $this->assertSame("Final", $decoded['authorization_type']);
+        $this->assertSame('Variable', $decoded['payment_plan']['amount_variability']);
+        $this->assertSame(28, $decoded['payment_plan']['days_between_payments']);
+    }
+
+    public function testPaymentSessionsRequestSerializesAuthorizationTypeAndPaymentPlan()
+    {
+        $request = new PaymentSessionsRequest();
+        $request->authorization_type = "Estimated";
+        $request->payment_plan = $this->paymentPlan();
+
+        $decoded = json_decode((new JsonSerializer())->serialize($request), true);
+
+        $this->assertSame("Estimated", $decoded['authorization_type']);
+        $this->assertSame('Variable', $decoded['payment_plan']['amount_variability']);
+        $this->assertSame(3, $decoded['payment_plan']['current_payment_number']);
+    }
+
+    public function testUnsetFieldsAreOmittedFromSerialization()
+    {
+        $request = new PaymentSessionsRequest();
+        $decoded = json_decode((new JsonSerializer())->serialize($request), true);
+
+        $this->assertArrayNotHasKey('authorization_type', $decoded);
+        $this->assertArrayNotHasKey('payment_plan', $decoded);
+    }
+}