Tidy up payment type selection and documentation ro match.

Author: judgej

README.md

@@ -257,17 +257,22 @@ and `brand`. Example:
 Alternatively a range of payment methods can be supplied as a JSON string:
 
 ```php
-    'paymentMethods' => '[{"paymentType":"CC","brand":"VISA"},{"paymentType":"CC","brand":"MASTERCARD"},{"paymentType":"PAYPAL","brand":"PAYPAL"}]',
-
-    // alternatively:
+    'paymentMethods' => [
+      ["paymentType" => "CC", "brand" => "VISA"],
+      ["paymentType" => "CC", "brand" => "MASTERCARD"],
+      ["paymentType" => "PAYPAL", "brand" => "PAYPAL"],
+    ],
 
-    'paymentMethods' => json_encode([
-        ['paymentType' => 'CC', 'brand' => 'VISA'],
-        ['paymentType' => 'CC', 'brand' => 'MASTERCARD'],
-        ['paymentType' => 'PAYPAL', 'brand' => 'PAYPAL'],
-    ]),
+    // Or you can supply 'paymentMethods' as a JSON string.
 ```
 
+For some payment types the brand is mandatory and for some it is optional.
+Examples:
+
+* `paymentType` "CC" and `brand` "VISA" will offer a visa card payment type only.
+* `paymentType` "CC" and no `brand` will offer a choice of all credit card types available.
+* No `paymentType` and no `brand` will offer a choice from all payment types available.
+
 ### Payment Page Complete Payment
 
 The transaction is completed in exactly the same way as for the seamless payments.

src/ConstantsInterface.php

@@ -141,6 +141,8 @@ interface ConstantsInterface
 
     // The transaction was ok and the profile created
     const RETURN_CODE_PROFILE_CREATED = 'PROFILE_CREATED';
+    // The transaction was ok and the profile created
+    const RETURN_CODE_PROFILE_USED = 'PROFILE_USED';
     //The transaction was ok and the profile updated
     const RETURN_CODE_PROFILE_UPDATED = 'PROFILE_UPDATED';
     //The transaction was ok but the profile was not stored/updated

src/Messages/PaymentPage/PurchaseRequest.php

@@ -107,20 +107,24 @@ public function sendData($data)
             $mdxi->Order->TemplateSet->setCSSName($data['cssName']);
         }
 
-        if (isset($data['paymentType']) && isset($data['brand'])) {
+        if (isset($data['paymentType'])) {
             // A single payment type is requested.
 
-            $this->addPaymentType($mdxi, $data['paymentType'], $data['brand']);
+            $this->addPaymentType($mdxi, $data['paymentType'], $data['brand'] ?? null);
         }
 
         if (isset($data['paymentMethods'])) {
             // A list of payment types is requested for the payment page.
 
-            $paymentMethods = json_decode($data['paymentMethods'], true);
+            if (is_string($data['paymentMethods'])) {
+                $paymentMethods = json_decode($data['paymentMethods'], true);
+            } else {
+                $paymentMethods = $data['paymentMethods'];
+            }
 
             if (is_array($paymentMethods)) {
                 foreach ($paymentMethods as $paymentMethod) {
-                    $this->addPaymentType($mdxi, $paymentMethod['paymentType'], $paymentMethod['brand']);
+                    $this->addPaymentType($mdxi, $paymentMethod['paymentType'], $paymentMethod['brand'] ?? null);
                 }
             }
         }
@@ -216,7 +220,7 @@ public function sendData($data)
     /**
      * Add a single payment method to the mdxi object.
      */
-    protected function addPaymentType(Mpay24Order $mdxi, string $paymentType, string $brand)
+    protected function addPaymentType(Mpay24Order $mdxi, string $paymentType, ?string $brand = null)
     {
         if ($this->paymentMethodCount === 0) {
             $mdxi->Order->PaymentTypes->setEnable('true');
@@ -225,6 +229,9 @@ protected function addPaymentType(Mpay24Order $mdxi, string $paymentType, string
         $this->paymentMethodCount++;
 
         $mdxi->Order->PaymentTypes->Payment($this->paymentMethodCount)->setType($paymentType);
-        $mdxi->Order->PaymentTypes->Payment($this->paymentMethodCount)->setBrand($brand);
+
+        if ($brand !== null) {
+            $mdxi->Order->PaymentTypes->Payment($this->paymentMethodCount)->setBrand($brand);
+        }
     }
 }