Skip to content

Releases: OpenBankingUK/read-write-api-specs

v4.0.1

01 Apr 08:31
2011fb5

Choose a tag to compare

Changelog

For v4.0.1 the following approach has been adopted for identifying changes:

  • Known Issues - these are tagged with the KI identifier, e.g. [v40_KI45]
  • Change Requests - these are tagged with the CR number used in the consultations, e.g. [CR4a]
  • EAG/Consultation items - Items included in the consultations are tagged with an identifier representing the consultation period they were introduced, e.g. [v4.0.1 RC 1]
  • Feedback remediation - Technical errata and other minor corrections identified by participants or OBL during the Advanced Information period for Release Candidates 1 and 2 with an appropriate identifier for internal OBL traceability e.g. [CDRW-5006]

Consultations:

v4.0.1 - 2026-04-01

Added

  • [CDRW-5005] Added CRYP to OBExternalPurpose1Code in AIS to align with PIS, where CRYP (CryptoAssets) was already present as part of the CR4a change.
  • [CDRW-5045] Updated all ASPSP endpoints with descriptions describing their use.
  • [v40_KI45] Added LWMH, LXMH, & TWYR to OBFrequency6Code in AIS and PIS
  • [v40_KI45] Added SLCT to OBFrequency2 in AIS
  • [CDRW-4937] Added example values to fromBookingDateTime, toBookingDateTime, fromStatementDateTime and toStatementDateTime.
  • [v40_KI46] Added NONE to OBFrequency2 in AIS
  • [CDRW-4760] Added clarity to file endpoint descriptions regarding ASPSPs specifying available content types. Affects
    200AccountsAccountIdStatementsStatementIdFileRead, 200FilePaymentConsentsConsentIdFileRead, and
    200FilePaymentsFilePaymentIdReportFileRead (#195)
  • [CR7] Added a note to the top-level description of all swagger files about conditional and required fields (#209)
  • [CR4a] CRYP added to ExternalPurpose1Code
  • [CR1] Added the following codes to OBInternalStatementFeeType1Code:
    • UK.OBIE.InstalmentPlan
    • UK.OBIE.ReturnedPayment
  • [CR1] Added the following codes to OBInternalStatementInterestType1Code:
    • UK.OBIE.InstalmentPlan
    • UK.OBIE.MoneyTransfer
  • [v4.x.x Consultation 1] Added rate limit headers to all OpenAPI files
  • [CR2] Introduced a new OBIntermediaryAgent class which can appear up to 3 times in payload as IntermediaryAgent1,
    IntermediaryAgent2 and IntermediaryAgent3.
    • This is used in OBReadTransaction6/Data/Transaction
    • Returning these fields requires use of the ReadTransactionDetail permission
  • [v40_KI25] Deprecated PaymentContextCode values have been reintroduced to VRP and PIS OpenAPI files.
    • For the avoidance of doubt - these values must not be accepted in a new consent and may only be accepted for payment against a v3 VRP consent migrated to v4.
    • They may optionally be returned for a historical payment or consent migrated to v4 when using a GET request.
  • [v40_KI7] OBDomesticRefundAccount1 class definition added to the Payment Initiation and VRP OpenAPI files.
  • [v4.0.1 Draft 1] HTTP 422 has been added as a response code - this should be used when a duplicate Idempotency code is submitted.

Changed

  • [CDRW-5046] Added missing enum values to ExternalDocumentType1Code in AIS: AROI, BOLD, CMCN, SOAC, TSUT, USAR, VCHR
  • [CDRW-4136] Updated ErrorCode $ref name in PIS to use OBExternalStatusReason1Code, matching rest of OpenAPI files (previously used OBInternalErrorResponseError1Code)
  • [CDRW-4960] Updated endpoint summaries and tags to align to usage. This has resulted in Payment Details endpoints now being categorised and listed with their payment type.
  • [CDRW-4909] Improved description formatting for RateLimit-Policy, RateLimit, and x-client-id, to match spec pages formatting.
  • [v40_KI42] Updated location of ExternalDocumentFormat1Code to ISO_External_Codeset in description.
  • [CDRW-5014] Updated example value in Error responses from AC17 to U001 in AIS and Events
  • [v40_KI48] Description for OBReadStatement2/Data/Statement/StatementFee/RateType changed to "This code indicates the specific type of fee rate (e.g., AER, EAR)"
  • [v40_KI48] Description for OBReadStatement2/Data/Statement/StatementInterest/RateType changed to "This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross)"
  • [CDRW-4949] Updated descriptions for fromBookingDateTime, toBookingDateTime, fromStatementDateTime and toStatementDateTime to clarify that the timezone component must not be present, as per the Spec pages.
  • [v40_KI30] Standardized all regex patterns in YAML files to be surrounded by single quotes and on a single line, for robustness, reliability and consistency (#192)
  • [v4.0.1 Draft 1] Updated usages of OBInternalConsentStatus1Code in to use re-usable domain-specific consent status codes (#204).
    Changed codes:
    • Changed to OBInternalConsentStatus2Code in all PIS consents except File Payments
    • Changed to OBInternalConsentStatus3Code in only PIS File Payments consents
  • [v40_KI36] Remap ReferredDocumentAmount from Int32 to OBActiveCurrencyAndAmount_SimpleType in AIS, PIS, & VRP (#205)
  • [v4.0.1 Draft 1] Updated usages of ExternalPaymentTransactionStatus1Code for PIS and VRP to use re-usable endpoint-specific payment
    status codes (#208). Codes changed:
    • ExternalPaymentTransactionStatus1Code used in Domestic Standing Orders and International Standing Orders
    • ExternalPaymentTransactionStatus2Code used in Domestic Scheduled Payments and International Scheduled Payments
    • ExternalPaymentTransactionStatus3Code used in Domestic Payments and International Payments
    • ExternalPaymentTransactionStatus4Code used in File Payments
    • ExternalPaymentTransactionStatus5Code used in Domestic VRP
  • [v4.0.1 Draft 1] Meta and Links have been made conditional in the VRP OpenAPI file.
  • [v40_KI5] VRP OBCashAccountDebtorWithName max length is increased from 70 to 350 characters and is no longer mandatory.
  • [v4.0.1 Draft 1] Updated ReferredDocumentInformation/LineDetails string length to 2048 max characters.
  • [v40_KI7] The Refund field in the Payment Initiation and VRP OpenAPI files has been updated to point to the newly added OBDomesticRefundAccount1 class.

Removed

  • [CDRW-5012] Removed duplicate WEEK from OBFrequency6Code in PIS
  • [CDRW-4765] Remove legacy v3 artefact OBAddressTypeCode from Account Information (#202)
  • [CDRW-4878] Removed x-fapi-financial-id from the Event Notifications OpenAPI file.
  • [v40_KI41] CANC removed from VRP payment status enum list

Fixed

  • [CDRW-4136] Updated description of OBExternalStatusReason1Code to point to correct codeset name in AIS, PIS, CBPII, Events and VRP.
  • [CDRW-5043] Corrected typos and improved description clarity across all OpenAPI specification files:
    • Fixed double word "as as" to "as" in top-level description (AIS, CBPII, Events, PIS, VRP)
    • Corrected "dentification" to "Identification" in multiple field descriptions (AIS)
    • Fixed article usage: "an rate" to "a rate" (AIS), "an servicing" to "a servicing" (AIS, PIS, VRP), and "an Callback" to "a Callback" (Events)
    • Fixed spelling errors: "crebit" to "credit" (AIS), "memebership" to "membership" (AIS), "statments" to "statements" (AIS), "reefer" to "refer" (PIS), "lust" to "list" (VRP)
    • Corrected GitHub URL typo: "External_Interal_CodeSets" to "External_Internal_CodeSets" (Events)
    • Fixed whitespace artifacts in descriptions (removed escaped underscores) (Events)
    • Improved grammar: "AWAU and RJCT only can returned" to "Only AWAU and RJCT can be returned" (VRP)
    • Clarified wording: "can not" to "cannot" (VRP), "this include" to "this includes" (VRP)
  • [CDRW-5053] - Updated rate limit + client ID header information in event-notifications-openapi (TPP endpoint for Event Notification API Specification) to be specific to TPPs and updated description on endpoint to describe use.
  • [CDRW-4729] Fixed typo in PointInTime description from CountPerSide to CountPerPeriod in PIS (#194)
  • [CDRW-4802] Corrected description wording for OBMandateRelatedInformation1/MandateIdentification in PIS (#203)
  • [v40_KI30] Fixed regex patterns to match the spec pages (#192):
    • Fixed missing ^ and $ throughout PIS
    • Fixed \ escaping in AIS

v4.0.1 - Release Candidate 2

04 Feb 15:15

Choose a tag to compare

Pre-release

Changelog

v4.0.1 Release Candidate 2 - 2026-02-04

Added

  • Added LWMH, LXMH, & TWYR to OBFrequency6Code in AIS and PIS
  • Added SLCT to OBFrequency2 in AIS
  • Added example values to fromBookingDateTime, toBookingDateTime, fromStatementDateTime and toStatementDateTime.

Changed

  • Updated example value in Error responses from AC17 to U001 in AIS and Events
  • [CDRW-4948] Description for OBReadStatement2/Data/Statement/StatementFee/RateType changed to "This code indicates the specific type of fee rate (e.g., AER, EAR)"
  • [CDRW-4948] Description for OBReadStatement2/Data/Statement/StatementInterest/RateType changed to "This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross)"
  • [CDRW-4949] Updated descriptions for fromBookingDateTime, toBookingDateTime, fromStatementDateTime and toStatementDateTime to clarify that the timezone component must not be present, as per the Spec pages.

v4.0.1 Release Candidate 1 - 2026-01-05

Added

  • Added NONE to OBFrequency2 in AIS

Removed

  • Removed duplicate WEEK from OBFrequency6Code in PIS

v4.0.1 Draft 1 - 2025-11-20

Added

  • Added clarity to file endpoint descriptions regarding ASPSPs specifying available content types. Affects
    200AccountsAccountIdStatementsStatementIdFileRead, 200FilePaymentConsentsConsentIdFileRead, and
    200FilePaymentsFilePaymentIdReportFileRead (#195)
  • Added a note to the top-level description of all swagger files about conditional and required fields (#209)
  • CRYP added to ExternalPurpose1Code
  • Added the following codes to OBInternalStatementFeeType1Code:
    • UK.OBIE.InstalmentPlan
    • UK.OBIE.ReturnedPayment
  • Added the following codes to OBInternalStatementInterestType1Code:
    • UK.OBIE.InstalmentPlan
    • UK.OBIE.MoneyTransfer
  • Added rate limit headers to all OpenAPI files
  • Introduced a new OBIntermediaryAgent class which can appear up to 3 times in payload as IntermediaryAgent1,
    IntermediaryAgent2 and IntermediaryAgent3.
    • This is used in OBReadTransaction6/Data/Transaction
    • Returning these fields requires use of the ReadTransactionDetail permission
  • Deprecated PaymentContextCode values have been reintroduced to VRP and PIS OpenAPI files.
    • For the avoidance of doubt - these values must not be accepted in a new consent and may only be accepted for
      payment against a v3 VRP consent migrated to v4.
    • They may optionally be returned for a historical payment or consent migrated to v4 when using a GET request.
  • OBDomesticRefundAccount1 class definition added to the Payment Initiation and VRP OpenAPI files.
  • HTTP 422 has been added as a response code - this should be used when a duplicate Idempotency code is submitted.

Changed

  • Standardized all regex patterns in YAML files to be surrounded by single quotes and on a single line, for robustness,
    reliability and consistency (#192)
  • Updated usages of OBInternalConsentStatus1Code in to use re-usable domain-specific consent status codes (#204).
    Changed codes:
    • Changed to OBInternalConsentStatus2Code in all PIS consents except File Payments
    • Changed to OBInternalConsentStatus3Code in only PIS File Payments consents
  • Remap ReferredDocumentAmount from Int32 to OBActiveCurrencyAndAmount_SimpleType in AIS, PIS, & VRP (#205)
  • Updated usages of ExternalPaymentTransactionStatus1Code for PIS and VRP to use re-usable endpoint-specific payment
    status codes (#208). Codes changed:
    • ExternalPaymentTransactionStatus1Code used in Domestic Standing Orders and International Standing Orders
    • ExternalPaymentTransactionStatus2Code used in Domestic Scheduled Payments and International Scheduled Payments
    • ExternalPaymentTransactionStatus3Code used in Domestic Payments and International Payments
    • ExternalPaymentTransactionStatus4Code used in File Payments
    • ExternalPaymentTransactionStatus5Code used in Domestic VRP
  • Meta and Links have been made conditional in the VRP OpenAPI file.
  • VRP OBCashAccountDebtorWithName max length is increased from 70 to 350 characters and is no longer mandatory.
  • Updated ReferredDocumentInformation/LineDetails string length to 2048 max characters.
  • The Refund field in the Payment Initiation and VRP OpenAPI files has been updated to point to the newly added
    OBDomesticRefundAccount1 class.

Removed

  • Remove legacy v3 artefact OBAddressTypeCode from Account Information (#202)
  • Removed x-fapi-financial-id from the Event Notifications OpenAPI file.
  • CANC removed from VRP payment status enum list

Fixed

  • Fixed typo in PointInTime description from CountPerSide to CountPerPeriod in PIS (#194)
  • Corrected description wording for OBMandateRelatedInformation1/MandateIdentification in PIS (#203)
  • Fixed regex patterns to match the spec pages (#192):
    • Fixed missing ^ and $ throughout PIS
    • Fixed \ escaping in AIS

Pull Requests

Read more

v4.0.1 - Release Candidate 1

05 Jan 11:07

Choose a tag to compare

Pre-release

Changelog

v4.0.1 Release Candidate 1 - 2026-01-05

Added

  • Added NONE to OBFrequency2 in AIS

Removed

  • Removed duplicate WEEK from OBFrequency6Code in PIS

v4.0.1 Draft 1 - 2025-11-20

Added

  • Added clarity to file endpoint descriptions regarding ASPSPs specifying available content types. Affects
    200AccountsAccountIdStatementsStatementIdFileRead, 200FilePaymentConsentsConsentIdFileRead, and
    200FilePaymentsFilePaymentIdReportFileRead (#195)
  • Added a note to the top-level description of all swagger files about conditional and required fields (#209)
  • CRYP added to ExternalPurpose1Code
  • Added the following codes to OBInternalStatementFeeType1Code:
    • UK.OBIE.InstalmentPlan
    • UK.OBIE.ReturnedPayment
  • Added the following codes to OBInternalStatementInterestType1Code:
    • UK.OBIE.InstalmentPlan
    • UK.OBIE.MoneyTransfer
  • Added rate limit headers to all OpenAPI files
  • Introduced a new OBIntermediaryAgent class which can appear up to 3 times in payload as IntermediaryAgent1,
    IntermediaryAgent2 and IntermediaryAgent3.
    • This is used in OBReadTransaction6/Data/Transaction
    • Returning these fields requires use of the ReadTransactionDetail permission
  • Deprecated PaymentContextCode values have been reintroduced to VRP and PIS OpenAPI files.
    • For the avoidance of doubt - these values must not be accepted in a new consent and may only be accepted for
      payment against a v3 VRP consent migrated to v4.
    • They may optionally be returned for a historical payment or consent migrated to v4 when using a GET request.
  • OBDomesticRefundAccount1 class definition added to the Payment Initiation and VRP OpenAPI files.
  • HTTP 422 has been added as a response code - this should be used when a duplicate Idempotency code is submitted.

Changed

  • Standardized all regex patterns in YAML files to be surrounded by single quotes and on a single line, for robustness,
    reliability and consistency (#192)
  • Updated usages of OBInternalConsentStatus1Code in to use re-usable domain-specific consent status codes (#204).
    Changed codes:
    • Changed to OBInternalConsentStatus2Code in all PIS consents except File Payments
    • Changed to OBInternalConsentStatus3Code in only PIS File Payments consents
  • Remap ReferredDocumentAmount from Int32 to OBActiveCurrencyAndAmount_SimpleType in AIS, PIS, & VRP (#205)
  • Updated usages of ExternalPaymentTransactionStatus1Code for PIS and VRP to use re-usable endpoint-specific payment
    status codes (#208). Codes changed:
    • ExternalPaymentTransactionStatus1Code used in Domestic Standing Orders and International Standing Orders
    • ExternalPaymentTransactionStatus2Code used in Domestic Scheduled Payments and International Scheduled Payments
    • ExternalPaymentTransactionStatus3Code used in Domestic Payments and International Payments
    • ExternalPaymentTransactionStatus4Code used in File Payments
    • ExternalPaymentTransactionStatus5Code used in Domestic VRP
  • Meta and Links have been made conditional in the VRP OpenAPI file.
  • VRP OBCashAccountDebtorWithName max length is increased from 70 to 350 characters and is no longer mandatory.
  • Updated ReferredDocumentInformation/LineDetails string length to 2048 max characters.
  • The Refund field in the Payment Initiation and VRP OpenAPI files has been updated to point to the newly added
    OBDomesticRefundAccount1 class.

Removed

  • Remove legacy v3 artefact OBAddressTypeCode from Account Information (#202)
  • Removed x-fapi-financial-id from the Event Notifications OpenAPI file.
  • CANC removed from VRP payment status enum list

Fixed

  • Fixed typo in PointInTime description from CountPerSide to CountPerPeriod in PIS (#194)
  • Corrected description wording for OBMandateRelatedInformation1/MandateIdentification in PIS (#203)
  • Fixed regex patterns to match the spec pages (#192):
    • Fixed missing ^ and $ throughout PIS
    • Fixed \ escaping in AIS

v4.0 Update 5

13 Nov 10:34
5af5621

Choose a tag to compare

Changelog for v4.0 Update 5

Please refer to the Known Issues for additional information on the fixes listed below.

[v4.0 Update 5]

Added

  • Added reference to Open License in README.md (#191).
  • Added DCSV to OBFileFormat schema in account-info-openapi. This addresses v40_KI42

Changed

  • v40_KI34 - Update regex for LEI in PIS & VRP
    • Addresses v40_KI34 which aligns the PIS regex for LEI to the spec pages and updates the VRP swagger to include the regex & example.
  • Updated Payment Status enums to match Spec pages.
    • Some payment status codes were present on the Spec pages but not in the swagger.

Fixed

  • Fixed VRP PATCH operation description and schema.
    • The description was appearing in the format field and has been moved to the correct description field. Additonally the request body schemea has been updated to fully reflect RFC 6902.
  • Corrected a regex typo in AIS OB_CodeMnemonic (#189). Related to v40_KI30.
  • Restored Multiple to instances of OBInternalAuthorisation1Code. Addresses Known Issue v40_KI44

v4.0 Update 4

07 Apr 22:58
2881199

Choose a tag to compare

Changelog for v4.0 Update 4

Please refer to the Known Issues for additional information on the fixes listed below.

Changes

  1. v40_KI27 - Add additional enum value to ExternalEntryStatus1Code
    Addresses Known Issue v40_KI27 which adds RJCT to ExternalEntryStatus1Code to support backwards compatibility with previous versions of the spec.
  2. v40_KI28 - Address issues with MandateRelatedInformation
    Addresses Known Issue v40_KI28:
    • Updated MandateRelatedInformation\Frequency\Type to support complex patterns from v3 as well as 4 character ISO codes
    • Adds the following enumeration values to OBFrequency6Code:
      • WODL
      • FOWK
      • TWMH
      • FOMH
      • FIMH
      • ALMH
      • NONE
  3. v40_KI29 - Restore NumberOfPayments to Standing Orders
    Addresses Known Issue v40_KI29 which restores NumberOfPayments to the following areas:
    • OBReadStandingOrder6/Data/StandingOrder/NumberOfPayments
    • OBDomesticStandingOrder3/NumberOfPayments
    • OBInternationalStandingOrder4/NumberOfPayments
  4. v40_KI32 - MultiAuthorisation status codes aligned to Spec pages.
    Addresses Known Issue v40_KI32 where AWAU was present in the MultiAuthorisation enum list. This value has been updated to AWAF

v4.0 Update 3

10 Jan 18:56
b6a61af

Choose a tag to compare

Please refer to the Known Issues for additional information on the fixes listed below.

Changes

  1. v40_KI16 - Multi-auth status updated to AWAF
    • Addresses Known Issue v40_KI16 where File and International payments had AWAU incorrectly listed in the MultiAuthorisation status enum.
  2. v40_KI18 - Add missing RCVD value to OBWriteDomesticResponse5
    • Addresses Known Issue v40_KI18 where RCVD was missing from OBWriteDomesticResponse5 Status enum.
  3. v40_KI19 - Adds missing dash in phone number examples
    • Addresses Known Issue v40_KI19 where the dash "-" is missing from the example phone numbers.
  4. v40_KI22 - Update File Payment FileType enum
    • Addresses Known Issue v40_KI22 where UK.OBIE.PaymentInitiation.4.0 was missing from File Payments FileType enumeration. This replaces UK.OBIE.PaymentInitiation.3.1
  5. v40_KI24 - Update File Payments OBWriteFile2 object
    • Addresses Known Issue v40_KI24 where OBWriteFile2 was missing CredtorAgent from the Initiation object and UltimateDebtor referenced the UltimateCreditor schema.

v4.0 Release 2

19 Sep 10:29
bafb0aa

Choose a tag to compare

Addresses a number of issue identified:

Change Link (if available)
Grammatical fixes addressing missing spaces between sentences
Codeset and repo link added to descriptions for classes and objects
References to ISO_External_CodeSet.csv replaced with ISO_External_CodeSet for consistency across files.
Descriptions updated to match spec pages
Restored OBDomesticVRPDetails to v3 schema but using ISO 20022 Status codes as per v40_KI6 OBDomesticVRPDetails
v40_KI6
Fixed 'ASCP' typo in OBWriteFileResponse3
Updated Standing order status values to match spec page tables Standing order
Updated MultiAuthorisation codeset to OBInternalStatus2Code
Updated payment-details schema to match the revert to v3 schema and aligned enums to ISO 20022 codesets OBWritePaymentDetailsResponse1
Fixed broken GitHub link in OBWritePaymentDetails1 description
Removed 'ACSP' from Standing Order consent response
MandateRelatedInformation added as a mandatory object in Standing Order (both Domestic and International) to address v40_KI10 v40_KI10
Updated Standing Order payment status list to match spec page ordering Standing order
Update Standing Order initiation block to match spec page ordering Standing Order
Added missing AWUP to File payment consent status enum
Aligned Creditor Name length in International payments to spec page size. International Payment Data Sictionary
Removed 'Purpose' from International payments
Aligned Creditor name max length to spec page size
Removed 'Path' field from International Scheduled payments International Scheduled payments
Updated Events server url to v4.0
Removed CreditorAgent from VRP payloads as per KI v319_KI9 v319_KI9
Updated OBWriteInternationalStandingOrderResponse7 Status enum to match specs OBWriteInternationalStandingOrderResponse7
Aligned OBWriteDomesticScheduledResponse5 Status enum to specs OBWriteDomesticScheduledResponse5
Reverted File Payment details to use v3 payment-details response schema with ISO 20022 codes v40_KI6
Updated status enum list for Funds Confirmation consent to match specs CBPII
VRP CreditorAccount/Name (OBCashAccountCreditor3) length updated to 70 to match spec page OBCashAccountCreditor3
VRP - OBCashAccountDebtorWithName updated to remove LEI and add Proxy
Updated AISP OBRisk description to correctly reference Account Information instead of payments
Updated OBBalanceType1Code enum and corrected link
Matched LEI regex to spec page definition
Aligned OBFrequency2Code to codeset listing
Fixed SDHS typo in OBFileFormat enum
Aligned OBBalanceType1Code enum values to codeset listing
Fixed AISP Transaction 'Type' schema
Transactions CreditorAgent was missing LEI field
Updated RemittanceInformation2/Unstructured maxSize to match spec pages RemittanceInformation2
AISP - Updated ExternalMandateStatus1Code enum list to match codeset
AISP - Updated DirectDebits 'Name' field length to match spec pages size
AISP - Corrected 'CountPerSide' typo which was present in PointInTime description
StandingOrder payload (OBStandingOrder6) updated to match spec pages OBStandingOrder6
PISP - Aligned OBRemittanceInformation2 to spec page definition OBRemittanceInformation2
Removed duplicate pattern entry for x-fapi-auth-date header in CBPII
Restored PaymentStatus/StatusDetail/Status to be mandatory
Changed ExternalPaymentTransactionStatus1Code codeset location from ISO_External_CodeSet to OB_Internal_CodeSet as per v40_KI9 v40_KI9

v4.0

28 Jun 13:46
37b7753

Choose a tag to compare

v4.0 - 28th June 2024

Area Changes
All
  • Enum/codeset repository created on GitHub. OBL enums have been removed from namespaced enumeration page and participants should refer to this respository for values. Note, OBExternal* enum names have been updated to OBInternal*
  • New optional StatusReason array containing 0..*:
    • StatusReasonCode
    • Path
    • StatusReasonDescription
  • Sequence diagrams and consent status models updated with ISO values
  • Usage examples updated
All Alignment with ISO 20022:
  • ISO code names replaced by code value (e.g. AcceptedWithoutPosting is now ACWP)
  • Address fields aligned to ISO definition and rationalised into single address definition OBPostalAddress7.
  • LEI added to Creditor/Debtor/CreditorAgent objects
  • UltimateCreditor and UltimateDebtor added
  • MandateRelatedInformation added to DirectDebit and StandingOrder, this object replaces some fields from v3.1.11
  • RemittanceInformation object updated to ISO format, this replaces ‘reference’ in payment requests. The object name has been updated to OBRemittanceInformation2.
  • CreditorAccount & CreditorAgent now have the same (optional) fields across API endpoints
  • Proxy added to CreditorAccount/DebtorAccount (across AISP, PISP & CBPII)
AISP ISO 20022 changes
  • AccountType (OBExternalAccountType1Code) renamed to AccountCategory (OBInternalAccountType1Code)
  • AccountSubType renamed to AccountTypeCode
  • MORT (Mortgage) and WALT (Wallet) added to OBExternalAccountSubType1Code
  • Name added to Servicer in OBReadAccount6
  • StatementFrequencyAndFormat added to Account in OBReadAccount6
  • PaymentPurposeCode added to Transaction in OBReadTransaction6
  • CategoryPurposeCode added to Transaction in OBReadTransaction6
PISP ISO20022 changes
  • CategoryPurposeCode added to Risk object
  • RemittanceInformation added to payments
  • RegulatoryReporting added to payments
Errors
  • Simplified error object, top level Code and Message have been marked as optional and deprecated.
  • Error codes now in ISO 20022 code value format (4 chars) in the OBExternalStatusReason1Code enum
  • Additional guidance on errors experienced in the redirect flow or from PSU initiated changes
VRP
  • ContractPresentIndicator typo fixed
  • Added guidance on dynamic reference information for VRP payments
  • StatusReason now uses ExternalStatusReason1Code
  • To assist with version migration:
    • Introduced optional HTTP PUT/PATCH verbs for consents
    • Added payload version header
Payments
  • Updated payment message types information to include ISO 20022 changes, CHAPS migration and CBPR+
  • Richer payment status information aligned to ISO 20022 ExternalTransactionStatus1code
Various All 3.1.11 KI’s addressed
AISP
  • Added new ExtendedProprietaryBankTransactionCodes array to Transactions (TDA decision 264)
  • Permission code table updated with UltimateCreditor, UltimateDebtor and StatementFrequencyAndFormat
Various Frequency in OBMandateRelatedInformation1 object made mandatory
PISP CreditorAgent added to
  • Domestic Payment Consent
  • Domestic Payment
  • File payment Consents
  • File payment

v4.0-draft1

11 Apr 11:31
f57579a

Choose a tag to compare

v4.0-draft1 Pre-release
Pre-release

What's Changed

  • V3.1.11 by @wkrop in #98
  • v3.1.11 Release 2 by @wkrop in #103
  • V3.1.11 by @wkrop in #104
  • v3.1.11 Release 3 by @wkrop in #108
  • v3.1.11 Release 4 by @wkrop in #111
  • v3.1.11 Release 5 by @wkrop in #113
  • CDRW-4343 - Add CategoryPurposeCode by @charlieGreenyOB in #115
  • Generated .yaml from related json by @charlieGreenyOB in #117

Full Changelog: v3.1.11r5...v4.0.0-draft1

v3.1.11 Release 5

04 Mar 13:36
6b06eb9

Choose a tag to compare

What's Changed

  • CDRW-4229 - decision 258 - Add 'Wallet' to AccountSubType (OBExternalAccountSubType1Code)

Full Changelog: v3.1.11r4...v3.1.11r5