Known Specification Issues

Spec pages have OBCashAccountDebtor4 listed against Debtor and DebtorAccount in OBDomestic2

https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/pisp/domestic-payment-consents.html#data-dictionary

In v3 the these objects contained the same fields and shared a base object (OBCashAccountDebtor4).

In v4:

• DebtorAccount includes the new Proxy object
• Debtor includes the new LEI field.

The initial release still referenced OBCashAccountDebtor4 for both these objects.

We will address this in a future release, the swaggers contain in-line definitions for some objects so payloads are unaffected.

Specs in future release

Swagger - update in future release (to remove in-line definitions)

Internal External repo- no change

00049617

00049681

00049811

OBDomesticVRPInitiation and OBDomesticVRPInstruction contain CreditorAgent

Specs - updated 19th September 2024

Swagger - updated 19th September 2024

Internal External repo- no change

The OBRemittanceInformation2/Unstructured data dictionary has the correct cardinality but the class column does not clearly indicate this is an array of Max140Text values. 

JSON examples show as a single entity rather than an array and Swagger has a length of 256 for the strings

OBRemittanceInformation2/Unstructured is an array of strings with Max140Text length each, as shown by the cardinality. The Data Dictionary class column will be updated in future release to further clarify this.

JSON examples will be updated in a future release and swagger will be updated in due course

Specs - updated 19th September 2024

Swagger - updated 19th September 2024

Internal External repo- no change

CreditorAgent is listed in the OBDomesticVRPInstruction data dictionary but is not present in the UML or swagger

Duplicate of v40_KI2

VRP spec pages list OBCashAccountDebtorWithName length as Max70Text but swagger lists it as Max350Text  

https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/vrp/domestic-vrp-consents.html#obcashaccountdebtorwithname

Swagger - updated 19th September 2024

Internal External repo- no change

OBWritePaymentDetails1 data dictionary is missing and UML shows wrong cardinality for Data and PaymentDetails.

VRP Payment details have been rolled back to v3 schema with ISO20022 values but table still shows the v4 changes

The data dictionary will be restored.

Swagger cardinality will be updated to show that Data is a singular mandatory field and PaymentStatus is an unbounded array of payment status details.

VRP swagger will be updated to match correct schema

UML diagrams will be updated when the spec pages are updated.

Specs - updated 19th September 2024

Swagger -updated 19th September 2024

Internal External repo- no change

VRP & PISP Class name for the 'refund' object is misaligned between the data dictionary and swaggers

The data dictionary assigns the refund object class as "OBDomesticRefundAccount1" and in the swaggers this is defined inline without a class (PISP) or as OBCashAccountDebtorWithName (VRP).

Object definitions in the swaggers are correct and class names will be aligned in a future release

Specs/Swaggers - aligned in a future release

Internal External repo- no change

Reference information missing from OBReadStandingOrder6

https://openbankinguk.github.io/read-write-api-site3/v4.0/resources-and-data-models/aisp/standing-orders.html#data-dictionary

This was replaced by RemittanceInformation but is missing from the payload.

Data Dictionary, UML and swaggers will be updated to include this object

Specs - updated 19th September 2024

Swagger - updated 19th September 2024

Internal External repo- no change

Codeset name is unchanged and can be found in the OB file.

Swaggers will be updated with the correct location.

Spec pages will be updated in next release to reference updated file.

Spec pages - updated in next release

Swaggers - updated updated 19th September 2024

Internal External repo in v4.0 onwards

PISP Standing Order payload requires frequency to be provided.  This object is mandatory but is contained in an optional parent object.

Spec pages - next release

Swaggers - updated 19th September 2024

Internal External repo- no change

The codes will be rolled back to v3 alignment but with ISO 20022 values.  This ensures file status and payment details payloads can be returned successfully as per v3 implementations.

Spec page shows original codes from v4 release, participants should refer to the swagger file.

File payments will be reviewed at TDA in due course to determine what changes, if any, are appropriate.

Spec pages - next release

Swaggers - updated 19th September 2024

Internal External repo- no change

Codeset listings have been updated on the GitHub repository. Change-log available here

Spec pages – primarily aligned on 19th September 2024

v40_KI9 will be addressed in a future release

Swagger in refresh

Internal External repo in v4.0 onwards

Swaggers updated 19th September 2024

Internal External repo- no change

Spec Pages in refresh

Internal External repo- no change

Spec pages in a future update

Swagger - no change required

Internal External repo- no change

International Payments Multi Authorisation table lists AWAU instead of AWAF

File Payments status table lists AWAU instead of AWAF

Spec pages - in a future update

Swaggers - updated in due course

Internal External repo- no change

CDRW-4669 - Getting issue details... STATUS

CDRW-4668 - Getting issue details... STATUS

OBWritePaymentDetailsResponse1 contains OBWritePaymentDetails1 as part of the payload.  UML and swagger files show correct class name

Spec pages - in aaddressed in v4.0 Swagger update 3 future update

Swagger - no change required

Internal External repo- no change

Spec pages - no change

Swagger - addressed in v4.0 Swagger update 3

