Skip to content

Releases: OpenBankingUK/read-write-api-specs

v4.0 Update 3

10 Jan 18:56
b6a61af
Compare
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
Compare
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
Compare
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
Compare
Choose a tag to compare
v4.0-draft1 Pre-release
Pre-release

What's Changed

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

v3.1.11 Release 5

04 Mar 13:36
6b06eb9
Compare
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

v3.1.11 Release 4

27 Feb 15:46
3fde4d1
Compare
Choose a tag to compare

What's Changed

  • CDRW-4228 - v3111_KI12 - Revert "CDRW-4215 - add DebtorAccount to DomesticVRPResp"

Full Changelog: v3.1.11r3...v3.1.11r4

v3.1.11 Release 3

18 Oct 11:52
ebbc72c
Compare
Choose a tag to compare

What's Changed

  • CDRW-4215 - v3111_KI5 - Update OBDomesticVRPResponse to make DebtorAccount on Swagger and UML diagrams
  • CDRW-4217 - v3111_KI7 - Add UK.OBIE.Wallet to OBExternalAccountIdentification4Code where missing

Full Changelog: v3.1.11r2...v3.1.11r3

v3.1.11 Release 2

23 Aug 13:14
Compare
Choose a tag to compare

What's Changed

Full Changelog: v3.1.11...v3.1.11r2

v3.1.11

19 Jun 12:36
a2e935d
Compare
Choose a tag to compare

What's Changed

  • CDRW-4134 - v3110_KI1 - Add VRPType to VRPRequest
  • CDRW-4154 - v3110_KI4 - fix incorrect field to ContractPresentIndicator
  • CDRW-4164 - v3110_KI9 - OB-301-VRP-100650 update asserted status code
  • Decision 258 - update OBReadStatement2, OBReadBalance1

Full Changelog: v3.1.10r6...v3.1.11

v3.1.11 DRAFT 1

24 Apr 12:46
Compare
Choose a tag to compare
v3.1.11 DRAFT 1 Pre-release
Pre-release

What's Changed

  • CDRW-4134 - v3110_KI1 - Add VRPType to VRPRequest
  • CDRW-4154 - v3110_KI4 - fix incorrect field to ContractPresentIndicator IN PROGRESS
  • CDRW-4164 - v3110_KI9 - OB-301-VRP-100650 update asserted status code
  • Decision 258 - update OBReadStatement2, OBReadBalance1

What's Changed

Full Changelog: v3.1.10r6...v3.1.11-draft1