diff --git a/dist/openapi/account-info-openapi.yaml b/dist/openapi/account-info-openapi.yaml index 1968cab..49201e3 100644 --- a/dist/openapi/account-info-openapi.yaml +++ b/dist/openapi/account-info-openapi.yaml @@ -2021,16 +2021,18 @@ components: PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' ProcessingStatus: - description: "Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" - type: string - enum: - - PDNG - - RCVD - - ACSP - - ACSC - - RJCT - - UNKN - - CANC + $ref: '#/components/schemas/OBIntermediaryAgentStatus1Code' + OBIntermediaryAgentStatus1Code: + description: "Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" + type: string + enum: + - PDNG + - RCVD + - ACSP + - ACSC + - RJCT + - UNKN + - CANC ExternalCreditorReferenceType1Code: type: string minLength: 1 @@ -6480,16 +6482,6 @@ components: - UK.OBIE.Quarterly - UK.OBIE.Weekly - UK.OBIE.Yearly - OBExternalStatementInterestRateType1Code: - description: Description that may be available for the statement Interest rate type. - type: string - example: UK.OBIE.FixedRate - x-namespaced-enum: - - UK.OBIE.BOEBaseRate - - UK.OBIE.FixedRate - - UK.OBIE.Gross - - UK.OBIE.LoanProviderBaseRate - - UK.OBIE.Net OBInternalStatementInterestType1Code: description: Interest amount type, in a coded form. For a full list of values see `OBInternalStatementInterestType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string @@ -6589,11 +6581,340 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `ExternalReason1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: AC17 OBMandateRelatedInformation1: type: object @@ -9041,14 +9362,6 @@ components: #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' - SubType: - description: >- - Balance sub type, in a coded form. Default if not specified is BCUR of the account - type: string - enum: - - BCUR - - LCUR - default: BCUR CreditLine: type: array items: @@ -9068,16 +9381,7 @@ components: in the balance amount of the account. type: boolean Type: - description: >- - Limit type, in a coded form.
- For a full list of enumeration values refer to `OBInternalLimitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Available - - Credit - - Emergency - - Pre-Agreed - - Temporary + $ref: '#/components/schemas/OBInternalLimitType1Code' Amount: type: object required: @@ -9109,10 +9413,8 @@ components: SubType: description: >- Balance sub type, in a coded form. Default if not specified is LCUR of the account - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: LCUR minItems: 1 TotalValue: @@ -9131,6 +9433,17 @@ components: Meta: $ref: '#/components/schemas/Meta' additionalProperties: false + OBInternalLimitType1Code: + description: >- + Limit type, in a coded form.
+ For a full list of enumeration values refer to `OBInternalLimitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - Available + - Credit + - Emergency + - Pre-Agreed + - Temporary OBReadBeneficiary5: type: object required: @@ -9161,33 +9474,7 @@ components: Permissions: type: array items: - description: >- - Specifies the Open Banking account access data types.
- This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
- For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - type: string - enum: - - ReadAccountsBasic - - ReadAccountsDetail - - ReadBalances - - ReadBeneficiariesBasic - - ReadBeneficiariesDetail - - ReadDirectDebits - - ReadOffers - - ReadPAN - - ReadParty - - ReadPartyPSU - - ReadProducts - - ReadScheduledPaymentsBasic - - ReadScheduledPaymentsDetail - - ReadStandingOrdersBasic - - ReadStandingOrdersDetail - - ReadStatementsBasic - - ReadStatementsDetail - - ReadTransactionsBasic - - ReadTransactionsCredits - - ReadTransactionsDebits - - ReadTransactionsDetail + $ref: '#/components/schemas/OBInternalPermissions1Code' minItems: 1 ExpirationDateTime: description: >- @@ -9271,33 +9558,7 @@ components: Permissions: type: array items: - description: >- - Specifies the Open Banking account access data types.
- This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
- For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - type: string - enum: - - ReadAccountsBasic - - ReadAccountsDetail - - ReadBalances - - ReadBeneficiariesBasic - - ReadBeneficiariesDetail - - ReadDirectDebits - - ReadOffers - - ReadPAN - - ReadParty - - ReadPartyPSU - - ReadProducts - - ReadScheduledPaymentsBasic - - ReadScheduledPaymentsDetail - - ReadStandingOrdersBasic - - ReadStandingOrdersDetail - - ReadStatementsBasic - - ReadStatementsDetail - - ReadTransactionsBasic - - ReadTransactionsCredits - - ReadTransactionsDebits - - ReadTransactionsDetail + $ref: '#/components/schemas/OBInternalPermissions1Code' minItems: 1 ExpirationDateTime: description: >- @@ -9350,6 +9611,34 @@ components: Meta: $ref: '#/components/schemas/Meta' additionalProperties: false + OBInternalPermissions1Code: + description: >- + Specifies the Open Banking account access data types.
+ This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
+ For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) + type: string + enum: + - ReadAccountsBasic + - ReadAccountsDetail + - ReadBalances + - ReadBeneficiariesBasic + - ReadBeneficiariesDetail + - ReadDirectDebits + - ReadOffers + - ReadPAN + - ReadParty + - ReadPartyPSU + - ReadProducts + - ReadScheduledPaymentsBasic + - ReadScheduledPaymentsDetail + - ReadStandingOrdersBasic + - ReadStandingOrdersDetail + - ReadStatementsBasic + - ReadStatementsDetail + - ReadTransactionsBasic + - ReadTransactionsCredits + - ReadTransactionsDebits + - ReadTransactionsDetail OBInternalConsentStatus1Code: description: Specifies the status of consent resource in code form. type: string @@ -9438,15 +9727,7 @@ components: minLength: 1 maxLength: 40 OfferType: - description: Offer type, in a coded form. For a full list of values refer to `OBExternalOfferType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - example: LimitIncrease - enum: - - BalanceTransfer - - LimitIncrease - - MoneyTransfer - - Other - - PromotionalRate + $ref: '#/components/schemas/OBExternalOfferType1Code' Description: description: Further details of the offer. type: string @@ -9531,6 +9812,29 @@ components: Meta: $ref: '#/components/schemas/Meta' additionalProperties: false + OBExternalOfferType1Code: + description: Offer type, in a coded form. For a full list of values refer to `OBExternalOfferType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + example: LimitIncrease + enum: + - BalanceTransfer + - LimitIncrease + - MoneyTransfer + - Other + - PromotionalRate + OBInternalProductType1Code: + description: >- + Descriptive code for the product category. + For a full list refer to `OBInternalProductType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)

+ If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description. + type: string + example: PersonalCurrentAccount + enum: + - BusinessCurrentAccount + - CommercialCreditCard + - Other + - PersonalCurrentAccount + - SMELoan OBReadParty2: type: object required: @@ -9612,18 +9916,7 @@ components: minLength: 1 maxLength: 70 ProductType: - description: >- - Descriptive code for the product category. - For a full list refer to `OBInternalProductType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)

