Releases: OpenBankingUK/read-write-api-specs
Releases · OpenBankingUK/read-write-api-specs
v4.0.1
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
CRYPtoOBExternalPurpose1Codein AIS to align with PIS, whereCRYP(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, &TWYRtoOBFrequency6Codein AIS and PIS - [v40_KI45] Added
SLCTtoOBFrequency2in AIS - [CDRW-4937] Added example values to
fromBookingDateTime,toBookingDateTime,fromStatementDateTimeandtoStatementDateTime. - [v40_KI46] Added
NONEtoOBFrequency2in 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]
CRYPadded toExternalPurpose1Code - [CR1] Added the following codes to
OBInternalStatementFeeType1Code:UK.OBIE.InstalmentPlanUK.OBIE.ReturnedPayment
- [CR1] Added the following codes to
OBInternalStatementInterestType1Code:UK.OBIE.InstalmentPlanUK.OBIE.MoneyTransfer
- [v4.x.x Consultation 1] Added rate limit headers to all OpenAPI files
- [CR2] Introduced a new
OBIntermediaryAgentclass which can appear up to 3 times in payload asIntermediaryAgent1,
IntermediaryAgent2andIntermediaryAgent3.- This is used in
OBReadTransaction6/Data/Transaction - Returning these fields requires use of the
ReadTransactionDetailpermission
- This is used in
- [v40_KI25] Deprecated
PaymentContextCodevalues 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
GETrequest.
- [v40_KI7]
OBDomesticRefundAccount1class definition added to the Payment Initiation and VRP OpenAPI files. - [v4.0.1 Draft 1]
HTTP 422has 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
ExternalDocumentType1Codein AIS:AROI,BOLD,CMCN,SOAC,TSUT,USAR,VCHR - [CDRW-4136] Updated
ErrorCode$ref name in PIS to useOBExternalStatusReason1Code, matching rest of OpenAPI files (previously usedOBInternalErrorResponseError1Code) - [CDRW-4960] Updated endpoint summaries and tags to align to usage. This has resulted in
Payment Detailsendpoints now being categorised and listed with their payment type. - [CDRW-4909] Improved description formatting for
RateLimit-Policy,RateLimit, andx-client-id, to match spec pages formatting. - [v40_KI42] Updated location of
ExternalDocumentFormat1CodetoISO_External_Codesetin description. - [CDRW-5014] Updated example value in Error responses from
AC17toU001in AIS and Events - [v40_KI48] Description for
OBReadStatement2/Data/Statement/StatementFee/RateTypechanged to "This code indicates the specific type of fee rate (e.g., AER, EAR)" - [v40_KI48] Description for
OBReadStatement2/Data/Statement/StatementInterest/RateTypechanged to "This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross)" - [CDRW-4949] Updated descriptions for
fromBookingDateTime,toBookingDateTime,fromStatementDateTimeandtoStatementDateTimeto 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
OBInternalConsentStatus1Codein to use re-usable domain-specific consent status codes (#204).
Changed codes:- Changed to
OBInternalConsentStatus2Codein all PIS consents except File Payments - Changed to
OBInternalConsentStatus3Codein only PIS File Payments consents
- Changed to
- [v40_KI36] Remap
ReferredDocumentAmountfromInt32toOBActiveCurrencyAndAmount_SimpleTypein AIS, PIS, & VRP (#205) - [v4.0.1 Draft 1] Updated usages of
ExternalPaymentTransactionStatus1Codefor PIS and VRP to use re-usable endpoint-specific payment
status codes (#208). Codes changed:ExternalPaymentTransactionStatus1Codeused in Domestic Standing Orders and International Standing OrdersExternalPaymentTransactionStatus2Codeused in Domestic Scheduled Payments and International Scheduled PaymentsExternalPaymentTransactionStatus3Codeused in Domestic Payments and International PaymentsExternalPaymentTransactionStatus4Codeused in File PaymentsExternalPaymentTransactionStatus5Codeused in Domestic VRP
- [v4.0.1 Draft 1]
MetaandLinkshave been made conditional in the VRP OpenAPI file. - [v40_KI5] VRP
OBCashAccountDebtorWithNamemax length is increased from 70 to 350 characters and is no longermandatory. - [v4.0.1 Draft 1] Updated
ReferredDocumentInformation/LineDetailsstring length to 2048 max characters. - [v40_KI7] The
Refundfield in the Payment Initiation and VRP OpenAPI files has been updated to point to the newly addedOBDomesticRefundAccount1class.
Removed
- [CDRW-5012] Removed duplicate
WEEKfromOBFrequency6Codein PIS - [CDRW-4765] Remove legacy v3 artefact
OBAddressTypeCodefrom Account Information (#202) - [CDRW-4878] Removed
x-fapi-financial-idfrom the Event Notifications OpenAPI file. - [v40_KI41]
CANCremoved from VRP payment status enum list
Fixed
- [CDRW-4136] Updated description of
OBExternalStatusReason1Codeto 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
PointInTimedescription fromCountPerSidetoCountPerPeriodin PIS (#194) - [CDRW-4802] Corrected description wording for
OBMandateRelatedInformation1/MandateIdentificationin PIS (#203) - [v40_KI30] Fixed regex patterns to match the spec pages (#192):
- Fixed missing
^and$throughout PIS - Fixed
\escaping in AIS
- Fixed missing
v4.0.1 - Release Candidate 2
Changelog
v4.0.1 Release Candidate 2 - 2026-02-04
Added
- Added
LWMH,LXMH, &TWYRtoOBFrequency6Codein AIS and PIS - Added
SLCTtoOBFrequency2in AIS - Added example values to
fromBookingDateTime,toBookingDateTime,fromStatementDateTimeandtoStatementDateTime.
Changed
- Updated example value in Error responses from
AC17toU001in AIS and Events - [CDRW-4948] Description for
OBReadStatement2/Data/Statement/StatementFee/RateTypechanged to "This code indicates the specific type of fee rate (e.g., AER, EAR)" - [CDRW-4948] Description for
OBReadStatement2/Data/Statement/StatementInterest/RateTypechanged to "This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross)" - [CDRW-4949] Updated descriptions for
fromBookingDateTime,toBookingDateTime,fromStatementDateTimeandtoStatementDateTimeto 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
NONEtoOBFrequency2in AIS
Removed
- Removed duplicate
WEEKfromOBFrequency6Codein 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)
CRYPadded toExternalPurpose1Code- Added the following codes to
OBInternalStatementFeeType1Code:UK.OBIE.InstalmentPlanUK.OBIE.ReturnedPayment
- Added the following codes to
OBInternalStatementInterestType1Code:UK.OBIE.InstalmentPlanUK.OBIE.MoneyTransfer
- Added rate limit headers to all OpenAPI files
- Introduced a new
OBIntermediaryAgentclass which can appear up to 3 times in payload asIntermediaryAgent1,
IntermediaryAgent2andIntermediaryAgent3.- This is used in
OBReadTransaction6/Data/Transaction - Returning these fields requires use of the
ReadTransactionDetailpermission
- This is used in
- Deprecated
PaymentContextCodevalues 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
GETrequest.
- For the avoidance of doubt - these values must not be accepted in a new consent and may only be accepted for
OBDomesticRefundAccount1class definition added to the Payment Initiation and VRP OpenAPI files.HTTP 422has 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
OBInternalConsentStatus1Codein to use re-usable domain-specific consent status codes (#204).
Changed codes:- Changed to
OBInternalConsentStatus2Codein all PIS consents except File Payments - Changed to
OBInternalConsentStatus3Codein only PIS File Payments consents
- Changed to
- Remap
ReferredDocumentAmountfromInt32toOBActiveCurrencyAndAmount_SimpleTypein AIS, PIS, & VRP (#205) - Updated usages of
ExternalPaymentTransactionStatus1Codefor PIS and VRP to use re-usable endpoint-specific payment
status codes (#208). Codes changed:ExternalPaymentTransactionStatus1Codeused in Domestic Standing Orders and International Standing OrdersExternalPaymentTransactionStatus2Codeused in Domestic Scheduled Payments and International Scheduled PaymentsExternalPaymentTransactionStatus3Codeused in Domestic Payments and International PaymentsExternalPaymentTransactionStatus4Codeused in File PaymentsExternalPaymentTransactionStatus5Codeused in Domestic VRP
MetaandLinkshave been made conditional in the VRP OpenAPI file.- VRP
OBCashAccountDebtorWithNamemax length is increased from 70 to 350 characters and is no longermandatory. - Updated
ReferredDocumentInformation/LineDetailsstring length to 2048 max characters. - The
Refundfield in the Payment Initiation and VRP OpenAPI files has been updated to point to the newly added
OBDomesticRefundAccount1class.
Removed
- Remove legacy v3 artefact
OBAddressTypeCodefrom Account Information (#202) - Removed
x-fapi-financial-idfrom the Event Notifications OpenAPI file. CANCremoved from VRP payment status enum list
Fixed
- Fixed typo in
PointInTimedescription fromCountPerSidetoCountPerPeriodin PIS (#194) - Corrected description wording for
OBMandateRelatedInformation1/MandateIdentificationin PIS (#203) - Fixed regex patterns to match the spec pages (#192):
- Fixed missing
^and$throughout PIS - Fixed
\escaping in AIS
- Fixed missing
Pull Requests
- V4.0.0 rc by @charlieGreenyOB in #176
- Cdrw 4534 update enums by @charlieGreenyOB in #177
- V4.0.0 by @charlieGreenyOB in #178
- fix typo by @charlieGreenyOB in #179
- [feature/REFAPP-1368] yaml to json ci/cd in #182
- Spec alignment by @OBPeteS in #183
- Merge v4.0 Update 3 draft into master by @OBPeteS in #185
- V4.0 update 4 draft - merge to master by @OBPeteS in #186
- Updated payment status enums to align to spec pages by @OBPeteS in #187
- Fix ob code mnemonic regex typo by @cjrobbertse-ob in #189
- Add License Reference by @cjrobbertse-ob in #191
- V4.0 update 5 by @OBPeteS in #196
- CDRW-4729 Correct typo in
PointInTimedescription by @cjrobbertse-ob in #194 - Added deprecated PaymentContextCode values by @OBPeteS in #200
- Add OBIntermediaryAgent1 by @OBPeteS in #197
- Removed CANC from VRP payment Status by @OBPeteS in #199
- Changed Meta and Links to be conditional by @OBPeteS in #201
- Cdrw 4771 & cdrw 4770 by @OBPeteS in #206
- Cdrw 4609 by @OBPeteS in #207
- CDRW-4726 Review all regex patterns in swagger files by @cjrobbertse-ob in #192
- CDRW-4760 Clarify ASPSP content type requirements in read file endpoints by @cjrobbertse-ob in #195
- CDRW-4765 Remove legacy v3 artefact ob address type code from account information v4 by @cjrobbertse-ob in #202
- CDRW-4802 Fix ob mandate related information1 mandate identification description in swagger by @cjrobbertse-ob in #203
- CDRW-4766 - Remap
ReferredDocumentAmountby @cjrobbertse-ob in #205 - Added HTTP 422 to response payloads by @OBPeteS in #212
- CDRW-4764-OBInternalConsentStatus1Code contains mixed enums by @cjrobbertse-ob in #204
- CDRW-4895 Separate external payment transaction status1 code by @cjrobbertse-ob in #208
- CDRW-4674 Add top note about optional and conditional fields by @cjrobbertse-ob in #209
- CDRW-4903 Bump version to 4.0.1 by @cjrobbertse-ob in #210
- CDRW-4735 - fix OBWriteInternational3/Data/Initiation/Creditor/Name by @OBPeteS in #211
- Rework OBIntermediaryAgent1 by @OBPeteS in #213
- Added CRYP to ExternalPurpose1Code by @OBPeteS in #214
- CDRW-4870 - update VRP OBCashAccountDebtorWithName by @OBPeteS in #217
- Add v4.0.1 changelog by @cjrobbertse-ob in #218
- CDRW-48883 by @OBPeteS in #215
- Cdrw 4878 rate limit headers by @OBPeteS in #216
- Updated UML diagrams by @OBPeteS in #219
- Add NONE to OBFrequency2Code by @cjrobbertse-ob in #221
- Revert "Add NONE to OBFrequency2Code" by @cjrobbertse-ob in #222
- Fixed issues with rate limit headers by @OBPeteS in #220
- Added NONE to OBFrequency2 by @cjro...
v4.0.1 - Release Candidate 1
Changelog
v4.0.1 Release Candidate 1 - 2026-01-05
Added
- Added
NONEtoOBFrequency2in AIS
Removed
- Removed duplicate
WEEKfromOBFrequency6Codein 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)
CRYPadded toExternalPurpose1Code- Added the following codes to
OBInternalStatementFeeType1Code:UK.OBIE.InstalmentPlanUK.OBIE.ReturnedPayment
- Added the following codes to
OBInternalStatementInterestType1Code:UK.OBIE.InstalmentPlanUK.OBIE.MoneyTransfer
- Added rate limit headers to all OpenAPI files
- Introduced a new
OBIntermediaryAgentclass which can appear up to 3 times in payload asIntermediaryAgent1,
IntermediaryAgent2andIntermediaryAgent3.- This is used in
OBReadTransaction6/Data/Transaction - Returning these fields requires use of the
ReadTransactionDetailpermission
- This is used in
- Deprecated
PaymentContextCodevalues 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
GETrequest.
- For the avoidance of doubt - these values must not be accepted in a new consent and may only be accepted for
OBDomesticRefundAccount1class definition added to the Payment Initiation and VRP OpenAPI files.HTTP 422has 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
OBInternalConsentStatus1Codein to use re-usable domain-specific consent status codes (#204).
Changed codes:- Changed to
OBInternalConsentStatus2Codein all PIS consents except File Payments - Changed to
OBInternalConsentStatus3Codein only PIS File Payments consents
- Changed to
- Remap
ReferredDocumentAmountfromInt32toOBActiveCurrencyAndAmount_SimpleTypein AIS, PIS, & VRP (#205) - Updated usages of
ExternalPaymentTransactionStatus1Codefor PIS and VRP to use re-usable endpoint-specific payment
status codes (#208). Codes changed:ExternalPaymentTransactionStatus1Codeused in Domestic Standing Orders and International Standing OrdersExternalPaymentTransactionStatus2Codeused in Domestic Scheduled Payments and International Scheduled PaymentsExternalPaymentTransactionStatus3Codeused in Domestic Payments and International PaymentsExternalPaymentTransactionStatus4Codeused in File PaymentsExternalPaymentTransactionStatus5Codeused in Domestic VRP
MetaandLinkshave been made conditional in the VRP OpenAPI file.- VRP
OBCashAccountDebtorWithNamemax length is increased from 70 to 350 characters and is no longermandatory. - Updated
ReferredDocumentInformation/LineDetailsstring length to 2048 max characters. - The
Refundfield in the Payment Initiation and VRP OpenAPI files has been updated to point to the newly added
OBDomesticRefundAccount1class.
Removed
- Remove legacy v3 artefact
OBAddressTypeCodefrom Account Information (#202) - Removed
x-fapi-financial-idfrom the Event Notifications OpenAPI file. CANCremoved from VRP payment status enum list
Fixed
- Fixed typo in
PointInTimedescription fromCountPerSidetoCountPerPeriodin PIS (#194) - Corrected description wording for
OBMandateRelatedInformation1/MandateIdentificationin PIS (#203) - Fixed regex patterns to match the spec pages (#192):
- Fixed missing
^and$throughout PIS - Fixed
\escaping in AIS
- Fixed missing
v4.0 Update 5
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
DCSVtoOBFileFormatschema in account-info-openapi. This addresses v40_KI42
Changed
- v40_KI34 - Update regex for
LEIin PIS & VRP- Addresses v40_KI34 which aligns the PIS regex for
LEIto the spec pages and updates the VRP swagger to include the regex & example.
- Addresses v40_KI34 which aligns the PIS regex for
- 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
formatfield and has been moved to the correctdescriptionfield. Additonally the request body schemea has been updated to fully reflect RFC 6902.
- The description was appearing in the
- Corrected a regex typo in AIS
OB_CodeMnemonic(#189). Related to v40_KI30. - Restored
Multipleto instances ofOBInternalAuthorisation1Code. Addresses Known Issue v40_KI44
v4.0 Update 4
Changelog for v4.0 Update 4
Please refer to the Known Issues for additional information on the fixes listed below.
Changes
- v40_KI27 - Add additional enum value to
ExternalEntryStatus1Code
Addresses Known Issue v40_KI27 which addsRJCTtoExternalEntryStatus1Codeto support backwards compatibility with previous versions of the spec. - v40_KI28 - Address issues with
MandateRelatedInformation
Addresses Known Issue v40_KI28:- Updated
MandateRelatedInformation\Frequency\Typeto 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
- Updated
- v40_KI29 - Restore
NumberOfPaymentsto Standing Orders
Addresses Known Issue v40_KI29 which restoresNumberOfPaymentsto the following areas:OBReadStandingOrder6/Data/StandingOrder/NumberOfPaymentsOBDomesticStandingOrder3/NumberOfPaymentsOBInternationalStandingOrder4/NumberOfPayments
- v40_KI32 - MultiAuthorisation status codes aligned to Spec pages.
Addresses Known Issue v40_KI32 whereAWAUwas present in the MultiAuthorisation enum list. This value has been updated toAWAF
v4.0 Update 3
Please refer to the Known Issues for additional information on the fixes listed below.
Changes
- 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.
- v40_KI18 - Add missing RCVD value to OBWriteDomesticResponse5
- Addresses Known Issue v40_KI18 where RCVD was missing from OBWriteDomesticResponse5 Status enum.
- v40_KI19 - Adds missing dash in phone number examples
- Addresses Known Issue v40_KI19 where the dash "-" is missing from the example phone numbers.
- v40_KI22 - Update File Payment FileType enum
- Addresses Known Issue v40_KI22 where
UK.OBIE.PaymentInitiation.4.0was missing from File PaymentsFileTypeenumeration. This replacesUK.OBIE.PaymentInitiation.3.1
- Addresses Known Issue v40_KI22 where
- v40_KI24 - Update File Payments OBWriteFile2 object
- Addresses Known Issue v40_KI24 where
OBWriteFile2was missingCredtorAgentfrom theInitiationobject andUltimateDebtorreferenced theUltimateCreditorschema.
- Addresses Known Issue v40_KI24 where
v4.0 Release 2
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
v4.0 - 28th June 2024
| Area | Changes |
|---|---|
| All |
|
| All | Alignment with ISO 20022:
|
| AISP | ISO 20022 changes
|
| PISP | ISO20022 changes
|
| Errors |
|
| VRP |
|
| Payments |
|
| Various | All 3.1.11 KI’s addressed |
| AISP |
|
| Various | Frequency in OBMandateRelatedInformation1 object made mandatory |
| PISP | CreditorAgent added to
|
v4.0-draft1
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
What's Changed
- CDRW-4229 - decision 258 - Add 'Wallet' to AccountSubType (OBExternalAccountSubType1Code)
Full Changelog: v3.1.11r4...v3.1.11r5