Merge pull request #506 from ampaze/verification-of-payee-basics

Verification of payee segments and return codes

Author: nemiah

lib/Fhp/Segment/HIRMS/Rueckmeldungscode.php

@@ -79,6 +79,16 @@ public static function isError(int $code): bool
      */
     public const PAGINATION = 3040;
 
+    public const VOP_KEINE_NAMENSABWEICHUNG = 25;
+
+    public const VOP_ERGEBNIS_NAMENSABGLEICH_PRUEFEN = 3090;
+
+    public const VOP_AUSFUEHRUNGSAUFTRAG_NICHT_BENOETIGT = 3091;
+
+    public const VOP_NAMENSABGLEICH_IST_NOCH_IN_BEARBEITUNG = 3093;
+
+    public const VOP_NAMENSABGLEICH_IST_KOMPLETT = 3094;
+
     /**
      * Zugelassene Ein- und Zwei-Schritt-Verfahren für den Benutzer (+ Rückmeldungsparameter).
      * The parameters reference the VerfahrensparameterZweiSchrittVerfahren.sicherheitsfunktion values (900..997) from
@@ -99,6 +109,14 @@ public static function isError(int $code): bool
      */
     public const ZUGANG_VORLAEUFIG_GESPERRT = 3938;
 
+    /**
+     * Der eingereichte HKTAN ist entwertet und der Auftrag (nach
+     * vollständiger Übermittlung des Prüfergebnisses) soll erneut mit einem neuen
+     * HKTAN in Verbindung mit einem HKVPA eingereicht werden, sofern der
+     * Kunde die Ausführung weiterhin wünscht.
+     */
+    public const FREIGABE_KANN_NICHT_ERTEILT_WERDEN = 3945;
+
     /**
      * Starke Kundenauthentifizierung noch ausstehend.
      * Indicates that the decoupled authentication is still outstanding.

lib/Fhp/Segment/VPP/ErgebnisVopPruefungEinzeltransaktion.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseDeg;
+
+class ErgebnisVopPruefungEinzeltransaktion extends BaseDeg
+{
+    public string $ibanEmpfaenger;
+
+    public ?string $ibanZusatzinformationen = null;
+
+    public ?string $abweichenderEmpfaengername = null;
+
+    public ?string $anderesIdentifikationmerkmal = null;
+
+    /** Allowed values: RVMC, RCVC, RVNM, RVNA, PDNG */
+    public string $vopPruefergebnis;
+
+    public ?string $grundRVNA = null;
+}

lib/Fhp/Segment/VPP/HIVPPSv1.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseGeschaeftsvorfallparameter;
+
+/**
+ * Segment: Namensabgleich Prüfauftrag Parameter
+ *
+ * @see FinTS_3.0_Messages_Geschaeftsvorfaelle_VOP_1.01_2025_06_27_FV.pdf
+ * Section: C.10.7.1 c)
+ */
+class HIVPPSv1 extends BaseGeschaeftsvorfallparameter
+{
+    public ParameterNamensabgleichPruefauftrag $parameter;
+}

lib/Fhp/Segment/VPP/HIVPPv1.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseSegment;
+use Fhp\Segment\Common\Tsp;
+use Fhp\Syntax\Bin;
+
+/**
+ * Segment: Namensabgleich Prüfergebnis
+ *
+ * @see FinTS_3.0_Messages_Geschaeftsvorfaelle_VOP_1.01_2025_06_27_FV.pdf
+ * Section: C.10.7.1 b)
+ */
+class HIVPPv1 extends BaseSegment
+{
+    public ?Bin $vopId = null;
+
+    public ?Tsp $vopIdGueltigBis = null;
+
+    public ?Bin $pollingId = null;
+
+    public ?string $paymentStatusReportDescriptor = null;
+
+    public ?Bin $paymentStatusReport = null;
+
+    public ?ErgebnisVopPruefungEinzeltransaktion $ergebnisVopPruefungEinzeltransaktion = null;
+
+    public ?string $aufklaerungstextAutorisierungTrotzAbweichung = null;
+
+    // This value is in seconds
+    public ?int $wartezeitVorNaechsterAbfrage = null;
+}

lib/Fhp/Segment/VPP/HKVPAv1.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseSegment;
+use Fhp\Syntax\Bin;
+
+/**
+ * Segment: Namensabgleich Ausführungsauftrag
+ *
+ * @see FinTS_3.0_Messages_Geschaeftsvorfaelle_VOP_1.01_2025_06_27_FV.pdf
+ * Section: C.10.7.1.2 a)
+ */
+class HKVPAv1 extends BaseSegment
+{
+    public Bin $vopId;
+}

lib/Fhp/Segment/VPP/HKVPPv1.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseSegment;
+use Fhp\Syntax\Bin;
+
+/**
+ * Segment: Namensabgleich Prüfauftrag
+ *
+ * @see FinTS_3.0_Messages_Geschaeftsvorfaelle_VOP_1.01_2025_06_27_FV.pdf
+ * Section: C.10.7.1 a)
+ */
+class HKVPPv1 extends BaseSegment
+{
+    public UnterstuetztePaymentStatusReports $unterstuetztePaymentStatusReports;
+
+    public ?Bin $pollingId = null;
+
+    /** Only allowed if {@link ParameterNamensabgleichPruefauftrag::$eingabeAnzahlEintraegeErlaubt} says so. */
+    public ?int $maximaleAnzahlEintraege = null;
+
+    /** For pagination. Max length: 35 */
+    public ?string $aufsetzpunkt = null;
+
+    public static function createEmpty(): static
+    {
+        $hkvpp = parent::createEmpty();
+        $hkvpp->unterstuetztePaymentStatusReports = new UnterstuetztePaymentStatusReports();
+        return $hkvpp;
+    }
+}

lib/Fhp/Segment/VPP/ParameterNamensabgleichPruefauftrag.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseDeg;
+
+class ParameterNamensabgleichPruefauftrag extends BaseDeg
+{
+    public int $maximaleAnzahlCreditTransferTransactionInformationOptIn;
+
+    public bool $aufklaerungstextStrukturiert;
+
+    /** Allowed values: V, S */
+    public string $artDerLieferungPaymentStatusReport;
+
+    public bool $sammelzahlungenMitEinemAuftragErlaubt;
+
+    public bool $eingabeAnzahlEintraegeErlaubt;
+
+    public string $unterstuetztePaymentStatusReportDatenformate;
+
+    /** @var string[] @Max(999999) Max length each: 6 */
+    public array $vopPflichtigerZahlungsverkehrsauftrag;
+}

lib/Fhp/Segment/VPP/UnterstuetztePaymentStatusReports.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Fhp\Segment\VPP;
+
+use Fhp\Segment\BaseDeg;
+
+class UnterstuetztePaymentStatusReports extends BaseDeg
+{
+    /** @var string[] @Max(99) Max length each: 256 */
+    public array $paymentStatusReportDescriptor;
+}