Merge pull request #115 from OpenBankingUK/CDRW-4343-Add-CategoryPurp…

…oseCode CDRW-4343 - Add CategoryPurposeCode
OpenBankingUK · Apr 11, 2024 · 70f27a5 · 70f27a5
2 parents 8654885 + fa4692b
commit 70f27a5
Show file tree

Hide file tree

Showing 30 changed files with 2,343 additions and 732 deletions.
diff --git a/dist/openapi/account-info-openapi.json b/dist/openapi/account-info-openapi.json
@@ -6263,6 +6263,56 @@
             "$ref": "#/components/schemas/SecondaryIdentification"
           }
         }
+      },
+       "OBCategoryPurposeCode": {
+        "description" : "Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk.",
+        "type" : "string",
+        "enum" : [
+          "BONU",
+          "CASH",
+          "CBLK",
+          "CCRD",
+          "CGWV",
+          "CIPC",
+          "CONC",
+          "CORT",
+          "DCRD",
+          "DIVI",
+          "DVPM",
+          "EPAY",
+          "FCDT",
+          "FCIN",
+          "FCOL",
+          "GOVT",
+          "GP2P",
+          "HEDG",
+          "ICCP",
+          "IDCP",
+          "INTC",
+          "INTE",
+          "LBOX",
+          "LOAN",
+          "MP2B",
+          "MP2P",
+          "OTHR",
+          "PENS",
+          "RPRE",
+          "RRCT",
+          "RVPM",
+          "SALA",
+          "SECU",
+          "SSBE",
+          "SUPP",
+          "SWEP",
+          "TAXS",
+          "TOPG",
+          "TRAD",
+          "TREA",
+          "VATX",
+          "VOST",
+          "WHLD",
+          "ZABA"
+        ]
       },
       "OBCommunicationMethod" : {
         "description": "Individual Definitions:\nEMAL - Email\nFAXI - Fax\nFILE - File\nONLI - Online\nPOST - Postal Service",
@@ -12970,6 +13020,9 @@
           },
           "SupplementaryData": {
             "$ref": "#/components/schemas/OBSupplementaryData1"
+          },
+          "CategoryPurposeCode":{
+            "$ref": "#/components/schemas/OBCategoryPurposeCode"
           }
         },
         "additionalProperties": false

diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml
@@ -5049,6 +5049,56 @@ components:
           $ref: '#/components/schemas/Name_0'
         SecondaryIdentification:
           $ref: '#/components/schemas/SecondaryIdentification'
+    OBCategoryPurposeCode:
+      description: >-
+        Enumeration of codes that outlines the type of purpose behind a
+        transaction, payment or risk.
+      type: string
+      enum:
+        - BONU
+        - CASH
+        - CBLK
+        - CCRD
+        - CGWV
+        - CIPC
+        - CONC
+        - CORT
+        - DCRD
+        - DIVI
+        - DVPM
+        - EPAY
+        - FCDT
+        - FCIN
+        - FCOL
+        - GOVT
+        - GP2P
+        - HEDG
+        - ICCP
+        - IDCP
+        - INTC
+        - INTE
+        - LBOX
+        - LOAN
+        - MP2B
+        - MP2P
+        - OTHR
+        - PENS
+        - RPRE
+        - RRCT
+        - RVPM
+        - SALA
+        - SECU
+        - SSBE
+        - SUPP
+        - SWEP
+        - TAXS
+        - TOPG
+        - TRAD
+        - TREA
+        - VATX
+        - VOST
+        - WHLD
+        - ZABA
     OBCommunicationMethod:
       description: |-
         Individual Definitions:
@@ -11286,6 +11336,8 @@ components:
           $ref: '#/components/schemas/OBTransactionCardInstrument1'
         SupplementaryData:
           $ref: '#/components/schemas/OBSupplementaryData1'
+        CategoryPurposeCode:
+          $ref: '#/components/schemas/OBCategoryPurposeCode'
       additionalProperties: false
     OBTransaction6Basic:
       type: object

diff --git a/dist/openapi/payment-initiation-openapi.json b/dist/openapi/payment-initiation-openapi.json
@@ -4973,6 +4973,56 @@
         "minLength": 1,
         "maxLength": 16
       },
