From f9deb9010ff02d5d5500555a451ac2f21af7c26c Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 10:41:30 +0100 Subject: [PATCH 01/60] abstracted OBInternalAccountIdentification4Code used twice, now defined once --- dist/openapi/confirmation-funds-openapi.yaml | 36 ++++++++------------ 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/dist/openapi/confirmation-funds-openapi.yaml b/dist/openapi/confirmation-funds-openapi.yaml index 7c3c18c2..1df2b616 100644 --- a/dist/openapi/confirmation-funds-openapi.yaml +++ b/dist/openapi/confirmation-funds-openapi.yaml @@ -672,17 +672,7 @@ components: a confirmation of funds consent will be applied. properties: SchemeName: - description: >- - Name of the identification scheme, in a coded form as - published in an external list. For a full list of values see `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - x-namespaced-enum: - - UK.OBIE.BBAN - - UK.OBIE.IBAN - - UK.OBIE.PAN - - UK.OBIE.Paym - - UK.OBIE.SortCodeAccountNumber - - UK.OBIE.Wallet + $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: description: >- Identification assigned by an institution to identify an @@ -715,6 +705,18 @@ components: Proxy: $ref: '#/components/schemas/OBProxy1' additionalProperties: false + OBInternalAccountIdentification4Code: + description: >- + Name of the identification scheme, in a coded form as + published in an external list. For a full list of values see `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + x-namespaced-enum: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + - UK.OBIE.Wallet OBFundsConfirmationConsentResponse1: type: object required: @@ -790,17 +792,7 @@ components: a confirmation of funds consent will be applied. properties: SchemeName: - description: >- - Name of the identification scheme, in a coded form as - published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - x-namespaced-enum: - - UK.OBIE.BBAN - - UK.OBIE.IBAN - - UK.OBIE.PAN - - UK.OBIE.Paym - - UK.OBIE.SortCodeAccountNumber - - UK.OBIE.Wallet + $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: description: >- Identification assigned by an institution to identify an From 5828b6d3a7b4c2be530d4498cc5cd5e3587b8db8 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 12:50:23 +0100 Subject: [PATCH 02/60] Update OBInternalConsentStatus1Code description formatting Reformatted the description for OBInternalConsentStatus1Code in the OpenAPI spec to use a block style and improved readability by separating the link from the main text. --- dist/openapi/vrp-openapi.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 72e7a728..1faf06f0 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1047,9 +1047,10 @@ components: Meta: $ref: '#/components/schemas/Meta' OBInternalConsentStatus1Code: - description: >- - Specifies the status of consent resource in code form. AWAU and - RJCT only can returned on initial submission. For a full list of values see `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + description: | + Specifies the status of consent resource in code form. AWAU and RJCT only can returned on initial submission. + + For a full list of values see `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - AWAU From 9038c536bc87a868f5e6887b311d86a3e918aaf1 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 12:52:05 +0100 Subject: [PATCH 03/60] Abstracted ReadRefundAccount to use OBInternalReadRefundAccount1Code Replaced inline enum definition for ReadRefundAccount with a reference to OBInternalReadRefundAccount1Code schema. This improves reusability and consistency in the OpenAPI specification. --- dist/openapi/vrp-openapi.yaml | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 1faf06f0..2a86617a 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1001,13 +1001,7 @@ components: - Initiation properties: ReadRefundAccount: - type: string - enum: - - 'Yes' - - 'No' - description: > - Indicates whether information about RefundAccount should be - included in the payment response. + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' ConsentId: type: string minLength: 1 @@ -1046,6 +1040,12 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + OBInternalReadRefundAccount1Code: + description: "Indicates whether the `RefundAccount` object should be included in the response" + type: string + enum: + - 'Yes' + - 'No' OBInternalConsentStatus1Code: description: | Specifies the status of consent resource in code form. AWAU and RJCT only can returned on initial submission. @@ -1071,12 +1071,7 @@ components: - Initiation properties: ReadRefundAccount: - type: string - enum: - - 'Yes' - - 'No' - description: > - Indicates whether the `RefundAccount` object should be included in the response + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' ControlParameters: $ref: '#/components/schemas/OBDomesticVRPControlParameters' Initiation: From f71bbe527ca0a370462b48ad72ed04c5a768af6d Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 13:03:02 +0100 Subject: [PATCH 04/60] Update PeriodType description in OpenAPI spec Moved and revised the description for the PeriodType property in the OpenAPI YAML to improve clarity and placement. --- dist/openapi/vrp-openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 2a86617a..07528720 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1108,6 +1108,7 @@ components: - Currency properties: PeriodType: + description: "Period type for this period limit" type: string enum: - Day @@ -1116,7 +1117,6 @@ components: - Month - Half-year - Year - description: ^ Period type for this period limit PeriodAlignment: type: string enum: From e1f3b915aef8e06564f8428480de1055e179a0a2 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 13:38:01 +0100 Subject: [PATCH 05/60] Update PeriodAlignment description in OpenAPI spec Moved and reformatted the description for the PeriodAlignment field in the OpenAPI YAML to improve clarity and maintain consistency with other schema definitions. --- dist/openapi/vrp-openapi.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 07528720..2920b5a8 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1118,12 +1118,14 @@ components: - Half-year - Year PeriodAlignment: + description: >- + Specifies whether the period starts on the date of consent creation or lines up with a calendar. As + the ISO calendar does not support or provide any guidance on when a fortnight should start, a + `PeriodType` of `Fortnight` the `PeriodAlignment` must be `Consent`. type: string enum: - Consent - Calendar - description: >- - Specifies whether the period starts on the date of consent creation or lines up with a calendar. As the ISO calendar does not support or provide any guidance on when a fortnight should start, a `PeriodType` of `Fortnight` the `PeriodAlignment` must be `Consent`. Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: From d0bace7d283196a457c2160618d3271135eda306 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 17:50:24 +0100 Subject: [PATCH 06/60] Abstract ExternalPaymentTransactionStatus1Code Replaced inline Status enum definition with a reference to a new ExternalPaymentTransactionStatus1Code schema. This improves maintainability and reusability by centralizing the status code definitions. --- dist/openapi/vrp-openapi.yaml | 38 ++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 2920b5a8..37bd6430 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1360,22 +1360,7 @@ components: description: | Date and time at which the resource was created. Status: - type: string - description: Specifies the status of the payment information group. For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - RCVD - - RJCT - - CANC - - PDNG - - ACTC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK + $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusReason: type: array items: @@ -1427,6 +1412,27 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + ExternalPaymentTransactionStatus1Code: + type: string + description: | + Specifies the status of the payment information group. + + For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* + [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - RCVD + - RJCT + - CANC + - PDNG + - ACTC + - ACCP + - ACFC + - ACSP + - ACWC + - ACSC + - ACWP + - ACCC + - BLCK OBDomesticVRPDetails: type: object required: From 1b6680a94a57e4c1c48d24a6e4d7cd6260756249 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:06:40 +0100 Subject: [PATCH 07/60] abstract OBDomesesticVPRDetails Status and overwrite description Updated the Status fields in the OpenAPI YAML to use allOf with schema references and added inline descriptions. This improves schema reusability and documentation clarity for payment and transfer status fields. --- dist/openapi/vrp-openapi.yaml | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 37bd6430..aac71eab 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1360,7 +1360,9 @@ components: description: | Date and time at which the resource was created. Status: - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' + - description: Specifies the status of the payment information group. StatusReason: type: array items: @@ -1457,23 +1459,9 @@ components: description: |- Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. Status: - type: string - description: |- - Status of a transfer, as assigned by the transaction administrator. - enum: - - RCVD - - RJCT - - CANC - - PDNG - - ACTC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK + allOf: + - $ref: '#/components/schemas/OBInternalConsentStatus1Code' + - description: Status of a transfer, as assigned by the transaction administrator. StatusUpdateDateTime: type: string format: date-time From b1fa654bdbc237e24a0ef6de73b30f24c5fc359b Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:25:17 +0100 Subject: [PATCH 08/60] remove un-used enum schema `OBExternalStatus2Code` --- dist/openapi/vrp-openapi.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index aac71eab..c34308a9 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1646,12 +1646,6 @@ components: properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' - OBExternalStatus2Code: - type: string - enum: - - AUTH - - AWAU - - RJCT OBInternalChargeBearerType1Code: type: string description: >- From 06638111b9cc24b162aa8b48a83c601dd63ec7cf Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:29:05 +0100 Subject: [PATCH 09/60] remove un-used enum schema `OBExternalCreditorReferenceType1Code` --- dist/openapi/vrp-openapi.yaml | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index c34308a9..87a24d74 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1712,18 +1712,6 @@ components: description: > Additional information that can not be captured in the structured fields and/or any other specific block. - OBExternalCreditorReferenceType1Code: - type: string - minLength: 1 - maxLength: 4 - description: "Specifies the type of creditor reference as published in an external creditor reference type code set.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`DISP`-Document is a dispatch advice.\n*`FXDR`-Document is a pre-agreed or pre-arranged foreign exchange transaction to which the payment transaction refers.\n*`PUOR`-Document is a purchase order.\n*`RPIN`-Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.\n*`RADM`-Document is a remittance advice sent separately from the current transaction.\n*`SCOR`-Document is a structured communication reference provided by the creditor to identify the referred transaction." - enum: - - DISP - - FXDR - - PUOR - - RPIN - - RADM - - SCOR ExternalDocumentType1Code: type: string minLength: 1 From 429e4597f6306fc2de5ddb59aa58a98b377a1404 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:30:32 +0100 Subject: [PATCH 10/60] better formatting for OBInternalLocalInstrument1Code description --- dist/openapi/vrp-openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 87a24d74..58edeb93 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1918,7 +1918,7 @@ components: - Wealth OBInternalLocalInstrument1Code: type: string - description: >- + description: | User community specific instrument. Usage: This element is used to specify a local instrument, local From 12a68e4cefc9530baa026c0e2a86d1d1358c5342 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:31:55 +0100 Subject: [PATCH 11/60] Remove un-used OBAddressTypeCode from OpenAPI spec Deleted the OBAddressTypeCode definition from the OpenAPI YAML file, likely due to deprecation or replacement by OBAddressType2Code. --- dist/openapi/vrp-openapi.yaml | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 58edeb93..14b5c8f1 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -2384,18 +2384,6 @@ components: maxLength: 70 minItems: 0 maxItems: 7 - OBAddressTypeCode: - description: Identifies the nature of the postal address. - type: string - enum: - - Business - - Correspondence - - DeliveryTo - - MailTo - - POBox - - Postal - - Residential - - Statement OBAddressType2Code: description: >- Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). From 279e019f0bd403bb08cf53850fcf6baa7d5d53c8 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:33:24 +0100 Subject: [PATCH 12/60] Refactor DebitCreditReportingIndicator schema reference Replaced inline definition of DebitCreditReportingIndicator with a reference to OBExternalRegulatoryReportingType1Code. Added OBExternalRegulatoryReportingType1Code schema to improve reusability and maintainability. --- dist/openapi/vrp-openapi.yaml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 14b5c8f1..3f91f5da 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -2414,15 +2414,7 @@ components: description: Information needed due to regulatory and statutory requirements properties: DebitCreditReportingIndicator: - type: string - description: >- - Identifies whether the regulatory reporting information applies to - the debit side, to the credit side or to both debit and credit sides - of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - CRED - - DEBT - - BOTH + $ref: '#/components/schemas/OBExternalRegulatoryReportingType1Code' Authority: $ref: '#/components/schemas/OBRegulatoryAuthority2' Details: @@ -2430,6 +2422,16 @@ components: type: array items: $ref: '#/components/schemas/OBStructuredRegulatoryReporting3' + OBExternalRegulatoryReportingType1Code: + type: string + description: >- + Identifies whether the regulatory reporting information applies to + the debit side, to the credit side or to both debit and credit sides + of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - CRED + - DEBT + - BOTH OBStatusReason: type: object properties: From 616c0b5cfbd01fd12f3ef4e95b794a1baad48ffe Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:33:58 +0100 Subject: [PATCH 13/60] Remove un-used OBVRPStatusReasonCode from OpenAPI spec Deleted the OBVRPStatusReasonCode definition from the OpenAPI YAML file, including its type, enum values, and description. This streamlines the specification and removes an unused or deprecated component. --- dist/openapi/vrp-openapi.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 3f91f5da..b24f6a65 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -2574,14 +2574,6 @@ components: type: string pattern: ^[A-Z]{2,2}$ description: Nation with its own government. - OBVRPStatusReasonCode: - type: string - x-namespaced-enum: - - UK.OBIE.ExemptionNotApplied - - UK.OBIE.OtherReason - description: > - Reason Code provided for the status of a VRP. To be documented in the - Developer Portal. OBVRPConsentType: type: string x-namespaced-enum: From 5fe7f6034942ed4244487334092863ca29b9ff11 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:35:29 +0100 Subject: [PATCH 14/60] Refactor PaymentContextCode to use schema reference Replaced inline definition of PaymentContextCode with a reference to OBInternalPaymentContext1Code schema in the OpenAPI spec. This improves maintainability and consistency by centralizing the enum definition. --- dist/openapi/vrp-openapi.yaml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index b24f6a65..bef6929e 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -2598,16 +2598,7 @@ components: additionalProperties: false properties: PaymentContextCode: - type: string - description: | - Specifies the payment context, for a full list of values refer to `OBInternalPaymentContext1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - BillingGoodsAndServicesInAdvance - - BillingGoodsAndServicesInArrears - - EcommerceMerchantInitiatedPayment - - FaceToFacePointOfSale - - TransferToSelf - - TransferToThirdParty + $ref: '#/components/schemas/OBInternalPaymentContext1Code' MerchantCategoryCode: type: string minLength: 3 @@ -2639,6 +2630,17 @@ components: description: |- The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. + OBInternalPaymentContext1Code: + type: string + description: | + Specifies the payment context, for a full list of values refer to `OBInternalPaymentContext1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - BillingGoodsAndServicesInAdvance + - BillingGoodsAndServicesInArrears + - EcommerceMerchantInitiatedPayment + - FaceToFacePointOfSale + - TransferToSelf + - TransferToThirdParty Links: required: - Self From a61038ddd19b4a24f94764545411d8f44eaad461 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 23 Oct 2025 18:36:07 +0100 Subject: [PATCH 15/60] Update description for ExternalProxyAccountType1Code Reformatted the description for ExternalProxyAccountType1Code in the OpenAPI spec to use YAML block style and improved readability. --- dist/openapi/vrp-openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index bef6929e..f628ce18 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -880,10 +880,10 @@ components: minLength: 1 maxLength: 35 ExternalProxyAccountType1Code: - description: >- - Specifies the external proxy account type code, as published in the - proxy account type external code set.
For a - full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* + description: | + Specifies the external proxy account type code, as published in the proxy account type external code set. + + For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: From ecb05a57502868eb01cb369160256dc7ddd50cff Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 09:26:22 +0100 Subject: [PATCH 16/60] remove un-used schema `OBExternalAccountType1Code` --- dist/openapi/vrp-openapi.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index f628ce18..298cd2e4 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1891,12 +1891,6 @@ components: type: string x-namespaced-enum: - UK.OBIE.BICFI - OBExternalAccountType1Code: - description: Specifies the type of account (personal or business). - type: string - enum: - - Business - - Personal OBInternalExtendedAccountType1Code: description: Specifies the extended type of account if known. For a full set of values refer to `OBInternalExtendedAccountType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string From 1f0e0e2c3b9616986182e9aa7f72b17d98ab4634 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 09:48:44 +0100 Subject: [PATCH 17/60] Remove un-used schema `OBPaymentStatusReason` --- dist/openapi/payment-initiation-openapi.yaml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 1788a7a9..fceef8b7 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4124,17 +4124,6 @@ components: type: string maxLength: 256 minLength: 1 - OBPaymentStatusReason: - type: object - properties: - StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form - For more information and enum values see `OBExternalStatusReason1Code [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. From 63466fc704c420f0d7f5bc8260c334b51eaeac24 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 09:52:40 +0100 Subject: [PATCH 18/60] Remove un-used schema `OBAddressTypeCode` --- dist/openapi/payment-initiation-openapi.yaml | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index fceef8b7..52739f78 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -3418,18 +3418,6 @@ components: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' - OBAddressTypeCode: - description: Identifies the nature of the postal address. - type: string - enum: - - Business - - Correspondence - - DeliveryTo - - MailTo - - POBox - - Postal - - Residential - - Statement OBAddressType2Code: description: >- Identifies the nature of the postal address. For a full set of codes see From 80bcdc2c84ce1306f6cce680c94e39b52827af54 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 09:56:32 +0100 Subject: [PATCH 19/60] abstract OBExternalRegulatoryReportingType1Code schema Replaced inline definition of DebitCreditReportingIndicator with a reference to OBExternalRegulatoryReportingType1Code and added its schema to components. This improves reusability and consistency in the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 22 +++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 52739f78..1c056288 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4332,22 +4332,24 @@ components: description: Information needed due to regulatory and statutory requirements properties: DebitCreditReportingIndicator: - type: string - description: >- - Identifies whether the regulatory reporting information applies to - the debit side, to the credit side or to both debit and credit sides - of the transaction. - For a full list of values reefer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - CRED - - DEBT - - BOTH + $ref: '#/components/schemas/OBExternalRegulatoryReportingType1Code' Authority: $ref: '#/components/schemas/OBRegulatoryAuthority2' Details: type: array items: $ref: '#/components/schemas/OBStructuredRegulatoryReporting3' + OBExternalRegulatoryReportingType1Code: + type: string + description: >- + Identifies whether the regulatory reporting information applies to + the debit side, to the credit side or to both debit and credit sides + of the transaction. + For a full list of values reefer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - CRED + - DEBT + - BOTH OBRisk1: type: object additionalProperties: false From 8455970453ac361eba171dcdebba1f4f2b449163 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 09:58:04 +0100 Subject: [PATCH 20/60] Refactor PaymentContextCode to use schema reference Replaced inline PaymentContextCode definition with a $ref to OBInternalPaymentContext1Code schema in the OpenAPI spec. Added OBInternalPaymentContext1Code schema to centralize enum values and improve maintainability. --- dist/openapi/payment-initiation-openapi.yaml | 22 +++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 1c056288..395df2cc 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4355,16 +4355,7 @@ components: additionalProperties: false properties: PaymentContextCode: - type: string - description: | - Specifies the payment context, `OBInternalPaymentContext1Code` - enum: - - BillingGoodsAndServicesInAdvance - - BillingGoodsAndServicesInArrears - - EcommerceMerchantInitiatedPayment - - FaceToFacePointOfSale - - TransferToSelf - - TransferToThirdParty + $ref: '#/components/schemas/OBInternalPaymentContext1Code' MerchantCategoryCode: type: string minLength: 3 @@ -4396,6 +4387,17 @@ components: description: |- The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. + OBInternalPaymentContext1Code: + type: string + description: | + Specifies the payment context, `OBInternalPaymentContext1Code` + enum: + - BillingGoodsAndServicesInAdvance + - BillingGoodsAndServicesInArrears + - EcommerceMerchantInitiatedPayment + - FaceToFacePointOfSale + - TransferToSelf + - TransferToThirdParty OBSCASupportData1: type: object properties: From 5566ebd8027e270e7937e4282e93c5ae92437d92 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 11:41:01 +0100 Subject: [PATCH 21/60] abstracted OBInternalSCAExemptionType1Code Replaced inline enum for RequestedSCAExemptionType with a $ref to OBInternalSCAExemptionType1Code schema. This improves maintainability and consistency by centralizing the definition of SCA exemption types. --- dist/openapi/payment-initiation-openapi.yaml | 26 +++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 395df2cc..010ed76d 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4402,18 +4402,7 @@ components: type: object properties: RequestedSCAExemptionType: - type: string - description: >- - This field allows a PISP to request specific SCA Exemption for a - Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - BillPayment - - ContactlessTravel - - EcommerceGoods - - EcommerceServices - - Kiosk - - Parking - - PartyToParty + $ref: '#/components/schemas/OBInternalSCAExemptionType1Code' AppliedAuthenticationApproach: type: string maxLength: 40 @@ -4438,6 +4427,19 @@ components: same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId description: Supporting Data provided by TPP, when requesting SCA Exemption. + OBInternalSCAExemptionType1Code: + type: string + description: >- + This field allows a PISP to request specific SCA Exemption for a + Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty OBStatusReason: type: object properties: From ad4824a82538a6ad68a3a13c95cfb10e01ab235f Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 11:44:53 +0100 Subject: [PATCH 22/60] Refactor AuthorisationType to use schema reference Replaced inline enum definitions for AuthorisationType with a reference to the OBInternalAuthorisation1Code schema in multiple components. This improves maintainability and consistency by centralizing the enum definition. --- dist/openapi/payment-initiation-openapi.yaml | 36 ++++++-------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 010ed76d..f166e10b 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4869,11 +4869,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full set of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -4890,6 +4886,12 @@ components: $ref: '#/components/schemas/OBSCASupportData1' Risk: $ref: '#/components/schemas/OBRisk1' + OBInternalAuthorisation1Code: + description: Type of authorisation flow requested. For a full set of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - Any + - Single OBWriteDomesticConsentResponse5: type: object additionalProperties: false @@ -5175,11 +5177,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -5961,11 +5959,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -6270,11 +6264,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -6981,11 +6971,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must From 1d2e6877688d9ce8fae4b311fa49a0b914abf61a Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 11:52:58 +0100 Subject: [PATCH 23/60] Refactor ReadRefundAccount to use schema reference Introduced OBInternalReadRefundAccount1Code schema and updated all ReadRefundAccount properties to reference it instead of duplicating type, description, and enum. This improves maintainability and consistency across the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 41 +++++++------------- 1 file changed, 14 insertions(+), 27 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index f166e10b..1488b864 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4681,6 +4681,15 @@ components: $ref: '#/components/schemas/OBSupplementaryData1' Risk: $ref: '#/components/schemas/OBRisk1' + OBInternalReadRefundAccount1Code: + description: | + Specifies to share the refund account details with PISP. + + For a full set of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - 'No' + - 'Yes' OBWriteDomesticConsent4: type: object additionalProperties: false @@ -4695,11 +4704,7 @@ components: - Initiation properties: ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full set of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -4946,13 +4951,7 @@ components: type: string format: date-time ReadRefundAccount: - description: >- - Specifies to share the refund account details with PISP. - For a full list of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -5786,11 +5785,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -6036,11 +6031,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -6829,11 +6820,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false From 9cd0bc90c3b81ff3b0cf1f7f38381c50d7d24037 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Fri, 24 Oct 2025 12:16:16 +0100 Subject: [PATCH 24/60] Refactor payment status schema to use shared reference Replaces repeated enum definitions for payment status codes with a reference to the shared ExternalPaymentTransactionStatus1Code schema in the OpenAPI spec. This improves maintainability and ensures consistency across payment-related components. --- dist/openapi/payment-initiation-openapi.yaml | 107 ++++--------------- 1 file changed, 21 insertions(+), 86 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 1488b864..79cb44a6 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -5209,6 +5209,12 @@ components: - RJCT - AUTH - COND + ExternalPaymentTransactionStatus1Code: + description: >- + Specifies the status of the payment information group. + For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' OBWriteDomesticResponse5: type: object additionalProperties: false @@ -5252,24 +5258,11 @@ components: type: string format: date-time Status: - description: >- + description: >- Specifies the status of the payment information group. For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - RCVD - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates @@ -6322,21 +6315,8 @@ components: format: date-time Status: description: Specifies the status of the payment order resource. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - RCVD - - CANC - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - BLCK - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates @@ -7282,16 +7262,8 @@ components: format: date-time Status: description: Specifies the status of the payment order resource. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - RCVD - - CANC - - ACTC - - PATC - - PDNG - - INFA - - INCO - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates @@ -8106,11 +8078,8 @@ components: format: date-time Status: description: Specifies the status of the payment order resource. See `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) for more information. - type: string - enum: - - INFA - - INCO - - PDNG + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates @@ -12328,16 +12297,8 @@ components: format: date-time Status: description: Specifies the status of resource in code form. For a list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - RCVD - - CANC - - ACTC - - PATC - - PDNG - - INFA - - INCO - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates @@ -12706,23 +12667,11 @@ components: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. Status: - type: string description: >- Status of a transfer, as assigned by the transaction administrator. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: type: string format: date-time @@ -12738,22 +12687,8 @@ components: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' Status: description: "Status of a transfer, as assigned by the transaction administrator. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" - type: string - minLength: 1 - maxLength: 4 - enum: - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusReason: description: "Reason Code provided for the status of a transfer. For a full list of values see code values for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" type: string From e60550fc19a27c581a8159c25d89e0b67a979ba4 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 09:34:58 +0000 Subject: [PATCH 25/60] Refactor AppliedAuthenticationApproach schema reference Replaces the inline definition of AppliedAuthenticationApproach with a reference to the new OBInternalAppliedAuthenticationApproach1Code schema. This change improves schema reusability and consistency by centralizing the enum and description. --- dist/openapi/payment-initiation-openapi.yaml | 26 +++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 79cb44a6..63c2a62c 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4404,18 +4404,7 @@ components: RequestedSCAExemptionType: $ref: '#/components/schemas/OBInternalSCAExemptionType1Code' AppliedAuthenticationApproach: - type: string - maxLength: 40 - description: >- - Specifies a character string with a maximum length of 40 characters. - - Usage: This field indicates whether the PSU was subject to SCA - performed by the TPP - - For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - CA - - SCA + $ref: '#/components/schemas/OBInternalAppliedAuthenticationApproach1Code' ReferencePaymentOrderId: type: string maxLength: 40 @@ -4427,6 +4416,19 @@ components: same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId description: Supporting Data provided by TPP, when requesting SCA Exemption. + OBInternalAppliedAuthenticationApproach1Code: + type: string + maxLength: 40 + description: >- + Specifies a character string with a maximum length of 40 characters. + + Usage: This field indicates whether the PSU was subject to SCA + performed by the TPP + + For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - CA + - SCA OBInternalSCAExemptionType1Code: type: string description: >- From 5454fb1f0035d9a6bc8dd3e05f333beb8a13caf5 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 09:36:52 +0000 Subject: [PATCH 26/60] Refactor Status property to use OBInternalStatus2Code ref Replaced inline enum definition for the Status property with a reference to the OBInternalStatus2Code schema. Added OBInternalStatus2Code schema to centralize the status code definitions and improve maintainability. --- dist/openapi/payment-initiation-openapi.yaml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 63c2a62c..571bb259 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -5533,12 +5533,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. For a full list of values refer to `OBInternalStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -5577,6 +5572,13 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + OBInternalStatus2Code: + description: Specifies the status of the authorisation flow in code form. For a full list of values refer to `OBInternalStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - AUTH + - AWAF + - RJCT OBWriteDomesticScheduled2: type: object additionalProperties: false From 5c949c1ac274f84132e0cf5db81da32ccccd3a74 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 09:40:22 +0000 Subject: [PATCH 27/60] Refactor Permission property to use OBInternalPermissions2Code ref Replaces inline Permission property definitions with a reference to the new OBInternalPermissions2Code schema in multiple components. This improves maintainability and consistency by centralizing the enum and description for Open Banking service request types. --- dist/openapi/payment-initiation-openapi.yaml | 25 +++++++------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 571bb259..a8766d5d 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -5777,10 +5777,7 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: @@ -5968,6 +5965,11 @@ components: $ref: '#/components/schemas/OBSCASupportData1' Risk: $ref: '#/components/schemas/OBRisk1' + OBInternalPermissions2Code: + description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - Create OBWriteDomesticScheduledConsentResponse5: type: object additionalProperties: false @@ -6023,10 +6025,7 @@ components: items: $ref: '#/components/schemas/OBStatusReason' Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: @@ -6799,10 +6798,7 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: @@ -7014,10 +7010,7 @@ components: items: $ref: '#/components/schemas/OBStatusReason' Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string From ecb08cb2b1b6ccc4841294b7b2c67508b8ffb147 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 09:52:16 +0000 Subject: [PATCH 28/60] Refactor Status property to use OBInternalStatus2Code ref Replaces inline enum definition for the Status property in multiple authorisation flow response objects with a reference to the OBInternalStatus2Code schema. This change improves consistency and maintainability of the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 42 +++----------------- 1 file changed, 6 insertions(+), 36 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index a8766d5d..4d3f5670 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -6587,12 +6587,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -7473,12 +7468,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -8230,12 +8220,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -9832,12 +9817,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -11467,12 +11447,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -12588,12 +12563,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total From d4c62452cea331368ea1b52843b3f3c4bf4a4dd6 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 09:53:44 +0000 Subject: [PATCH 29/60] Refactor ReadRefundAccount schema reference Updated the ReadRefundAccount property in the OpenAPI spec to reference the OBInternalReadRefundAccount1Code schema instead of defining enum values inline. This improves maintainability and consistency with other schema references. --- dist/openapi/payment-initiation-openapi.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 4d3f5670..632fc0d5 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -7007,11 +7007,7 @@ components: Permission: $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All From 8ab7ea2b07fa887bbfb51af7c9660af50fadea00 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 09:56:44 +0000 Subject: [PATCH 30/60] Refactor AuthorisationType to use schema reference Replaces inline AuthorisationType enum definitions with a reference to the OBInternalAuthorisation1Code schema in multiple components. This change improves consistency and maintainability of the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 54 ++++---------------- 1 file changed, 9 insertions(+), 45 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 632fc0d5..5ee4bc52 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -7179,11 +7179,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -7763,11 +7759,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -7983,11 +7975,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -8844,11 +8832,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -9287,11 +9271,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -10438,11 +10418,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -10903,11 +10879,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -11892,11 +11864,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -12194,11 +12162,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must From b97b0d756cbf280a0b1f9edd2f835324d4051f48 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 10:00:06 +0000 Subject: [PATCH 31/60] Refactor FileType to use OBExternalFileType1Code schema Replaces inline FileType definitions with a reference to the new OBExternalFileType1Code schema in multiple components. This change centralizes the file type specification and improves maintainability of the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 30 +++++++------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 5ee4bc52..1de493fe 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -7531,11 +7531,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -7629,6 +7625,12 @@ components: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' + OBExternalFileType1Code: + description: Specifies the payment file type. + type: string + x-namespaced-enum: + - UK.OBIE.PaymentInitiation.4.0 + - UK.OBIE.pain.001.001.08 OBWriteFileConsent3: type: object additionalProperties: false @@ -7653,11 +7655,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -7869,11 +7867,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -8098,11 +8092,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be From 72ff919ccf3418fb02556d25d57f97ed8497a2c5 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:02:26 +0000 Subject: [PATCH 32/60] Refactor InstructionPriority to use OBInternalPriority2Code Introduced OBInternalPriority2Code schema for instruction priority and updated all relevant references to use this new schema. This change centralizes the definition of instruction priority, improving maintainability and consistency across the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 81 ++++---------------- 1 file changed, 17 insertions(+), 64 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 1de493fe..c3fdba0b 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -8274,6 +8274,15 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + OBInternalPriority2Code: + description: >- + Indicator of the urgency or order of importance that the + instructing party would like the instructed party to apply + to the processing of the instruction. + type: string + enum: + - Normal + - Urgent OBWriteInternational3: type: object additionalProperties: false @@ -8343,14 +8352,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -8613,14 +8615,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -9052,14 +9047,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -9574,14 +9562,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -9892,14 +9873,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -10184,14 +10158,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -10645,14 +10612,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -11181,14 +11141,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when From 6a0dc36d0da3cff7de4a407166a5cafb247b887c Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:05:13 +0000 Subject: [PATCH 33/60] Refactor RateType to use OBInternalExchangeRateType2Code Introduced OBInternalExchangeRateType2Code schema for currency exchange rate types and updated all RateType references to use this new schema via $ref. This change centralizes the enum definition, improves maintainability, and reduces duplication in the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 109 ++++--------------- 1 file changed, 21 insertions(+), 88 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index c3fdba0b..dd2592ad 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -8283,6 +8283,15 @@ components: enum: - Normal - Urgent + OBInternalExchangeRateType2Code: + description: >- + Specifies the type used to complete the currency + exchange. + type: string + enum: + - Actual + - Agreed + - Indicative OBWriteInternational3: type: object additionalProperties: false @@ -8420,14 +8429,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -8683,14 +8685,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -8973,12 +8968,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9115,14 +9105,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9488,12 +9471,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9630,14 +9608,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9956,14 +9927,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10241,14 +10205,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10537,12 +10494,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10695,14 +10647,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -11066,12 +11011,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -11224,14 +11164,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange From 3450750a9c1df2b1454859dab38ed1c637b97a9d Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:07:54 +0000 Subject: [PATCH 34/60] Refactor ReadRefundAccount to use schema reference Replaces inline ReadRefundAccount enum definitions with a reference to OBInternalReadRefundAccount1Code schema for consistency and maintainability in the OpenAPI specification. --- dist/openapi/payment-initiation-openapi.yaml | 36 ++++---------------- 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index dd2592ad..5b6dd33d 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -8564,11 +8564,7 @@ components: - Initiation properties: ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -8883,11 +8879,7 @@ components: type: string format: date-time ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -10068,11 +10060,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -10409,11 +10397,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -11550,11 +11534,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -11817,11 +11797,7 @@ components: enum: - Create ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All From f3253d7eca0adbf964c3977da93f2c87c98f4269 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:15:25 +0000 Subject: [PATCH 35/60] Refactor payment status schema references Replaces direct enum definitions for payment status fields with references to the ExternalPaymentTransactionStatus1Code schema, and updates one instance to define the enum directly. This improves consistency and maintainability of status code definitions. --- dist/openapi/payment-initiation-openapi.yaml | 49 ++++++++------------ 1 file changed, 19 insertions(+), 30 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 5b6dd33d..cd16ab86 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -5215,8 +5215,21 @@ components: description: >- Specifies the status of the payment information group. For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - allOf: - - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' + type: string + enum: + - RCVD + - PDNG + - ACTC + - PATC + - ACCP + - ACFC + - ACSP + - ACWC + - ACSC + - ACWP + - ACCC + - BLCK + - RJCT OBWriteDomesticResponse5: type: object additionalProperties: false @@ -9291,20 +9304,8 @@ components: format: date-time Status: description: Specifies the status of the payment information group. - type: string - enum: - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates @@ -10825,20 +10826,8 @@ components: format: date-time Status: description: Specifies the status of the payment order resource. - type: string - enum: - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK - - RJCT + allOf: + - $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: description: >- Date and time at which the resource status was updated. All dates From 0fe76a48251670ee7db0f6788597019fdba700c4 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:17:25 +0000 Subject: [PATCH 36/60] Refactor Permission property to use schema reference Updated the Permission property in multiple components to reference OBInternalPermissions2Code instead of defining an inline enum. This change improves schema consistency and reusability. --- dist/openapi/payment-initiation-openapi.yaml | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index cd16ab86..8c898fb8 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -10056,10 +10056,7 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: @@ -10393,10 +10390,7 @@ components: type: string format: date-time Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: @@ -11518,10 +11512,7 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: From 12ba3b1cd35b932b9c66fe63632ca25b6e42818c Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:18:35 +0000 Subject: [PATCH 37/60] Refactor Permission schema to use OBInternalPermissions2Code Updated the Permission property in the OpenAPI spec to reference OBInternalPermissions2Code instead of defining an inline enum. This change promotes schema reuse and consistency. --- dist/openapi/payment-initiation-openapi.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 8c898fb8..62c9f6ae 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -11772,10 +11772,7 @@ components: type: string format: date-time Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: From 27e56e17f330e89b7bc6fab3fcd1ed8c4b3ac91c Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:40:34 +0000 Subject: [PATCH 38/60] Refactor balance subtype schema references Replaces inline enum definitions for balance subtypes (BCUR, LCUR) with references to OBExternalBalanceSubType1Code schema in multiple components. This improves schema consistency and reusability. --- dist/openapi/account-info-openapi.yaml | 33 +++++++------------------- 1 file changed, 9 insertions(+), 24 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 2db2aff3..371f9619 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -8823,14 +8823,7 @@ components: #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' - SubType: - description: >- - Balance sub type, in a coded form. Default if not specified is BCUR of the account - type: string - enum: - - BCUR - - LCUR - default: BCUR + CreditLine: type: array items: @@ -8891,10 +8884,8 @@ components: SubType: description: >- Balance sub type, in a coded form. Default if not specified is LCUR of the account - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: LCUR minItems: 1 TotalValue: @@ -11655,10 +11646,8 @@ components: description: >- The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: BCUR LocalAmount: type: object @@ -11678,10 +11667,8 @@ components: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: LCUR StatementDateTime: type: array @@ -12033,10 +12020,8 @@ components: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: LCUR StatementDateTime: type: array From 90c9bca6d66cbcadeb6091d493c681c7b5a096f6 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:44:35 +0000 Subject: [PATCH 39/60] Refactor CardSchemeName to use OBInternalCardSchemeType1Code Introduced OBInternalCardSchemeType1Code schema for card scheme names and updated OBTransactionCardInstrument1 to reference this new schema. This change centralizes the card scheme enumeration and improves maintainability. --- dist/openapi/account-info-openapi.yaml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 371f9619..b02d544d 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -12313,6 +12313,17 @@ components: UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' additionalProperties: false + OBInternalCardSchemeType1Code: + description: |- + Name of the card scheme.
+ For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - AmericanExpress + - Diners + - Discover + - MasterCard + - VISA OBTransactionCardInstrument1: type: object required: @@ -12322,16 +12333,7 @@ components: For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) properties: CardSchemeName: - description: |- - Name of the card scheme.
- For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - AmericanExpress - - Diners - - Discover - - MasterCard - - VISA + $ref: '#/components/schemas/OBInternalCardSchemeType1Code' AuthorisationType: description: |- The card authorisation type.
From ed4bb85a2ee937e62abc5fe96fc6d8fea8655aef Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:47:47 +0000 Subject: [PATCH 40/60] Refactor card authorisation type schema in OpenAPI spec Extracted OBInternalCardAuthorisationType1Code as a separate schema and updated OBTransactionCardInstrument1 to reference it. This improves schema reusability and maintainability. --- dist/openapi/account-info-openapi.yaml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index b02d544d..3eab2f3b 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -12324,6 +12324,16 @@ components: - Discover - MasterCard - VISA + OBInternalCardAuthorisationType1Code: + description: |- + The card authorisation type.
+ For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - ConsumerDevice + - Contactless + - None + - PIN OBTransactionCardInstrument1: type: object required: @@ -12335,15 +12345,7 @@ components: CardSchemeName: $ref: '#/components/schemas/OBInternalCardSchemeType1Code' AuthorisationType: - description: |- - The card authorisation type.
- For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - ConsumerDevice - - Contactless - - None - - PIN + $ref: '#/components/schemas/OBInternalCardAuthorisationType1Code' Name: description: Name of the cardholder using the card instrument. type: string From c5ea6a9eb61150b348f67e53a97292c5e217c891 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:48:11 +0000 Subject: [PATCH 41/60] Remove unused OBFrequencyPeriodType from OpenAPI spec Deleted the OBFrequencyPeriodType enum and its description from the OpenAPI YAML file, likely due to deprecation or redundancy. --- dist/openapi/account-info-openapi.yaml | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 3eab2f3b..8b9eb224 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -6338,26 +6338,6 @@ components: - TEND - MOVE - WEEK - OBFrequencyPeriodType: - description: |- - Individual Definitions: - ADHO - Adhoc - YEAR - Annual - DAIL - Daily - INDA - Intra Day - MNTH - Monthly - QURT - Quarterly - WEEK - Weekly - type: string - enum: - - ADHO - - YEAR - - DAIL - - INDA - - MNTH - - QURT - - MIAN - - WEEK OBFileFormat: description: >- For a full list of enumeration values refer to `ExternalDocumentFormat1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) From 22e27715718e9418965a85fb937bb9421c6734c3 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 11:48:43 +0000 Subject: [PATCH 42/60] Remove unused OBExternalStatementInterestRateType1Code enum Deleted the OBExternalStatementInterestRateType1Code definition from the OpenAPI YAML, including its description, type, example, and enum values. --- dist/openapi/account-info-openapi.yaml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 8b9eb224..87066151 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -6266,16 +6266,6 @@ components: - UK.OBIE.Quarterly - UK.OBIE.Weekly - UK.OBIE.Yearly - OBExternalStatementInterestRateType1Code: - description: Description that may be available for the statement Interest rate type. - type: string - example: UK.OBIE.FixedRate - x-namespaced-enum: - - UK.OBIE.BOEBaseRate - - UK.OBIE.FixedRate - - UK.OBIE.Gross - - UK.OBIE.LoanProviderBaseRate - - UK.OBIE.Net OBInternalStatementInterestType1Code: description: Interest amount type, in a coded form. For a full list of values see `OBInternalStatementInterestType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string From 936d7e6b3137ed9514e0a5852a5e8dc76a964bb8 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Tue, 4 Nov 2025 12:01:05 +0000 Subject: [PATCH 43/60] Remove unused OBAddressTypeCode schema from OpenAPI spec Deleted the OBAddressTypeCode schema definition from the OpenAPI YAML file, likely as part of a cleanup or deprecation in favor of OBAddressType2Code. --- dist/openapi/account-info-openapi.yaml | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 87066151..8bdee0ef 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -2893,18 +2893,6 @@ components: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' - OBAddressTypeCode: - description: Identifies the nature of the postal address. - type: string - enum: - - Business - - Correspondence - - DeliveryTo - - MailTo - - POBox - - Postal - - Residential - - Statement OBAddressType2Code: description: >- Identifies the nature of the postal address.
From 12c0e15ee7044639064bf51fc6c88dac165000c6 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:31:10 +0200 Subject: [PATCH 44/60] refactor OBIntermediaryAgentStatus1Code into its own schema --- dist/openapi/account-info-openapi.yaml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 51d92253..781147d1 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -2021,16 +2021,18 @@ components: PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' ProcessingStatus: - description: "Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" - type: string - enum: - - PDNG - - RCVD - - ACSP - - ACSC - - RJCT - - UNKN - - CANC + $ref: '#/components/schemas/OBIntermediaryAgentStatus1Code' + OBIntermediaryAgentStatus1Code: + description: "Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" + type: string + enum: + - PDNG + - RCVD + - ACSP + - ACSC + - RJCT + - UNKN + - CANC ExternalCreditorReferenceType1Code: type: string minLength: 1 From 7ba4d2cec66482ddb41790d5e984bce9a7dca35a Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:34:33 +0200 Subject: [PATCH 45/60] correct codeset reference name --- dist/openapi/confirmation-funds-openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dist/openapi/confirmation-funds-openapi.yaml b/dist/openapi/confirmation-funds-openapi.yaml index b9342e76..d8f85a7a 100644 --- a/dist/openapi/confirmation-funds-openapi.yaml +++ b/dist/openapi/confirmation-funds-openapi.yaml @@ -986,7 +986,7 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `ExternalReturnReason1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string minLength: 4 From 27d9fef391d0f00544c5f6c1ce7c3a9896a563ad Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:36:51 +0200 Subject: [PATCH 46/60] convert to enum --- dist/openapi/confirmation-funds-openapi.yaml | 331 +++++++++++++++++++ 1 file changed, 331 insertions(+) diff --git a/dist/openapi/confirmation-funds-openapi.yaml b/dist/openapi/confirmation-funds-openapi.yaml index d8f85a7a..35e446a0 100644 --- a/dist/openapi/confirmation-funds-openapi.yaml +++ b/dist/openapi/confirmation-funds-openapi.yaml @@ -989,6 +989,337 @@ components: `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR minLength: 4 maxLength: 4 example: U001 From 92190ab7b9d3864427f7d96caa0a06d0c8ff26ae Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:37:16 +0200 Subject: [PATCH 47/60] Update confirmation-funds-openapi.yaml --- dist/openapi/confirmation-funds-openapi.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/dist/openapi/confirmation-funds-openapi.yaml b/dist/openapi/confirmation-funds-openapi.yaml index 35e446a0..035580d1 100644 --- a/dist/openapi/confirmation-funds-openapi.yaml +++ b/dist/openapi/confirmation-funds-openapi.yaml @@ -986,8 +986,7 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `OBExternalStatusReason1Code` - [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - U000 @@ -1320,8 +1319,6 @@ components: - FF13 - DC02 - APAR - minLength: 4 - maxLength: 4 example: U001 OBStatusReason: type: object From 371189c9d5481430511e04dd67063a2f6936b012 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:39:10 +0200 Subject: [PATCH 48/60] use ref for StatusReasonCode --- dist/openapi/confirmation-funds-openapi.yaml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/dist/openapi/confirmation-funds-openapi.yaml b/dist/openapi/confirmation-funds-openapi.yaml index 035580d1..637e7e51 100644 --- a/dist/openapi/confirmation-funds-openapi.yaml +++ b/dist/openapi/confirmation-funds-openapi.yaml @@ -1324,13 +1324,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full list of values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string From 121fe17ad0b8d43bba93c0b4c24af3ba4f3f0d13 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:44:19 +0200 Subject: [PATCH 49/60] fix name and bring in enums for OBExternalStatusReason1Code --- dist/openapi/account-info-openapi.yaml | 335 ++++++++++++++++++++++++- 1 file changed, 332 insertions(+), 3 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 781147d1..9e4cf0f1 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -6560,11 +6560,340 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `ExternalReason1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: AC17 OBMandateRelatedInformation1: type: object From 33e6c5c8eb9119291c930a7ff2420c2995e3c773 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:45:02 +0200 Subject: [PATCH 50/60] remove random white line --- dist/openapi/account-info-openapi.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 9e4cf0f1..429bee13 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -9341,7 +9341,6 @@ components: #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' - CreditLine: type: array items: From ef0de58ce246f7f8c7cf1c5ac87949b236d6c98e Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:45:48 +0200 Subject: [PATCH 51/60] create ref for OBInternalLimitType1Code --- dist/openapi/account-info-openapi.yaml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 429bee13..f30d5eda 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -9360,16 +9360,7 @@ components: in the balance amount of the account. type: boolean Type: - description: >- - Limit type, in a coded form.
- For a full list of enumeration values refer to `OBInternalLimitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Available - - Credit - - Emergency - - Pre-Agreed - - Temporary + $ref: '#/components/schemas/OBInternalLimitType1Code' Amount: type: object required: @@ -9421,6 +9412,17 @@ components: Meta: $ref: '#/components/schemas/Meta' additionalProperties: false + OBInternalLimitType1Code: + description: >- + Limit type, in a coded form.
+ For a full list of enumeration values refer to `OBInternalLimitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - Available + - Credit + - Emergency + - Pre-Agreed + - Temporary OBReadBeneficiary5: type: object required: From 3d871749f726655146f17cd28f74c7bc526749a3 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:48:03 +0200 Subject: [PATCH 52/60] extract OBInternalPermissions1Code into ref --- dist/openapi/account-info-openapi.yaml | 84 +++++++++----------------- 1 file changed, 30 insertions(+), 54 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index f30d5eda..707592ae 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -9453,33 +9453,7 @@ components: Permissions: type: array items: - description: >- - Specifies the Open Banking account access data types.
- This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
- For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - type: string - enum: - - ReadAccountsBasic - - ReadAccountsDetail - - ReadBalances - - ReadBeneficiariesBasic - - ReadBeneficiariesDetail - - ReadDirectDebits - - ReadOffers - - ReadPAN - - ReadParty - - ReadPartyPSU - - ReadProducts - - ReadScheduledPaymentsBasic - - ReadScheduledPaymentsDetail - - ReadStandingOrdersBasic - - ReadStandingOrdersDetail - - ReadStatementsBasic - - ReadStatementsDetail - - ReadTransactionsBasic - - ReadTransactionsCredits - - ReadTransactionsDebits - - ReadTransactionsDetail + $ref: '#/components/schemas/OBInternalPermissions1Code' minItems: 1 ExpirationDateTime: description: >- @@ -9563,33 +9537,7 @@ components: Permissions: type: array items: - description: >- - Specifies the Open Banking account access data types.
- This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
- For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - type: string - enum: - - ReadAccountsBasic - - ReadAccountsDetail - - ReadBalances - - ReadBeneficiariesBasic - - ReadBeneficiariesDetail - - ReadDirectDebits - - ReadOffers - - ReadPAN - - ReadParty - - ReadPartyPSU - - ReadProducts - - ReadScheduledPaymentsBasic - - ReadScheduledPaymentsDetail - - ReadStandingOrdersBasic - - ReadStandingOrdersDetail - - ReadStatementsBasic - - ReadStatementsDetail - - ReadTransactionsBasic - - ReadTransactionsCredits - - ReadTransactionsDebits - - ReadTransactionsDetail + $ref: '#/components/schemas/OBInternalPermissions1Code' minItems: 1 ExpirationDateTime: description: >- @@ -9642,6 +9590,34 @@ components: Meta: $ref: '#/components/schemas/Meta' additionalProperties: false + OBInternalPermissions1Code: + description: >- + Specifies the Open Banking account access data types.
+ This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
+ For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) + type: string + enum: + - ReadAccountsBasic + - ReadAccountsDetail + - ReadBalances + - ReadBeneficiariesBasic + - ReadBeneficiariesDetail + - ReadDirectDebits + - ReadOffers + - ReadPAN + - ReadParty + - ReadPartyPSU + - ReadProducts + - ReadScheduledPaymentsBasic + - ReadScheduledPaymentsDetail + - ReadStandingOrdersBasic + - ReadStandingOrdersDetail + - ReadStatementsBasic + - ReadStatementsDetail + - ReadTransactionsBasic + - ReadTransactionsCredits + - ReadTransactionsDebits + - ReadTransactionsDetail OBInternalConsentStatus1Code: description: Specifies the status of consent resource in code form. type: string From a55ba98b162b06a2e71616f1f1917e25a55c584c Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:49:30 +0200 Subject: [PATCH 53/60] extract OBExternalOfferType1Code into ref --- dist/openapi/account-info-openapi.yaml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 707592ae..e0774bef 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -9706,15 +9706,7 @@ components: minLength: 1 maxLength: 40 OfferType: - description: Offer type, in a coded form. For a full list of values refer to `OBExternalOfferType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - example: LimitIncrease - enum: - - BalanceTransfer - - LimitIncrease - - MoneyTransfer - - Other - - PromotionalRate + $ref: '#/components/schemas/OBExternalOfferType1Code' Description: description: Further details of the offer. type: string @@ -9799,6 +9791,16 @@ components: Meta: $ref: '#/components/schemas/Meta' additionalProperties: false + OBExternalOfferType1Code: + description: Offer type, in a coded form. For a full list of values refer to `OBExternalOfferType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + example: LimitIncrease + enum: + - BalanceTransfer + - LimitIncrease + - MoneyTransfer + - Other + - PromotionalRate OBReadParty2: type: object required: From e51c21c3093a423e7d1b4820f4bff7c2ce4b56a7 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:52:09 +0200 Subject: [PATCH 54/60] refactor OBInternalProductType1Code into ref --- dist/openapi/account-info-openapi.yaml | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index e0774bef..20c8f82a 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -9801,6 +9801,19 @@ components: - MoneyTransfer - Other - PromotionalRate + OBInternalProductType1Code: + description: >- + Descriptive code for the product category. + For a full list refer to `OBInternalProductType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)

+ If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description. + type: string + example: PersonalCurrentAccount + enum: + - BusinessCurrentAccount + - CommercialCreditCard + - Other + - PersonalCurrentAccount + - SMELoan OBReadParty2: type: object required: @@ -9882,18 +9895,7 @@ components: minLength: 1 maxLength: 70 ProductType: - description: >- - Descriptive code for the product category. - For a full list refer to `OBInternalProductType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)

