v4.0

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

Version 3.1.8 RC1

Version 3.1.8 - RC1

• VRP Profile, Resources and Examples View Diff
• Decision 229 - Support for rejected transactions View Diff
• Update version numbers View Diff

Version 3.1.7 Final

No further changes from Version 3.1.7 - Draft 1

Version 3.1.7 RC1

Change Log

Version 3.1.7 - Draft1

• Decision 225 - Debtor account details following payment initiation View Diff
• Decion 226 - Optional fields for accounts that have been switched out View Diff
• Miscelleneous fixes to address Known Issues View Diff
  • OBSD-16647 - Fixed incorrect class name for CreditorAccount in domestic-standing-order-consents
  • OBSD-16818 - Corrected the txn specification for events to replace the reference to x-fapi-transaction-id with x-fapi-interaction-id
  • OBSD-16778 - Added description for post endpoints in file-payments
  • OBSD-15322 - Updated the account name field sizes for parties so that they are consistent
  • Add additional examples for message signing
  • OBSD-17345 - Corrected the description and length of ReferencePaymentOrderId
  • OBSD-17586 - In the Accounts resource, corrected UK.CASS.NotSwitced in description to UK.CASS.NotSwitched
  • OBSD-18538 - Inconsistent description of "CreationDate" in payment resources.
  • OBSD-18590 - Incorrect example for usage of CountrySubDivision
• Update version numbers View Diff

Version 3.1.6 Final

v3.1.6

Merge branch 'master' into release/v3.1.6

Version 3.1.6 RC1

Version 3.1.6 - RC1

Decision 222 - CASS View Diff
    Changes based on impact assessment
    Rolled back Option 2

Decision 223 - Change length of Account/Name fields View Diff

Errata
    Fix the multiplicity for CountrySubDivision
    Clarify error message for invalid ISO Date
    Clarify the use of txn for Event Notifications

Version 3.1.6 Draft1

https://github.com/OpenBankingUK/read-write-api-docs-pub#change-log

Version 3.1.5 Final

Final Release - https://github.com/OpenBankingUK/read-write-api-docs-pub#change-log

Version 3.1.5 RC1

Version 3.1.5 - RC1

• Decision 220 - TransactionReference Length increased
• Errata - Refund Account/Name cardinality was incorrect
• Errata - Amount pattern allowed to supply amount with fractional digits

Version 3.1.5 Draft1

Version 3.1.5 - Draft1

• Decision 214 - Changes to the transactions AIS end-point to address mutability of booked transactions

• Decision 216 - implemented option#3 - introduced Debtor name in response of the payment order consent and payment order

• Decision 217 - Guidance for ASPSPs to provide an expected booking date for Credit Card Transactions

• Decision 219 - Provision for returning beneficiaries other than trusted beneficiaries

• Errata