Populate entryTransaction->getAgentBic() for recent CAMT format (#165)

mkrasselt1 · Michael Krasselt · web-flow · commit 196cd876455c · 2025-01-06T04:11:55.000+01:00
`BIC` is only available in old camt.052.001.01, camt.052.001.02, 
camt.053.001.02 and camt.054.001.02. All later versions of CAMT instead 
use `BICFI` to represent the same information.

Co-authored-by: Michael Krasselt &lt;michael@peanutpay.de&gt;
diff --git a/src/Decoder/EntryTransactionDetail.php b/src/Decoder/EntryTransactionDetail.php
@@ -198,17 +198,13 @@ public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, Sim
                         );
                     }
 
-                    if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Prtry)
-
-                    ) {
+                    if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Prtry)) {
                         $creditorReferenceInformation->setProprietary(
                             (string) $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Prtry
                         );
                     }
 
-                    if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Cd)
-
-                    ) {
+                    if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Cd)) {
                         $creditorReferenceInformation->setCode(
                             (string) $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Cd
                         );
@@ -218,8 +214,10 @@ public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, Sim
 
                     // Legacy : do not overwrite message if already defined above
                     // and no creditor reference is already defined
-                    if (false === $unstructuredBlockExists
-                        && $remittanceInformation->getCreditorReferenceInformation() === null) {
+                    if (
+                        false === $unstructuredBlockExists
+                        && $remittanceInformation->getCreditorReferenceInformation() === null
+                    ) {
                         $remittanceInformation->setCreditorReferenceInformation($creditorReferenceInformation);
                     }
                 }
@@ -362,6 +360,6 @@ abstract public function getRelatedPartyAccount(?SimpleXMLElement $xmlRelatedPar
      */
     protected function getAgentBic(SimpleXMLElement $xmlAgent): ?SimpleXMLElement
     {
-        return $xmlAgent->FinInstnId->BIC;
+        return $xmlAgent->FinInstnId->BIC ?? $xmlAgent->FinInstnId->BICFI;
     }
 }
diff --git a/test/data/camt052.v4.json b/test/data/camt052.v4.json
@@ -180,7 +180,7 @@
                     "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",
                     "getRelatedAgentType": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\CreditorAgent",
-                        "getBIC": "",
+                        "getBIC": "BANKCHZHXXX",
                         "getName": ""
                     }
                 },
@@ -190,7 +190,7 @@
                         "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",
                         "getRelatedAgentType": {
                             "__CLASS__": "Genkgo\\Camt\\DTO\\DebtorAgent",
-                            "getBIC": "",
+                            "getBIC": "BANKCHBE",
                             "getName": ""
                         }
                     }
diff --git a/test/data/camt052.v6.json b/test/data/camt052.v6.json
@@ -180,7 +180,7 @@
                     "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",
                     "getRelatedAgentType": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\CreditorAgent",
-                        "getBIC": "",
+                        "getBIC": "BANKCHZHXXX",
                         "getName": ""
                     }
                 },
@@ -190,7 +190,7 @@
                         "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",
                         "getRelatedAgentType": {
                             "__CLASS__": "Genkgo\\Camt\\DTO\\DebtorAgent",
-                            "getBIC": "",
+                            "getBIC": "BANKCHBE",
                             "getName": ""
                         }
                     }
diff --git a/test/data/camt053.v3.json b/test/data/camt053.v3.json
@@ -184,7 +184,7 @@
                     "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",
                     "getRelatedAgentType": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\CreditorAgent",
-                        "getBIC": "",
+                        "getBIC": "KREDBEBB",
                         "getName": ""
                     }
                 },
@@ -194,7 +194,7 @@
                         "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",
                         "getRelatedAgentType": {
                             "__CLASS__": "Genkgo\\Camt\\DTO\\DebtorAgent",
-                            "getBIC": "",
+                            "getBIC": "KREDBEBB",
                             "getName": ""
                         }
                     }