- If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description. - type: string - example: PersonalCurrentAccount - enum: - - BusinessCurrentAccount - - CommercialCreditCard - - Other - - PersonalCurrentAccount - - SMELoan + $ref: '#/components/schemas/OBInternalProductType1Code' MarketingStateId: description: >- Unique and unambiguous identification of a Product From 24bc20d226b449371ea695a27c9474b3708f3ec0 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:52:17 +0200 Subject: [PATCH 55/60] refactor OBExternalStatusReason1Code into ref --- dist/openapi/account-info-openapi.yaml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 20c8f82a..2ed34a87 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -12583,13 +12583,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full description see `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: U004 + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string From a3e6869ec72c33b993cdf571bf0f314616690a85 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:53:56 +0200 Subject: [PATCH 56/60] fix OBExternalStatusReason1Code name and use enum --- dist/openapi/vrp-openapi.yaml | 335 +++++++++++++++++++++++++++++++++- 1 file changed, 332 insertions(+), 3 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index aa5efc34..32de3648 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -1160,11 +1160,340 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `ExternalReturnReason1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: U001 OBDomesticVRPConsentResponse: type: object From 3cd2e4563549820ff71ea853e06dc97b5911c02c Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:58:18 +0200 Subject: [PATCH 57/60] refactor some OBExternalStatusReason1Code into refs --- dist/openapi/vrp-openapi.yaml | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 32de3648..cb54ef8c 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -2795,13 +2795,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form - For more information and enum values see `OBExternalStatusReason1Code [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. @@ -2911,13 +2905,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string From e9624ab153b22bfbd59be39423113e49de0524fd Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 12:59:46 +0200 Subject: [PATCH 58/60] remove duplicate ExternalPaymentTransactionStatus1Code --- dist/openapi/payment-initiation-openapi.yaml | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index ab365163..fba56b43 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -5570,25 +5570,6 @@ components: - RJCT - AUTH - COND - ExternalPaymentTransactionStatus1Code: - description: >- - Specifies the status of the payment information group. - For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - RCVD - - PDNG - - ACTC - - PATC - - ACCP - - ACFC - - ACSP - - ACWC - - ACSC - - ACWP - - ACCC - - BLCK - - RJCT OBWriteDomesticResponse5: type: object additionalProperties: false From 2aa97a18c51dd20b07745be227d87609e0ab8344 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 13:01:22 +0200 Subject: [PATCH 59/60] correct OBInternalErrorResponseError1Code to OBExternalStatusReason1Code --- dist/openapi/payment-initiation-openapi.yaml | 335 ++++++++++++++++++- 1 file changed, 332 insertions(+), 3 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index fba56b43..f4577800 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -4390,11 +4390,340 @@ components: OBInternalErrorResponseError1Code: description: >- Low level textual error code, for all enum values see - `OBInternalErrorResponseError1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: U001 OBFrequency6Code: description: '`OBFrequency6Code` on External Codset Repo' From b0d1b831f482a8b156e14e0fbc8147eaad1b0425 Mon Sep 17 00:00:00 2001 From: cjrobbertse-ob Date: Thu, 11 Dec 2025 13:04:24 +0200 Subject: [PATCH 60/60] rename all instances of OBExternalStatusReason1Code to OBExternalStatusReason1Code --- dist/openapi/payment-initiation-openapi.yaml | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index f4577800..ceda8269 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -3887,7 +3887,7 @@ components: type: object properties: ErrorCode: - $ref: '#/components/schemas/OBInternalErrorResponseError1Code' + $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: description: >- A description of the error that occurred. e.g., 'A mandatory field @@ -4387,7 +4387,7 @@ components: - RETL - DEBT - CRYP - OBInternalErrorResponseError1Code: + OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see `OBExternalStatusReason1Code` @@ -5133,13 +5133,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string @@ -12767,10 +12761,7 @@ components: Status: $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusReason: - description: "Reason Code provided for the status of a transfer. For a full list of values see code values for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" - type: string - minLength: 1 - maxLength: 4 + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Reason provided for the status of a transfer. For a full list of values see the code name entries for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). type: string