Add reference type on transaction

Author: zarulizham

README.md

@@ -87,6 +87,14 @@ php artisan vendor:publish --tag="duitnow-views"
     $redirectUrl = $duitNowPayment->initiatePayment(10, "Zarul Zubir", $bankType, "Ref: " . rand(100, 200), $bankId, 'A1000001');
 ```
 
+## Upgrade v1 to v2
+
+This major upgrade add column on transaction table to allow morphing.
+
+```
+Run `php artisan vendor:publish --tag=duitnow-v2-migration`
+```
+
 ## Contributing
 
 Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

database/migrations/create_duitnow_banks_table.php.stub

@@ -13,6 +13,7 @@ return new class extends Migration
             $table->string('code')->unique();
             $table->string('name', 300);
             $table->string('status', 20)->nullable()->comment('Online, Offline');
+            $table->boolean('is_active')->nullable()->default(true);
             $table->timestamps();
         });
     }

database/migrations/create_duitnow_transactions_table.php.stub

@@ -11,6 +11,7 @@ return new class extends Migration
         Schema::create('duitnow_transactions', function (Blueprint $table) {
             $table->id();
             $table->string('reference_id', 100)->nullable();
+            $table->string('reference_type', 100)->nullable();
             $table->string('transaction_id', 100)->nullable();
             $table->json('request_payload')->nullable();
             $table->json('response_payload')->nullable();

src/DuitNowPayment.php

@@ -101,7 +101,7 @@ protected function syncBanks($banks)
         }
     }
 
-    public function initiatePayment($amount, $customerName, $bankType, $bankId, $referenceId, $coordinate, $ipAddress)
+    public function initiatePayment($amount, $customerName, $bankType, $bankId, $recipientReference, $coordinate, $ipAddress, $paymentDescription = null, $referenceId = null, $referenceType = null)
     {
         $this->coordinate = $coordinate;
         $this->ipAddress = $ipAddress;
@@ -132,8 +132,8 @@ public function initiatePayment($amount, $customerName, $bankType, $bankId, $ref
                 'accountType' => config('duitnow.account_type'),
             ],
             'sourceOfFunds' => config('duitnow.source_of_funds'),
-            'recipientReference' => $referenceId,
-            'paymentDescription' => $referenceId,
+            'recipientReference' => $recipientReference,
+            'paymentDescription' => $paymentDescription ?? $recipientReference,
         ];
 
         $url = config('duitnow.url.base') . '/merchants/v1/payments/redirect';
@@ -149,7 +149,7 @@ public function initiatePayment($amount, $customerName, $bankType, $bankId, $ref
                 'Content-Type' => 'application/json',
             ])->post($url, $body);
 
-        $this->saveTransaction($this->transactionId, $referenceId, $body, $this->messageId);
+        $this->saveTransaction($this->transactionId, $referenceId, $referenceType, $body, $this->messageId);
 
         if ($response->status() == 200) {
             $redirectUrl = $this->getUrl($bankId, $bankType, $this->messageId, $response->object()->endToEndIdSignature);
@@ -181,11 +181,12 @@ protected function getUrl($bankId, $bankType, $messageId, $endToEndIdSignature)
         );
     }
 
-    protected function saveTransaction($transactionId, $referenceId, $requestPayload, $endToEndId): DuitNowTransaction
+    protected function saveTransaction($transactionId, $referenceId, $referenceType, $requestPayload, $endToEndId): DuitNowTransaction
     {
         return DuitNowTransaction::create([
             'transaction_id' => $transactionId,
             'reference_id' => $referenceId,
+            'reference_type' => $referenceType,
             'request_payload' => $requestPayload,
             'end_to_end_id' => $endToEndId,
         ]);

src/DuitNowPaymentServiceProvider.php

@@ -28,6 +28,10 @@ public function configurePackage(Package $package): void
             $this->package->basePath('/../stubs/Controller.php') => app_path("Http/Controllers/DuitNow/Controller.php"),
         ], "{$this->package->shortName()}-controller");
 
+        $this->publishes([
+            $this->package->basePath('/../stubs/migrations') => database_path("migrations"),
+        ], "{$this->package->shortName()}-v2-migration");
+
         $this->loadViewsFrom(base_path("resources/views/vendor/{$this->package->shortName()}"), "{$this->package->shortName()}");
     }
 }

src/Http/Requests/AuthorizationConfirmation.php

@@ -35,6 +35,6 @@ public function handle($type = 'webhook')
         $data = $this->all();
         $data['type'] = $type;
 
-        return (new AuthorizationConfirmationMessage())->handle($data);
+        return (new AuthorizationConfirmationMessage)->handle($data);
     }
 }

src/Messages/AuthorizationConfirmation.php

@@ -8,6 +8,11 @@
 
 class AuthorizationConfirmation implements Contract
 {
+    public $paymentStatusCode;
+    public $responsePayload;
+    public $endToEndId;
+    public $transactionStatus;
+
     /**
      * handle a message
      *
@@ -45,8 +50,6 @@ public function format()
 
     /**
      * returns collection of all fields
-     *
-     * @return collection
      */
     public function list()
     {
@@ -62,6 +65,7 @@ private function saveTransaction(): DuitNowTransaction
     {
         $transaction = DuitNowTransaction::where(['end_to_end_id' => $this->endToEndId])->firstOrNew();
 
+        $transaction->end_to_end_id = $this->endToEndId;
         $transaction->payment_status_code = $this->paymentStatusCode;
         $transaction->payment_substate = $this->transactionStatus;
         $transaction->response_payload = $this->responsePayload;
@@ -87,8 +91,8 @@ private function getTransaction()
                 $this->paymentStatusCode = $response['header']['status']['code'];
                 $this->saveTransaction();
             } catch (\Throwable $th) {
-                \Log::debug([
-                    'DuitNow.Messages.AuthorizationConfirmation' => $th->getMessage(),
+                \Log::debug('DuitNow.Messages.AuthorizationConfirmation', [
+                    'message' => $th->getMessage(),
                 ]);
 
                 throw new \Exception($th->getMessage(), 400);

src/Models/DuitNowTransaction.php

@@ -3,6 +3,7 @@
 namespace ZarulIzham\DuitNowPayment\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 class DuitNowTransaction extends Model
 {
@@ -23,4 +24,9 @@ class DuitNowTransaction extends Model
         'request_payload' => 'object',
         'response_payload' => 'object',
     ];
+
+    public function reference() : MorphTo
+    {
+        return $this->morphTo();
+    }
 }

stubs/migrations/2024_08_05_182300_update_duitnow_add_reference_type_is_active_table.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        Schema::table('duitnow_transactions', function (Blueprint $table) {
+            $table->string('reference_type', 100)->nullable()->after('reference_id');
+        });
+
+        Schema::table('duitnow_banks', function (Blueprint $table) {
+            $table->boolean('is_active')->nullable()->default(true)->after('status');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('duitnow_transactions', function (Blueprint $table) {
+            $table->dropColumn('reference_type');
+        });
+        
+        Schema::table('duitnow_banks', function (Blueprint $table) {
+            $table->dropColumn('is_active');
+        });
+    }
+};