Merge pull request #187 from linushstge/feature/sepa-purpose-codes

Implementation for optional SEPA credit transfer purpose codes
ebics-api · Jan 25, 2024 · 8caca27 · 8caca27
2 parents 46f62b6 + 2afd831
commit 8caca27
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 <img src="https://www.ebics.org/typo3conf/ext/siz_ebicsorg_base/Resources/Public/Images/ebics-logo.png" width="300">
 
 PHP library to communicate with a bank through EBICS protocol.  
-Supported PHP versions - PHP 7.2 - PHP 8.1  
+Supported PHP versions - PHP 7.2 - PHP 8.3  
 Support Ebics server versions: 2.4 (partially), 2.5 (default), 3.0
 
 ## License

diff --git a/src/Builders/CustomerCreditTransfer/CustomerCreditTransferBuilder.php b/src/Builders/CustomerCreditTransfer/CustomerCreditTransferBuilder.php
@@ -179,14 +179,26 @@ public function createInstance(
         return $this;
     }
 
+    /**
+     * @param string $creditorFinInstBIC
+     * @param string $creditorIBAN
+     * @param string $creditorName
+     * @param float $amount
+     * @param string $currency
+     * @param string $purpose
+     * @param string|null $endToEndId
+     * @param string|null $purposeCode Optional Purpose Code - e.G. BENE BONU CBFF CHAR GOVT PENS SALA SSBE
+     * @return CustomerCreditTransferBuilder
+     */
     public function addTransaction(
         string $creditorFinInstBIC,
         string $creditorIBAN,
         string $creditorName,
         float $amount,
         string $currency,
         string $purpose,
-        string $endToEndId = null
+        string $endToEndId = null,
+        string $purposeCode = null
     ): CustomerCreditTransferBuilder {
         $xpath = $this->prepareXPath($this->instance);
         $nbOfTxsList = $xpath->query('//CstmrCdtTrfInitn/PmtInf/NbOfTxs');
@@ -247,6 +259,15 @@ public function addTransaction(
         $xmlIBAN->nodeValue = $creditorIBAN;
         $xmlId->appendChild($xmlIBAN);
 
+        if ($purposeCode) {
+            $xmlPurp = $this->instance->createElement('Purp');
+            $xmlCdtTrfTxInf->appendChild($xmlPurp);
+
+            $xmlCd = $this->instance->createElement('Cd');
+            $xmlCd->nodeValue = $purposeCode;
+            $xmlPurp->appendChild($xmlCd);
+        }
+
         $xmlRmtInf = $this->instance->createElement('RmtInf');
         $xmlCdtTrfTxInf->appendChild($xmlRmtInf);
 

diff --git a/src/Builders/CustomerCreditTransfer/CustomerInstantCreditTransferBuilder.php b/src/Builders/CustomerCreditTransfer/CustomerInstantCreditTransferBuilder.php
@@ -184,7 +184,8 @@ public function createInstance(
      * @param float $amount
      * @param string $currency
      * @param string $purpose
-     * @param string $endToEndId
+     * @param string|null $endToEndId
+     * @param string|null $purposeCode Optional Purpose Code - e.G. BENE BONU CBFF CHAR GOVT PENS SALA SSBE
      * @return CustomerInstantCreditTransferBuilder
      */
     public function addTransaction(
@@ -194,7 +195,8 @@ public function addTransaction(
         float $amount,
         string $currency,
         string $purpose,
-        string $endToEndId
+        string $endToEndId = null,
+        string $purposeCode = null
     ): CustomerInstantCreditTransferBuilder {
         $xpath = $this->prepareXPath($this->instance);
         $nbOfTxsList = $xpath->query('//CstmrCdtTrfInitn/PmtInf/NbOfTxs');
@@ -255,6 +257,15 @@ public function addTransaction(
         $xmlIBAN->nodeValue = $creditorIBAN;
         $xmlId->appendChild($xmlIBAN);
 
+        if ($purposeCode) {
+            $xmlPurp = $this->instance->createElement('Purp');
+            $xmlCdtTrfTxInf->appendChild($xmlPurp);
+
+            $xmlCd = $this->instance->createElement('Cd');
+            $xmlCd->nodeValue = $purposeCode;
+            $xmlPurp->appendChild($xmlCd);
+        }
+
         $xmlRmtInf = $this->instance->createElement('RmtInf');
         $xmlCdtTrfTxInf->appendChild($xmlRmtInf);