Merge pull request #4 from nofrixion/PLU19-make-merchantId-optional

removed merchantID from constructor, updated docs

Author: james-nofrixion

README.md

@@ -17,31 +17,31 @@ composer require nofrixion/moneymoov-php
 
 ## Usage ##
 
-The following example code shows how to use the library to create, updated and delete payment requests (see the [NoFrixion API documentation](https://docs.nofrixion.com/reference/sandbox) for a full MoneyMoov API reference and instructions on signing up for a sandbox account).
+The following example code shows how to use the library to create, update and delete payment requests (see the [NoFrixion API documentation](https://docs.nofrixion.com/reference/sandbox) for a full MoneyMoov API reference and instructions on signing up for a sandbox account).
 
 ```php
 // Client for handling Payment Request API endpoints
 use Nofrixion\Client\PaymentRequestClient;
+
 // Models for creating/updating Payment Requests
 use Nofrixion\Model\PaymentRequests\PaymentRequestCreate;
 use Nofrixion\Model\PaymentRequests\PaymentRequestUpdate;
+
 // Model returned by payment request client on creation/update
 use Nofrixion\Model\PaymentRequests\PaymentRequest;
 
 use Nofrixion\Util\PreciseNumber;
 
 $apiUrl = "https://api-sandbox.nofrixion.com/";
-// A merchant token is required for creating and modifying payment requests
+// A merchant token can be used for creating and modifying payment requests - this MUST be securely stored.
 $token = getenv("MERCHANT_TOKEN_SANDBOX");
 
 $client = new PaymentRequestClient($apiUrl, $token);
 
-// Creating a Payment request
-$merchID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
+// Creating a Payment request (payment amount is required).
 $amount = new PreciseNumber("1.11");
+$newPaymentRequest = new PaymentRequestCreate($amount->__toString());
 
-// Required fields merchantID, amount, currency (default="EUR") and paymentMethodTypes (default="pisp") can be passed to the constructor.
-$newPaymentRequest = new PaymentRequestCreate($merchID, $amount->__toString());
 // Additional optional fields can be set directly on PaymentRequestCreate model.
 $newPaymentRequest->shippingFirstName = "Customer";
 $newPaymentRequest->shippingLastName = "Name";
@@ -51,14 +51,14 @@ $newPaymentRequest->baseOriginUrl = "https://store.example.com";
 $result = $client->createPaymentRequest($newPaymentRequest);
 
 
-// use the PaymentRequestUpdate model to update payment request values.
+// UPDATES: use the PaymentRequestUpdate model to update payment request values.
 $update = new PaymentRequestUpdate();
 $update->paymentMethodTypes = 'card, pisp';
 $update->amount = "1.45";
 $update->shippingAddressCity = "Dublin";
 $result = $client->updatePaymentRequest($result->id, $update);
 
 
-// Deleting a rayment request
+// DELETING a payment request
 $deleted = $client->deletePaymentRequest($result->id);
 ```

src/Model/PaymentRequests/PaymentRequest.php

@@ -94,6 +94,11 @@ public function __construct(
                     $this->addresses = $value;
                     break;
                 case "result":
+                    if (array_key_exists('customerID', $value)){
+                        $customerID = $value['customerID'];
+                    } else {
+                        $customerID = null;
+                    }
                     $this->result = new PaymentRequestResult(
                         $value['paymentRequestID'],
                         $value['amount'],
@@ -102,7 +107,7 @@ public function __construct(
                         $value['requestedAmount'],
                         $value['payments'],
                         $value['pispAuthorizations'],
-                        $value['customerID']
+                        $customerID
                     );
                     break;
                 case "shippingAddress":

src/Model/PaymentRequests/PaymentRequestCreate.php

@@ -7,17 +7,17 @@
 use Nofrixion\Util\PreciseNumber;
 
 /**
- * PaymentRequestCreate - use to create payment request, at minimum MerchantID, amount, currency and paymentMethodTypes
- *  must be set in constructor. Other properties can be assigned direclty.
+ * PaymentRequestCreate - use to create payment request.
+ *  `amount` must be set in constructor. Other properties can be assigned directly.
  */
 class PaymentRequestCreate
 {
-    public string $merchantID;
+    public ?string $merchantID;
     public string $amount;
-    public string $currency;
-    public string $paymentMethodTypes;
-    public ?string $CustomerID;
-    public ?string $OrderID;
+    public ?string $currency = null;
+    public ?string $paymentMethodTypes;
+    public ?string $customerID;
+    public ?string $orderID;
     public ?string $description;
     public ?string $pispAccountID;
     public ?string $shippingFirstName;
@@ -55,16 +55,9 @@ class PaymentRequestCreate
     public ?array $tags;
 
     public function __construct(
-        string $merchantID,
-        string $amount,
-        string $currency = "EUR",
-        string $paymentMethodTypes = "pisp"
+        string $amount
     )
     {
-        $this->merchantID = $merchantID;
         $this->amount = $amount;
-        $this->currency = $currency;
-        $this->paymentMethodTypes = $paymentMethodTypes;
-        
     }
 }