Internal External repo- no change

OBParty2/Phone and OBParty2/Mobile data dictionary regex listing is missing the preceding slash.

One of the JSON examples phone numbers on the page is missing the dash.

Examples for PhoneNumber_0 (Phone) and PhoneNumber_1 (Mobile) in the OBParty2 swagger are missing the dash.

Correct regex is \+[0-9]{1,3}-[0-9()+\-]{1,30}

Phone number examples should contain a dash: +44-5556541109

Spec pages - in a future update

Swagger - addressed in v4.0 Swagger update 3

Internal External repo- no change

OBReadTransaction6/Data/Transaction/BankTransactionCode/Code uses ExternalBankTransactionFamily1Code which is defined as a 4 character code in ISO 20022 but JSON examples use the longer Code Names.

OBReadTransaction6/Data/Transaction/BankTransactionCode/SubCode uses ExternalBankTransactionSubFamily1Code which is defined as a 4 character code in ISO 20022 but JSON examples use the longer Code Names.

Examples will be updated with correct codes

Spec pages - in a future update

Internal External repo- no change

Spec pages - in a future update

Internal External repo- no change

Swagger will be updated: UK.OBIE.PaymentInitiation.4.0 will replace UK.OBIE.PaymentInitiation.3.1

Specs - no change

Swagger - addressed in v4.0 Swagger update 3

Internal External repo- no change

Item 2 of the Access Revocation description is misaligned to CEG wording:

The status of the account-access-consent must be changed to CANC and the AISP must be allowed to request PSU to re-authenticate the same account-access-consent resource.

The text will be aligned to the language used in the CEG:

The status of the account-access-consent should be changed to CANC. If the status of the consent is updated then an appropriate reason must be provided in StatusReason. The AISP must be allowed to request PSU to re-authenticate the same account-access-consent resource.

Specs - in a future updated

Swagger/FCS - no change

Internal External repo- no change

File Payments swagger is missing CreditorAgent in the initiation block of OBWriteFile2 and UltimateDebtor field reference points to the UltimateCreditor schema

CreditorAgent should be present in the the payload as it exists in the consent initiation block - note File Payments is currently under review.

UltimateDebtor and UltimateCreditor object schemas are semantically identical apart from the field descriptions, swagger will be updated to point to the correct schema

Specs - UML diagram updated in next release

Swagger - addressed in v4.0 Swagger update 3

FCS - in a future update

Internal External repo- no change

CDRW-4694 - Getting issue details... STATUS

CDRW-4695 - Getting issue details... STATUS

A number of deprecated enumeration values were removed from the OBRisk/PaymentContextCode field in v4 for both PIS and VRP. These values were deprecated in v3. 

In order to assist migration to v4 these codes will be reintroduced to the v4 swagger files so they can be returned for long lived consents.

Note: ASPSPs are not required to, but may choose to make PIS ConsentIds accessible across versions as these are short-lived consents: https://openbankinguk.github.io/read-write-api-site3/v4.0/profiles/payment-initiation-api-profile.html#get

The following values will be reintroduced to the swagger and marked as deprecated:

• BillPayment
• EcommerceGoods
• EcommerceServices
• PartyToParty
• PispPayee
• Other

Note: These values should not be accepted in a new v4 initiation request, they are only to be used for returning legacy v3 PIS & VRP data where relevant.

Specs - no change

Swagger - in a future update

FCS - swagger update only, no change to conformance tests.

Internal External repo- no change

00054409

Specs - no change

Swagger - no change

FCS - no change

Internal External repo in v4.0 onwards

October 2024

Specs - no change

Swagger - in a future update

FCS - swagger update only, no change to conformance tests.

Internal External repo in v4.0 onwards

CDRW-4721 - Getting issue details... STATUS

Spec pages - updated in next release

Swagger - updated in due course

FCS - internal swagger updated in due course

Internal External repo in v4.0 onwards

NumberOfPayments will be restored to the Standing Order payload as an optional field in the same location as it was in the v3 schema:

OBReadStandingOrder6/Data/StandingOrder/NumberOfPayments

OBDomesticStandingOrder3/NumberOfPayments

OBInternationalStandingOrder4/NumberOfPayments



Please refer to ASPSP developer portals for further information on whether NumberOfPayments is available in their v4 implementation.

Spec pages - updated in next release

Swagger - updated in due course

FCS - internal swagger updated in due course

Internal External repo- no change

It has been identified that some regex patterns in the YAML and JSON documents (referred to as the swagger files) have inconsistent escaping of the '\' character when the files are compared.

Whilst this does not appear to impact implementations (these inconsistencies existed in v3) all regex pattens in the files will be reviewed and any updates to ensure alignment will be published in the next Swagger update cycle

Spec pages - no change

Swagger - updated in due course

FCS - internal swagger updated in due course

Internal External repo- no change

Removed the duplicate enteries of ExternalDocumentFormat1code from ISO_External_Codeset and OB_Internal_Codeset. These are :

DPDF
DXML
SDSH
WORD
XSLT

Spec pages - no change

Swagger - no change

Internal External repo in 4.0 onwards