- If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description. - type: string - example: PersonalCurrentAccount - enum: - - BusinessCurrentAccount - - CommercialCreditCard - - Other - - PersonalCurrentAccount - - SMELoan + $ref: '#/components/schemas/OBInternalProductType1Code' MarketingStateId: description: >- Unique and unambiguous identification of a Product @@ -11873,10 +12166,8 @@ components: description: >- The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: BCUR LocalAmount: type: object @@ -11896,10 +12187,8 @@ components: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: LCUR StatementDateTime: type: array @@ -12251,10 +12540,8 @@ components: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified - type: string - enum: - - BCUR - - LCUR + allOf: + - $ref: '#/components/schemas/OBExternalBalanceSubType1Code' default: LCUR StatementDateTime: type: array @@ -12317,13 +12604,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full description see `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: U004 + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string @@ -12552,6 +12833,27 @@ components: UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' additionalProperties: false + OBInternalCardSchemeType1Code: + description: |- + Name of the card scheme.
+ For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - AmericanExpress + - Diners + - Discover + - MasterCard + - VISA + OBInternalCardAuthorisationType1Code: + description: |- + The card authorisation type.
+ For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - ConsumerDevice + - Contactless + - None + - PIN OBTransactionCardInstrument1: type: object required: @@ -12561,26 +12863,9 @@ components: For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) properties: CardSchemeName: - description: |- - Name of the card scheme.
- For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - AmericanExpress - - Diners - - Discover - - MasterCard - - VISA + $ref: '#/components/schemas/OBInternalCardSchemeType1Code' AuthorisationType: - description: |- - The card authorisation type.
- For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - ConsumerDevice - - Contactless - - None - - PIN + $ref: '#/components/schemas/OBInternalCardAuthorisationType1Code' Name: description: Name of the cardholder using the card instrument. type: string diff --git a/dist/openapi/confirmation-funds-openapi.yaml b/dist/openapi/confirmation-funds-openapi.yaml index 0d999d4..637e7e5 100644 --- a/dist/openapi/confirmation-funds-openapi.yaml +++ b/dist/openapi/confirmation-funds-openapi.yaml @@ -738,17 +738,7 @@ components: a confirmation of funds consent will be applied. properties: SchemeName: - description: >- - Name of the identification scheme, in a coded form as - published in an external list. For a full list of values see `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - x-namespaced-enum: - - UK.OBIE.BBAN - - UK.OBIE.IBAN - - UK.OBIE.PAN - - UK.OBIE.Paym - - UK.OBIE.SortCodeAccountNumber - - UK.OBIE.Wallet + $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: description: >- Identification assigned by an institution to identify an @@ -781,6 +771,18 @@ components: Proxy: $ref: '#/components/schemas/OBProxy1' additionalProperties: false + OBInternalAccountIdentification4Code: + description: >- + Name of the identification scheme, in a coded form as + published in an external list. For a full list of values see `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + x-namespaced-enum: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + - UK.OBIE.Wallet OBFundsConfirmationConsentResponse1: type: object required: @@ -856,17 +858,7 @@ components: a confirmation of funds consent will be applied. properties: SchemeName: - description: >- - Name of the identification scheme, in a coded form as - published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - x-namespaced-enum: - - UK.OBIE.BBAN - - UK.OBIE.IBAN - - UK.OBIE.PAN - - UK.OBIE.Paym - - UK.OBIE.SortCodeAccountNumber - - UK.OBIE.Wallet + $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: description: >- Identification assigned by an institution to identify an @@ -994,23 +986,345 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `ExternalReturnReason1Code` - [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: U001 OBStatusReason: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full list of values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string diff --git a/dist/openapi/payment-initiation-openapi.yaml b/dist/openapi/payment-initiation-openapi.yaml index 939f826..ceda826 100644 --- a/dist/openapi/payment-initiation-openapi.yaml +++ b/dist/openapi/payment-initiation-openapi.yaml @@ -3260,7 +3260,7 @@ components: schema: type: string 422Error: - description: Duplicate Idempotency key + description: Duplicate Idempotency key headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. @@ -3763,18 +3763,6 @@ components: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' - OBAddressTypeCode: - description: Identifies the nature of the postal address. - type: string - enum: - - Business - - Correspondence - - DeliveryTo - - MailTo - - POBox - - Postal - - Residential - - Statement OBAddressType2Code: description: >- Identifies the nature of the postal address. For a full set of codes see @@ -3899,7 +3887,7 @@ components: type: object properties: ErrorCode: - $ref: '#/components/schemas/OBInternalErrorResponseError1Code' + $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: description: >- A description of the error that occurred. e.g., 'A mandatory field @@ -4399,14 +4387,343 @@ components: - RETL - DEBT - CRYP - OBInternalErrorResponseError1Code: + OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `OBInternalErrorResponseError1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: U001 OBFrequency6Code: description: '`OBFrequency6Code` on External Codset Repo' @@ -4470,17 +4787,6 @@ components: type: string maxLength: 256 minLength: 1 - OBPaymentStatusReason: - type: object - properties: - StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form - For more information and enum values see `OBExternalStatusReason1Code [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. @@ -4701,49 +5007,30 @@ components: description: Information needed due to regulatory and statutory requirements properties: DebitCreditReportingIndicator: - type: string - description: >- - Identifies whether the regulatory reporting information applies to - the debit side, to the credit side or to both debit and credit sides - of the transaction. - For a full list of values reefer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - CRED - - DEBT - - BOTH + $ref: '#/components/schemas/OBExternalRegulatoryReportingType1Code' Authority: $ref: '#/components/schemas/OBRegulatoryAuthority2' Details: type: array items: $ref: '#/components/schemas/OBStructuredRegulatoryReporting3' + OBExternalRegulatoryReportingType1Code: + type: string + description: >- + Identifies whether the regulatory reporting information applies to + the debit side, to the credit side or to both debit and credit sides + of the transaction. + For a full list of values reefer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - CRED + - DEBT + - BOTH OBRisk1: type: object additionalProperties: false properties: PaymentContextCode: - type: string - description: | - Specifies the payment context, `OBInternalPaymentContext1Code`
- The following values are deprecated and **must not** be used in a new consent or payment. They may optionally be returned for a hstorical payment/consent migrated to v4:
- * BillPayment - @deprecated - * EcommerceGoods - @deprecated - * EcommerceServices - @deprecated - * PartyToParty - @deprecated - * PispPayee - @deprecated - enum: - - BillingGoodsAndServicesInAdvance - - BillingGoodsAndServicesInArrears - - EcommerceMerchantInitiatedPayment - - FaceToFacePointOfSale - - TransferToSelf - - TransferToThirdParty - # deprecated values - - BillPayment - - EcommerceGoods - - EcommerceServices - - PartyToParty - - PispPayee + $ref: '#/components/schemas/OBInternalPaymentContext1Code' MerchantCategoryCode: type: string minLength: 3 @@ -4775,35 +5062,36 @@ components: description: |- The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. + OBInternalPaymentContext1Code: + type: string + description: | + Specifies the payment context, `OBInternalPaymentContext1Code`
+ The following values are deprecated and **must not** be used in a new consent or payment. They may optionally be returned for a hstorical payment/consent migrated to v4:
+ * BillPayment - @deprecated + * EcommerceGoods - @deprecated + * EcommerceServices - @deprecated + * PartyToParty - @deprecated + * PispPayee - @deprecated + enum: + - BillingGoodsAndServicesInAdvance + - BillingGoodsAndServicesInArrears + - EcommerceMerchantInitiatedPayment + - FaceToFacePointOfSale + - TransferToSelf + - TransferToThirdParty + # deprecated values + - BillPayment + - EcommerceGoods + - EcommerceServices + - PartyToParty + - PispPayee OBSCASupportData1: type: object properties: RequestedSCAExemptionType: - type: string - description: >- - This field allows a PISP to request specific SCA Exemption for a - Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - BillPayment - - ContactlessTravel - - EcommerceGoods - - EcommerceServices - - Kiosk - - Parking - - PartyToParty + $ref: '#/components/schemas/OBInternalSCAExemptionType1Code' AppliedAuthenticationApproach: - type: string - maxLength: 40 - description: >- - Specifies a character string with a maximum length of 40 characters. - - Usage: This field indicates whether the PSU was subject to SCA - performed by the TPP - - For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - CA - - SCA + $ref: '#/components/schemas/OBInternalAppliedAuthenticationApproach1Code' ReferencePaymentOrderId: type: string maxLength: 40 @@ -4813,19 +5101,39 @@ components: transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the - payment id e.g. DomesticPaymentId + payment id e.g. DomesticPaymentId description: Supporting Data provided by TPP, when requesting SCA Exemption. + OBInternalAppliedAuthenticationApproach1Code: + type: string + maxLength: 40 + description: >- + Specifies a character string with a maximum length of 40 characters. + + Usage: This field indicates whether the PSU was subject to SCA + performed by the TPP + + For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - CA + - SCA + OBInternalSCAExemptionType1Code: + type: string + description: >- + This field allows a PISP to request specific SCA Exemption for a + Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty OBStatusReason: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string @@ -5056,6 +5364,15 @@ components: $ref: '#/components/schemas/OBSupplementaryData1' Risk: $ref: '#/components/schemas/OBRisk1' + OBInternalReadRefundAccount1Code: + description: | + Specifies to share the refund account details with PISP. + + For a full set of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - 'No' + - 'Yes' OBWriteDomesticConsent4: type: object additionalProperties: false @@ -5070,11 +5387,7 @@ components: - Initiation properties: ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full set of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -5244,12 +5557,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full set of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single - - Multiple + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -5266,6 +5574,13 @@ components: $ref: '#/components/schemas/OBSCASupportData1' Risk: $ref: '#/components/schemas/OBRisk1' + OBInternalAuthorisation1Code: + description: Type of authorisation flow requested. For a full set of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - Any + - Single + - Multiple OBWriteDomesticConsentResponse5: type: object additionalProperties: false @@ -5320,13 +5635,7 @@ components: type: string format: date-time ReadRefundAccount: - description: >- - Specifies to share the refund account details with PISP. - For a full list of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -5551,12 +5860,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single - - Multiple + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -5863,12 +6167,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. For a full list of values refer to `OBInternalStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -5907,6 +6206,13 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + OBInternalStatus2Code: + description: Specifies the status of the authorisation flow in code form. For a full list of values refer to `OBInternalStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - AUTH + - AWAF + - RJCT OBWriteDomesticScheduled2: type: object additionalProperties: false @@ -6105,16 +6411,9 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -6283,12 +6582,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single - - Multiple + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -6305,6 +6599,11 @@ components: $ref: '#/components/schemas/OBSCASupportData1' Risk: $ref: '#/components/schemas/OBRisk1' + OBInternalPermissions2Code: + description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + type: string + enum: + - Create OBWriteDomesticScheduledConsentResponse5: type: object additionalProperties: false @@ -6360,16 +6659,9 @@ components: items: $ref: '#/components/schemas/OBStatusReason' Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -6593,12 +6885,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single - - Multiple + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -6894,12 +7181,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -7105,16 +7387,9 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -7252,12 +7527,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Any - - Single - - Multiple + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -7329,16 +7599,9 @@ components: items: $ref: '#/components/schemas/OBStatusReason' Permission: - description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -7510,11 +7773,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -7755,12 +8014,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -7831,11 +8085,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -7929,6 +8179,12 @@ components: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' + OBExternalFileType1Code: + description: Specifies the payment file type. + type: string + x-namespaced-enum: + - UK.OBIE.PaymentInitiation.4.0 + - UK.OBIE.pain.001.001.08 OBWriteFileConsent3: type: object additionalProperties: false @@ -7953,11 +8209,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -8059,11 +8311,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -8173,11 +8421,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -8279,11 +8523,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -8404,11 +8644,7 @@ components: file. properties: FileType: - description: Specifies the payment file type. - type: string - x-namespaced-enum: - - UK.OBIE.PaymentInitiation.4.0 - - UK.OBIE.pain.001.001.08 + $ref: '#/components/schemas/OBExternalFileType1Code' FileHash: description: >- A base64 encoding of a SHA256 hash of the file to be @@ -8510,12 +8746,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -8595,6 +8826,24 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + OBInternalPriority2Code: + description: >- + Indicator of the urgency or order of importance that the + instructing party would like the instructed party to apply + to the processing of the instruction. + type: string + enum: + - Normal + - Urgent + OBInternalExchangeRateType2Code: + description: >- + Specifies the type used to complete the currency + exchange. + type: string + enum: + - Actual + - Agreed + - Indicative OBWriteInternational3: type: object additionalProperties: false @@ -8664,14 +8913,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -8739,14 +8981,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -8881,11 +9116,7 @@ components: - Initiation properties: ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -8934,14 +9165,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -9009,14 +9233,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9143,11 +9360,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -9218,11 +9431,7 @@ components: type: string format: date-time ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -9303,12 +9512,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9377,14 +9581,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -9452,14 +9649,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9586,11 +9776,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -9743,12 +9929,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -9817,14 +9998,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -9892,14 +10066,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10026,12 +10193,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -10140,14 +10302,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -10230,14 +10385,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10373,16 +10521,9 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -10432,14 +10573,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -10522,14 +10656,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10656,11 +10783,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -10732,16 +10855,9 @@ components: type: string format: date-time Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -10822,12 +10938,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -10897,14 +11008,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -10987,14 +11091,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -11121,11 +11218,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -11278,12 +11371,7 @@ components: currency was bought with another currency. type: number RateType: - description: Specifies the type used to complete the currency exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -11353,14 +11441,7 @@ components: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: - description: >- - Indicator of the urgency or order of importance that the - instructing party would like the instructed party to apply - to the processing of the instruction. - type: string - enum: - - Normal - - Urgent + $ref: '#/components/schemas/OBInternalPriority2Code' ExtendedPurpose: description: >- Specifies the purpose of an international payment, when @@ -11443,14 +11524,7 @@ components: one currency was bought with another currency. type: number RateType: - description: >- - Specifies the type used to complete the currency - exchange. - type: string - enum: - - Actual - - Agreed - - Indicative + $ref: '#/components/schemas/OBInternalExchangeRateType2Code' ContractIdentification: description: >- Unique and unambiguous reference to the foreign exchange @@ -11577,12 +11651,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -11836,16 +11905,9 @@ components: - Initiation properties: Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' Initiation: type: object additionalProperties: false @@ -12031,11 +12093,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -12107,16 +12165,9 @@ components: type: string format: date-time Permission: - description: Specifies the Open Banking service request types. - type: string - enum: - - Create + $ref: '#/components/schemas/OBInternalPermissions2Code' ReadRefundAccount: - description: Specifies to share the refund account details with PISP - type: string - enum: - - 'No' - - 'Yes' + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' CutOffDateTime: description: >- Specified cut-off date and time for the payment consent. All @@ -12333,11 +12384,7 @@ components: description: The authorisation type request from the TPP. properties: AuthorisationType: - description: Type of authorisation flow requested. - type: string - enum: - - Any - - Single + $ref: '#/components/schemas/OBInternalAuthorisation1Code' CompletionDateTime: description: >- Date and time at which the requested authorisation flow must @@ -12626,12 +12673,7 @@ components: description: The multiple authorisation flow response from the ASPSP. properties: Status: - description: Specifies the status of the authorisation flow in code form. - type: string - enum: - - AUTH - - AWAF - - RJCT + $ref: '#/components/schemas/OBInternalStatus2Code' NumberRequired: description: >- Number of authorisations required for payment order (total @@ -12719,10 +12761,7 @@ components: Status: $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusReason: - description: "Reason Code provided for the status of a transfer. For a full list of values see code values for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" - type: string - minLength: 1 - maxLength: 4 + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Reason provided for the status of a transfer. For a full list of values see the code name entries for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). type: string diff --git a/dist/openapi/vrp-openapi.yaml b/dist/openapi/vrp-openapi.yaml index 53e84f5..ff14c39 100644 --- a/dist/openapi/vrp-openapi.yaml +++ b/dist/openapi/vrp-openapi.yaml @@ -591,7 +591,7 @@ components: schema: type: string 422Error: - description: Duplicate Idempotency key + description: Duplicate Idempotency key headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. @@ -1071,10 +1071,10 @@ components: minLength: 1 maxLength: 35 ExternalProxyAccountType1Code: - description: >- - Specifies the external proxy account type code, as published in the - proxy account type external code set.
For a - full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* + description: | + Specifies the external proxy account type code, as published in the proxy account type external code set. + + For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: @@ -1167,11 +1167,340 @@ components: OBExternalStatusReason1Code: description: >- Low level textual error code, for all enum values see - `ExternalReturnReason1Code` + `OBExternalStatusReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string - minLength: 4 - maxLength: 4 + enum: + - U000 + - U001 + - U002 + - U003 + - U004 + - U005 + - U006 + - U007 + - U008 + - U009 + - U010 + - U011 + - U012 + - U013 + - U014 + - U015 + - U016 + - U017 + - U018 + - U019 + - U020 + - U021 + - U022 + - U023 + - U024 + - U025 + - U026 + - U027 + - U028 + - U029 + - U030 + - U031 + - U032 + - U033 + - U034 + - U035 + - U036 + - U037 + - U038 + - U039 + - U040 + - U041 + - U042 + - 0080 + - 0081 + - 0082 + - 0083 + - 0084 + - 1100 + - 1161 + - 1162 + - 1163 + - 1165 + - 1166 + - 1177 + - 1178 + - 1180 + - 1181 + - 0000 + - AB01 + - AB02 + - AB03 + - AB04 + - AB05 + - AB06 + - AB07 + - AB08 + - AB09 + - AB10 + - AB11 + - AC01 + - AC02 + - AC03 + - AC04 + - AC05 + - AC06 + - AC07 + - AC08 + - AC09 + - AC10 + - AC11 + - AC12 + - AC13 + - AC14 + - AC15 + - AC16 + - AG01 + - AG02 + - AG03 + - AG04 + - AG05 + - AG06 + - AG07 + - AG08 + - AG09 + - AG10 + - AG11 + - AG12 + - AG13 + - AGNT + - AM01 + - AM02 + - AM03 + - AM04 + - AM05 + - AM06 + - AM07 + - AM09 + - AM10 + - AM11 + - AM12 + - AM13 + - AM14 + - AM15 + - AM16 + - AM17 + - AM18 + - AM19 + - AM20 + - AM21 + - AM22 + - AM23 + - BE01 + - BE04 + - BE05 + - BE06 + - BE07 + - BE08 + - BE09 + - BE10 + - BE11 + - BE12 + - BE13 + - BE14 + - BE15 + - BE16 + - BE17 + - BE18 + - BE19 + - BE20 + - BE21 + - BE22 + - BE23 + - CERI + - CH03 + - CH04 + - CH07 + - CH09 + - CH10 + - CH11 + - CH12 + - CH13 + - CH14 + - CH15 + - CH16 + - CH17 + - CH19 + - CH20 + - CH21 + - CH22 + - CHQC + - CNOR + - CURR + - CUST + - DNOR + - DS01 + - DS02 + - DS03 + - DS04 + - DS05 + - DS06 + - DS07 + - DS08 + - DS09 + - DS0A + - DS0B + - DS0C + - DS0D + - DS0E + - DS0F + - DS0G + - DS0H + - DS0K + - DS10 + - DS11 + - DS12 + - DS13 + - DS14 + - DS15 + - DS16 + - DS17 + - DS18 + - DS19 + - DS20 + - DS21 + - DS22 + - DS23 + - DS24 + - DS25 + - DS26 + - DS27 + - DT01 + - DT02 + - DT03 + - DT04 + - DT05 + - DT06 + - DU01 + - DU02 + - DU03 + - DU04 + - DU05 + - DUPL + - ED01 + - ED03 + - ED05 + - ED06 + - ERIN + - FF01 + - FF02 + - FF03 + - FF04 + - FF05 + - FF06 + - FF07 + - FF08 + - FF09 + - FF10 + - FF11 + - G000 + - G001 + - G002 + - G003 + - G004 + - G005 + - G006 + - ID01 + - MD01 + - MD02 + - MD05 + - MD06 + - MD07 + - MS02 + - MS03 + - NARR + - NERI + - RC01 + - RC02 + - RC03 + - RC04 + - RC05 + - RC06 + - RC07 + - RC08 + - RC09 + - RC10 + - RC11 + - RC12 + - RCON + - RECI + - RF01 + - RR01 + - RR02 + - RR03 + - RR04 + - RR05 + - RR06 + - RR07 + - RR08 + - RR09 + - RR10 + - RR11 + - RR12 + - S000 + - S001 + - S002 + - S003 + - S004 + - SL01 + - SL02 + - SL03 + - SL11 + - SL12 + - SL13 + - SL14 + - TA01 + - TD01 + - TD02 + - TD03 + - TK01 + - TK02 + - TK03 + - TK09 + - TKCM + - TKSG + - TKSP + - TKVE + - TKXP + - TM01 + - TS01 + - TS04 + - CN01 + - FOCR + - FR01 + - NOCM + - NOAS + - RUTA + - UPAY + - ALAC + - AEXR + - ARFR + - ARJR + - ATNS + - EDTR + - EDTL + - FRAD + - IEDT + - IRNR + - NOAR + - NOPG + - NRCH + - RTNS + - REPR + - SPII + - PINS + - UCRD + - FF12 + - FF13 + - DC02 + - APAR example: U001 OBDomesticVRPConsentResponse: type: object @@ -1190,13 +1519,7 @@ components: - Initiation properties: ReadRefundAccount: - type: string - enum: - - 'Yes' - - 'No' - description: > - Indicates whether information about RefundAccount should be - included in the payment response. + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' ConsentId: type: string minLength: 1 @@ -1235,10 +1558,17 @@ components: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' + OBInternalReadRefundAccount1Code: + description: "Indicates whether the `RefundAccount` object should be included in the response" + type: string + enum: + - 'Yes' + - 'No' OBInternalConsentStatus1Code: - description: >- - Specifies the status of consent resource in code form. AWAU and - RJCT only can returned on initial submission. For a full list of values see `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + description: | + Specifies the status of consent resource in code form. AWAU and RJCT only can returned on initial submission. + + For a full list of values see `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - AWAU @@ -1259,12 +1589,7 @@ components: - Initiation properties: ReadRefundAccount: - type: string - enum: - - 'Yes' - - 'No' - description: > - Indicates whether the `RefundAccount` object should be included in the response + $ref: '#/components/schemas/OBInternalReadRefundAccount1Code' ControlParameters: $ref: '#/components/schemas/OBDomesticVRPControlParameters' Initiation: @@ -1301,6 +1626,7 @@ components: - Currency properties: PeriodType: + description: "Period type for this period limit" type: string enum: - Day @@ -1309,14 +1635,15 @@ components: - Month - Half-year - Year - description: ^ Period type for this period limit PeriodAlignment: + description: >- + Specifies whether the period starts on the date of consent creation or lines up with a calendar. As + the ISO calendar does not support or provide any guidance on when a fortnight should start, a + `PeriodType` of `Fortnight` the `PeriodAlignment` must be `Consent`. type: string enum: - Consent - Calendar - description: >- - Specifies whether the period starts on the date of consent creation or lines up with a calendar. As the ISO calendar does not support or provide any guidance on when a fortnight should start, a `PeriodType` of `Fortnight` the `PeriodAlignment` must be `Consent`. Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: @@ -1805,12 +2132,6 @@ components: properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' - OBExternalStatus2Code: - type: string - enum: - - AUTH - - AWAU - - RJCT OBInternalChargeBearerType1Code: type: string description: >- @@ -1877,18 +2198,6 @@ components: description: > Additional information that can not be captured in the structured fields and/or any other specific block. - OBExternalCreditorReferenceType1Code: - type: string - minLength: 1 - maxLength: 4 - description: "Specifies the type of creditor reference as published in an external creditor reference type code set.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`DISP`-Document is a dispatch advice.\n*`FXDR`-Document is a pre-agreed or pre-arranged foreign exchange transaction to which the payment transaction refers.\n*`PUOR`-Document is a purchase order.\n*`RPIN`-Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.\n*`RADM`-Document is a remittance advice sent separately from the current transaction.\n*`SCOR`-Document is a structured communication reference provided by the creditor to identify the referred transaction." - enum: - - DISP - - FXDR - - PUOR - - RPIN - - RADM - - SCOR ExternalDocumentType1Code: type: string minLength: 1 @@ -2069,12 +2378,6 @@ components: type: string x-namespaced-enum: - UK.OBIE.BICFI - OBExternalAccountType1Code: - description: Specifies the type of account (personal or business). - type: string - enum: - - Business - - Personal OBInternalExtendedAccountType1Code: description: Specifies the extended type of account if known. For a full set of values refer to `OBInternalExtendedAccountType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string @@ -2096,7 +2399,7 @@ components: - Wealth OBInternalLocalInstrument1Code: type: string - description: >- + description: | User community specific instrument. Usage: This element is used to specify a local instrument, local @@ -2499,13 +2802,7 @@ components: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form - For more information and enum values see `OBExternalStatusReason1Code [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. @@ -2563,18 +2860,6 @@ components: maxLength: 70 minItems: 0 maxItems: 7 - OBAddressTypeCode: - description: Identifies the nature of the postal address. - type: string - enum: - - Business - - Correspondence - - DeliveryTo - - MailTo - - POBox - - Postal - - Residential - - Statement OBAddressType2Code: description: >- Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). @@ -2605,15 +2890,7 @@ components: description: Information needed due to regulatory and statutory requirements properties: DebitCreditReportingIndicator: - type: string - description: >- - Identifies whether the regulatory reporting information applies to - the debit side, to the credit side or to both debit and credit sides - of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - enum: - - CRED - - DEBT - - BOTH + $ref: '#/components/schemas/OBExternalRegulatoryReportingType1Code' Authority: $ref: '#/components/schemas/OBRegulatoryAuthority2' Details: @@ -2621,17 +2898,21 @@ components: type: array items: $ref: '#/components/schemas/OBStructuredRegulatoryReporting3' + OBExternalRegulatoryReportingType1Code: + type: string + description: >- + Identifies whether the regulatory reporting information applies to + the debit side, to the credit side or to both debit and credit sides + of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) + enum: + - CRED + - DEBT + - BOTH OBStatusReason: type: object properties: StatusReasonCode: - type: string - description: |- - Specifies the status reason in a code form. - For a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - minLength: 1 - maxLength: 4 - example: ERIN + $ref: '#/components/schemas/OBExternalStatusReason1Code' StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string @@ -2763,14 +3044,6 @@ components: type: string pattern: '^[A-Z]{2,2}$' description: Nation with its own government. - OBVRPStatusReasonCode: - type: string - x-namespaced-enum: - - UK.OBIE.ExemptionNotApplied - - UK.OBIE.OtherReason - description: > - Reason Code provided for the status of a VRP. To be documented in the - Developer Portal. OBVRPConsentType: type: string x-namespaced-enum: @@ -2795,28 +3068,7 @@ components: additionalProperties: false properties: PaymentContextCode: - type: string - description: | - Specifies the payment context, for a full list of values refer to `OBInternalPaymentContext1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
- The following values are deprecated and can only be used to make a payment on an existing v3 consent which used one of the deprecated values and has been migrated to v4. They **must not** be used in a new consent. They may optionally be returned for a historical payment/consent migrated to v4:
- * BillPayment - @deprecated - * EcommerceGoods - @deprecated - * EcommerceServices - @deprecated - * PartyToParty - @deprecated - * PispPayee - @deprecated - enum: - - BillingGoodsAndServicesInAdvance - - BillingGoodsAndServicesInArrears - - EcommerceMerchantInitiatedPayment - - FaceToFacePointOfSale - - TransferToSelf - - TransferToThirdParty - # deprecated values - - BillPayment - - EcommerceGoods - - EcommerceServices - - PartyToParty - - PispPayee + $ref: '#/components/schemas/OBInternalPaymentContext1Code' MerchantCategoryCode: type: string minLength: 3 @@ -2848,6 +3100,29 @@ components: description: |- The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. + OBInternalPaymentContext1Code: + type: string + description: | + Specifies the payment context, for a full list of values refer to `OBInternalPaymentContext1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
+ The following values are deprecated and can only be used to make a payment on an existing v3 consent which used one of the deprecated values and has been migrated to v4. They **must not** be used in a new consent. They may optionally be returned for a historical payment/consent migrated to v4:
+ * BillPayment - @deprecated + * EcommerceGoods - @deprecated + * EcommerceServices - @deprecated + * PartyToParty - @deprecated + * PispPayee - @deprecated + enum: + - BillingGoodsAndServicesInAdvance + - BillingGoodsAndServicesInArrears + - EcommerceMerchantInitiatedPayment + - FaceToFacePointOfSale + - TransferToSelf + - TransferToThirdParty + # deprecated values + - BillPayment + - EcommerceGoods + - EcommerceServices + - PartyToParty + - PispPayee Links: required: - Self