+      "OBCategoryPurposeCode": {
+        "description" : "Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk.",
+        "type" : "string",
+        "enum" : [
+          "BONU",
+          "CASH",
+          "CBLK",
+          "CCRD",
+          "CGWV",
+          "CIPC",
+          "CONC",
+          "CORT",
+          "DCRD",
+          "DIVI",
+          "DVPM",
+          "EPAY",
+          "FCDT",
+          "FCIN",
+          "FCOL",
+          "GOVT",
+          "GP2P",
+          "HEDG",
+          "ICCP",
+          "IDCP",
+          "INTC",
+          "INTE",
+          "LBOX",
+          "LOAN",
+          "MP2B",
+          "MP2P",
+          "OTHR",
+          "PENS",
+          "RPRE",
+          "RRCT",
+          "RVPM",
+          "SALA",
+          "SECU",
+          "SSBE",
+          "SUPP",
+          "SWEP",
+          "TAXS",
+          "TOPG",
+          "TRAD",
+          "TREA",
+          "VATX",
+          "VOST",
+          "WHLD",
+          "ZABA"
+        ]
+      },
       "CountryCode": {
         "description": "Nation with its own government.",
         "type": "string",
@@ -5416,6 +5466,9 @@
             "maxLength": 4,
             "description": "Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List"
           },
+          "CategoryPurposeCode":{
+            "$ref": "#/components/schemas/OBCategoryPurposeCode"
+          },
           "BeneficiaryAccountType": {
             "$ref": "#/components/schemas/OBExternalExtendedAccountType1Code"
           },

diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml
@@ -3047,6 +3047,55 @@ components:
       type: string
       minLength: 1
       maxLength: 16
+    OBCategoryPurposeCode:
+      description: >-
+        Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk.
+      type: string
+      enum:
+        - BONU
+        - CASH
+        - CBLK
+        - CCRD
+        - CGWV
+        - CIPC
+        - CONC
+        - CORT
+        - DCRD
+        - DIVI
+        - DVPM
+        - EPAY
+        - FCDT
+        - FCIN
+        - FCOL
+        - GOVT
+        - GP2P
+        - HEDG
+        - ICCP
+        - IDCP
+        - INTC
+        - INTE
+        - LBOX
+        - LOAN
+        - MP2B
+        - MP2P
+        - OTHR
+        - PENS
+        - RPRE
+        - RRCT
+        - RVPM
+        - SALA
+        - SECU
+        - SSBE
+        - SUPP
+        - SWEP
+        - TAXS
+        - TOPG
+        - TRAD
+        - TREA
+        - VATX
+        - VOST
+        - WHLD
+        - ZABA
     CountryCode:
       description: Nation with its own government.
       type: string
@@ -3481,6 +3530,8 @@ components:
             Category code, related to the type of services or goods that
             corresponds to the underlying purpose of the payment that conforms
             to Recommended UK Purpose Code in ISO 20022 Payment Messaging List
+        CategoryPurposeCode:
+          $ref: '#/components/schemas/OBCategoryPurposeCode'
         BeneficiaryAccountType:
           $ref: '#/components/schemas/OBExternalExtendedAccountType1Code'
         DeliveryAddress:

diff --git a/dist/openapi/vrp-openapi.json b/dist/openapi/vrp-openapi.json
@@ -1834,6 +1834,56 @@
           }
         }
       },
+      "OBCategoryPurposeCode": {
+        "description" : "Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk.",
+        "type" : "string",
+        "enum" : [
+          "BONU",
+          "CASH",
+          "CBLK",
+          "CCRD",
+          "CGWV",
+          "CIPC",
+          "CONC",
+          "CORT",
+          "DCRD",
+          "DIVI",
+          "DVPM",
+          "EPAY",
+          "FCDT",
+          "FCIN",
+          "FCOL",
+          "GOVT",
+          "GP2P",
+          "HEDG",
+          "ICCP",
+          "IDCP",
+          "INTC",
+          "INTE",
+          "LBOX",
+          "LOAN",
+          "MP2B",
+          "MP2P",
+          "OTHR",
+          "PENS",
+          "RPRE",
+          "RRCT",
+          "RVPM",
+          "SALA",
+          "SECU",
+          "SSBE",
+          "SUPP",
+          "SWEP",
+          "TAXS",
+          "TOPG",
+          "TRAD",
+          "TREA",
+          "VATX",
+          "VOST",
+          "WHLD",
+          "ZABA"
+        ]
+      },
       "OBCharge2": {
         "type": "object",
         "required": [
@@ -2209,6 +2259,9 @@
             "maxLength": 4,
             "description": "Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List"
           },
+          "CategoryPurposeCode":{
+            "$ref": "#/components/schemas/OBCategoryPurposeCode"
+          },
           "BeneficiaryAccountType": {
             "$ref": "#/components/schemas/OBExternalExtendedAccountType1Code"
           },