Original file line number	Diff line number	Diff line change
`@@ -198,17 +198,13 @@ public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, Sim`
`198`	`198`	`);`
`199`	`199`	`}`
`200`	`200`
`201`		`- if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Prtry)`
`202`		`-`
`203`		`- ) {`
	`201`	`+ if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Prtry)) {`
`204`	`202`	`$creditorReferenceInformation->setProprietary(`
`205`	`203`	`(string) $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Prtry`
`206`	`204`	`);`
`207`	`205`	`}`
`208`	`206`
`209`		`- if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Cd)`
`210`		`-`
`211`		`- ) {`
	`207`	`+ if (isset($xmlDetailsStructuredBlock->CdtrRefInf->Tp, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry, $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Cd)) {`
`212`	`208`	`$creditorReferenceInformation->setCode(`
`213`	`209`	`(string) $xmlDetailsStructuredBlock->CdtrRefInf->Tp->CdOrPrtry->Cd`
`214`	`210`	`);`
`@@ -218,8 +214,10 @@ public function addRemittanceInformation(DTO\EntryTransactionDetail $detail, Sim`
`218`	`214`
`219`	`215`	`// Legacy : do not overwrite message if already defined above`
`220`	`216`	`// and no creditor reference is already defined`
`221`		`- if (false === $unstructuredBlockExists`
`222`		`- && $remittanceInformation->getCreditorReferenceInformation() === null) {`
	`217`	`+ if (`
	`218`	`+ false === $unstructuredBlockExists`
	`219`	`+ && $remittanceInformation->getCreditorReferenceInformation() === null`
	`220`	`+ ) {`
`223`	`221`	`$remittanceInformation->setCreditorReferenceInformation($creditorReferenceInformation);`
`224`	`222`	`}`
`225`	`223`	`}`
`@@ -362,6 +360,6 @@ abstract public function getRelatedPartyAccount(?SimpleXMLElement $xmlRelatedPar`
`362`	`360`	`*/`
`363`	`361`	`protected function getAgentBic(SimpleXMLElement $xmlAgent): ?SimpleXMLElement`
`364`	`362`	`{`
`365`		`- return $xmlAgent->FinInstnId->BIC;`
	`363`	`+ return $xmlAgent->FinInstnId->BIC ?? $xmlAgent->FinInstnId->BICFI;`
`366`	`364`	`}`
`367`	`365`	`}`
Original file line number	Diff line number	Diff line change
`@@ -180,7 +180,7 @@`
`180`	`180`	`"__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",`
`181`	`181`	`"getRelatedAgentType": {`
`182`	`182`	`"__CLASS__": "Genkgo\\Camt\\DTO\\CreditorAgent",`
`183`		`- "getBIC": "",`
	`183`	`+ "getBIC": "BANKCHZHXXX",`
`184`	`184`	`"getName": ""`
`185`	`185`	`}`
`186`	`186`	`},`
`@@ -190,7 +190,7 @@`
`190`	`190`	`"__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",`
`191`	`191`	`"getRelatedAgentType": {`
`192`	`192`	`"__CLASS__": "Genkgo\\Camt\\DTO\\DebtorAgent",`
`193`		`- "getBIC": "",`
	`193`	`+ "getBIC": "BANKCHBE",`
`194`	`194`	`"getName": ""`
`195`	`195`	`}`
`196`	`196`	`}`
Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@`
`184`	`184`	`"__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",`
`185`	`185`	`"getRelatedAgentType": {`
`186`	`186`	`"__CLASS__": "Genkgo\\Camt\\DTO\\CreditorAgent",`
`187`		`- "getBIC": "",`
	`187`	`+ "getBIC": "KREDBEBB",`
`188`	`188`	`"getName": ""`
`189`	`189`	`}`
`190`	`190`	`},`
`@@ -194,7 +194,7 @@`
`194`	`194`	`"__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",`
`195`	`195`	`"getRelatedAgentType": {`
`196`	`196`	`"__CLASS__": "Genkgo\\Camt\\DTO\\DebtorAgent",`
`197`		`- "getBIC": "",`
	`197`	`+ "getBIC": "KREDBEBB",`
`198`	`198`	`"getName": ""`
`199`	`199`	`}`
`200`	`200`	`}`