chore: add minor iso fixes (#181)

mojaloop · Oct 14, 2024 · 51ae289 · 51ae289
1 parent c2808b6
commit 51ae289
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 31 deletions.
diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml
@@ -2968,13 +2968,12 @@ components:
           "COMM": "COMMITED",
           "RESV": "RESERVED",
           "RECV": "RECEIVED",
-          "ABOR": "ABORTED",
-          "SETT": "SETTLED"
+          "ABOR": "ABORTED"
         }
       type: string
       minLength: 1
       maxLength: 4
-      example: SETT
+      example: COMM
     ExternalPersonIdentification1Code:
       title: ExternalPersonIdentification1Code
       description: Specifies the external person identification code.
@@ -6577,6 +6576,11 @@ components:
                 #/components/schemas/BranchAndFinancialInstitutionIdentification8
             - description: |
                 Financial institution servicing an account for the creditor.
+      required:
+        - Dbtr
+        - Cdtr
+        - DbtrAgt
+        - CdtrAgt
     VerificationReason1Choice:
       title: VerificationReason1Choice
       type: object

diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml
@@ -7,10 +7,9 @@ description: |
     "COMM": "COMMITED",
     "RESV": "RESERVED",
     "RECV": "RECEIVED",
-    "ABOR": "ABORTED",
-    "SETT": "SETTLED"
+    "ABOR": "ABORTED"
   }
 type: string
 minLength: 1
 maxLength: 4
-example: SETT
+example: COMM
diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UnderlyingCustomerCreditTransfer.yaml
@@ -29,4 +29,8 @@ properties:
       -  $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
       - description: >
           Financial institution servicing an account for the creditor.
-
+required:
+  - Dbtr
+  - Cdtr
+  - DbtrAgt
+  - CdtrAgt
diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json
@@ -9739,7 +9739,13 @@
                   }
                 ]
               }
-            }
+            },
+            "required": [
+              "Dbtr",
+              "Cdtr",
+              "DbtrAgt",
+              "CdtrAgt"
+            ]
           },
           {
             "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -22967,7 +22973,13 @@
                   }
                 ]
               }
-            }
+            },
+            "required": [
+              "Dbtr",
+              "Cdtr",
+              "DbtrAgt",
+              "CdtrAgt"
+            ]
           },
           {
             "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -32970,7 +32982,13 @@
                           }
                         ]
                       }
-                    }
+                    },
+                    "required": [
+                      "Dbtr",
+                      "Cdtr",
+                      "DbtrAgt",
+                      "CdtrAgt"
+                    ]
                   },
                   {
                     "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -42030,11 +42048,11 @@
   },
   "ExternalPaymentTransactionStatus1Code": {
     "title": "ExternalPaymentTransactionStatus1Code",
-    "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\",\n  \"SETT\": \"SETTLED\"\n}\n",
+    "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\"\n}\n",
     "type": "string",
     "minLength": 1,
     "maxLength": 4,
-    "example": "SETT"
+    "example": "COMM"
   },
   "ExternalPersonIdentification1Code": {
     "title": "ExternalPersonIdentification1Code",
@@ -48308,7 +48326,13 @@
                           }
                         ]
                       }
-                    }
+                    },
+                    "required": [
+                      "Dbtr",
+                      "Cdtr",
+                      "DbtrAgt",
+                      "CdtrAgt"
+                    ]
                   },
                   {
                     "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -58323,7 +58347,13 @@
                           }
                         ]
                       }
-                    }
+                    },
+                    "required": [
+                      "Dbtr",
+                      "Cdtr",
+                      "DbtrAgt",
+                      "CdtrAgt"
+                    ]
                   },
                   {
                     "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -68054,7 +68084,13 @@
                           }
                         ]
                       }
-                    }
+                    },
+                    "required": [
+                      "Dbtr",
+                      "Cdtr",
+                      "DbtrAgt",
+                      "CdtrAgt"
+                    ]
                   },
                   {
                     "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -100417,11 +100453,11 @@
                 "allOf": [
                   {
                     "title": "ExternalPaymentTransactionStatus1Code",
-                    "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\",\n  \"SETT\": \"SETTLED\"\n}\n",
+                    "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\"\n}\n",
                     "type": "string",
                     "minLength": 1,
                     "maxLength": 4,
-                    "example": "SETT"
+                    "example": "COMM"
                   },
                   {
                     "description": "Specifies the status of the transaction.\n"
@@ -102009,11 +102045,11 @@
                 "allOf": [
                   {
                     "title": "ExternalPaymentTransactionStatus1Code",
-                    "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\",\n  \"SETT\": \"SETTLED\"\n}\n",
+                    "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\"\n}\n",
                     "type": "string",
                     "minLength": 1,
                     "maxLength": 4,
-                    "example": "SETT"
+                    "example": "COMM"
                   },
                   {
                     "description": "Specifies the status of the transaction.\n"
@@ -108534,11 +108570,11 @@
         "allOf": [
           {
             "title": "ExternalPaymentTransactionStatus1Code",
-            "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\",\n  \"SETT\": \"SETTLED\"\n}\n",
+            "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n  \"COMM\": \"COMMITED\",\n  \"RESV\": \"RESERVED\",\n  \"RECV\": \"RECEIVED\",\n  \"ABOR\": \"ABORTED\"\n}\n",
             "type": "string",
             "minLength": 1,
             "maxLength": 4,
-            "example": "SETT"
+            "example": "COMM"
           },
           {
             "description": "Specifies the status of the transaction.\n"
@@ -122335,7 +122371,13 @@
                           }
                         ]
                       }
-                    }
+                    },
+                    "required": [
+                      "Dbtr",
+                      "Cdtr",
+                      "DbtrAgt",
+                      "CdtrAgt"
+                    ]
                   },
                   {
                     "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -136001,7 +136043,13 @@
                           }
                         ]
                       }
-                    }
+                    },
+                    "required": [
+                      "Dbtr",
+                      "Cdtr",
+                      "DbtrAgt",
+                      "CdtrAgt"
+                    ]
                   },
                   {
                     "description": "Underlying Customer Credit Transfer\nTBD\n"
@@ -148940,7 +148988,13 @@
           }
         ]
       }
-    }
+    },
+    "required": [
+      "Dbtr",
+      "Cdtr",
+      "DbtrAgt",
+      "CdtrAgt"
+    ]
   },
   "VerificationReason1Choice": {
     "title": "VerificationReason1Choice",

diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts
@@ -1418,11 +1418,10 @@ export interface components {
          *       "COMM": "COMMITED",
          *       "RESV": "RESERVED",
          *       "RECV": "RECEIVED",
-         *       "ABOR": "ABORTED",
-         *       "SETT": "SETTLED"
+         *       "ABOR": "ABORTED"
          *     }
          *
-         * @example SETT
+         * @example COMM
          */
         ExternalPaymentTransactionStatus1Code: string;
         /**
@@ -3758,10 +3757,10 @@ export interface components {
         /** UnderlyingCustomerCreditTransfer */
         UnderlyingCustomerCreditTransfer: {
             InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"] & unknown;
-            Dbtr?: components["schemas"]["PartyIdentification272"] & unknown;
-            Cdtr?: components["schemas"]["PartyIdentification272"] & unknown;
-            DbtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
-            CdtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+            Dbtr: components["schemas"]["PartyIdentification272"] & unknown;
+            Cdtr: components["schemas"]["PartyIdentification272"] & unknown;
+            DbtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
+            CdtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"] & unknown;
         };
         /**
          * VerificationReason1Choice