Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update iso api spec - Feat.iso20022.imp #178

Merged
merged 5 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3,721 changes: 2,176 additions & 1,545 deletions docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,30 @@ type: object
description: >
Specifies the unique identification of an account as assigned by the account
servicer.
properties:
IBAN:
description: >
IBAN

International Bank Account Number (IBAN) - identifier used internationally by financial
institutions to uniquely identify the account of a customer. Further specifications of the format and
content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services -
International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.
$ref: ./IBAN2007Identifier.yaml
Othr:
description: >
Other

Unique identification of an account, as assigned by the account servicer, using an
identification scheme.
$ref: ./GenericAccountIdentification1.yaml
oneOf:
- required:
- properties:
IBAN:
allOf:
- $ref: ./IBAN2007Identifier.yaml
- description: >
IBAN

International Bank Account Number (IBAN) - identifier used internationally by financial
institutions to uniquely identify the account of a customer. Further specifications of the format and
content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services -
International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.
required:
- IBAN
- required:
- properties:
Othr:
allOf:
- $ref: ./GenericAccountIdentification1.yaml
- description: >
Other

Unique identification of an account, as assigned by the account servicer, using an
identification scheme.
required:
- Othr
example:
IBAN: BE71096123456769
IBAN: BE71096123456769
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,26 @@ title: AccountSchemeName1Choice
type: object
description: |
Sets of elements to identify a name of the identification scheme.
properties:
Cd:
description: >
Code

Name of the identification scheme, in a coded form as published in an external list.
$ref: ./ExternalAccountIdentification1Code.yaml
Prtry:
description: >
Proprietary

Name of the identification scheme, in a free text form.
$ref: ./Max35Text.yaml
oneOf:
- required:
- properties:
Cd:
allOf:
- $ref: ./ExternalAccountIdentification1Code.yaml
- description: >
Code

Name of the identification scheme, in a coded form as published in an external list.
required:
- Cd
- required:
- properties:
Prtry:
allOf:
- $ref: ./Max35Text.yaml
- description: >
Proprietary

Name of the identification scheme, in a free text form.
required:
- Prtry
example:
Cd: 1111
Cd: 1111
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ description: >
unit of currency is explicit and compliant with ISO 4217.
properties:
ActiveCurrencyAndAmount:
$ref: ./ActiveCurrencyAndAmount_SimpleType.yaml
allOf:
- $ref: ./ActiveCurrencyAndAmount_SimpleType.yaml
Ccy:
description: >
Currency
allOf:
- $ref: ./ActiveCurrencyCode.yaml
- description: >
Currency

Identification of the currency in which the account is held.
$ref: ./ActiveCurrencyCode.yaml
Identification of the currency in which the account is held.
required:
- ActiveCurrencyAndAmount
- Ccy
example:
ActiveCurrencyAndAmount: 123.45
Ccy: USD
Ccy: USD
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@ description: >
the unit of currency is explicit and compliant with ISO 4217.
properties:
ActiveOrHistoricCurrencyAndAmount:
$ref: ./ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml
allOf:
- $ref: ./ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml
- description: >
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Ccy:
description: >
Currency
allOf:
- $ref: ./ActiveOrHistoricCurrencyCode.yaml
- description: >
Currency

Identification of the currency in which the account is held.
$ref: ./ActiveOrHistoricCurrencyCode.yaml
Identification of the currency in which the account is held.
required:
- ActiveOrHistoricCurrencyAndAmount
- Ccy
example:
ActiveOrHistoricCurrencyAndAmount: 123.45
Ccy: USD
Ccy: USD
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
description: |
AddressType2Code

Specifies the type of address.
ADDR Address
PBOX PostBox
HOME Home
BIZZ Business
MLTO MailingTo
DLVY Delivery
enum:
- ADDR
- PBOX
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,26 @@ title: AddressType3Choice
type: object
description: |
Choice of formats for the type of address.
properties:
Cd:
description: >
Code

Type of address expressed as a code.
$ref: ./AddressType2Code.yaml
Prtry:
description: >
Proprietary

Type of address expressed as a proprietary code.
$ref: ./GenericIdentification30.yaml
oneOf:
- required:
- properties:
Cd:
allOf:
- $ref: ./AddressType2Code.yaml
- description: >
Code

Type of address expressed as a code.
required:
- Cd
- required:
- properties:
Prtry:
allOf:
- $ref: ./GenericIdentification30.yaml
- description: >
Proprietary

Type of address expressed as a proprietary code.
required:
- Prtry
example:
Cd: ADDR
Cd: ADDR
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,23 @@ description: >
of a financial institution.
properties:
FinInstnId:
description: >
FinancialInstitutionIdentification
allOf:
- $ref: ./FinancialInstitutionIdentification18.yaml
- description: >
FinancialInstitutionIdentification

Unique and unambiguous identification of a financial institution, as assigned under an
internationally recognised or proprietary identification scheme.
$ref: ./FinancialInstitutionIdentification18.yaml
Unique and unambiguous identification of a financial institution, as assigned under an
internationally recognised or proprietary identification scheme.
BrnchId:
description: >
BranchIdentification
allOf:
- $ref: ./BranchData3.yaml
- description: >
BranchIdentification

Definition: Identifies a specific branch of a financial institution.
Definition: Identifies a specific branch of a financial institution.

Usage: This component should be used in case the identification information in the financial institution
component does not provide identification up to branch level.
$ref: ./BranchData3.yaml
Usage: This component should be used in case the identification information in the financial institution
component does not provide identification up to branch level.
required:
- FinInstnId
example:
Expand All @@ -38,4 +40,4 @@ example:
TwnNm: Town name
CtrySubDvsn: Country subdivision
Ctry: Country
AdrLine: Address line
AdrLine: Address line
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,20 @@ description: >
of a financial institution.
properties:
FinInstnId:
description: >
FinancialInstitutionIdentification
allOf:
- $ref: ./FinancialInstitutionIdentification23.yaml
- description: >
FinancialInstitutionIdentification

Unique and unambiguous identification of a financial institution or a branch of a financial
institution.
$ref: ./FinancialInstitutionIdentification23.yaml
Unique and unambiguous identification of a financial institution or a branch of a financial
institution.
BrnchId:
description: >
BranchIdentification
allOf:
- $ref: ./BranchData5.yaml
- description: >
BranchIdentification

Identifies a specific branch of a financial institution.
$ref: ./BranchData5.yaml
Identifies a specific branch of a financial institution.
required:
- FinInstnId
example:
Expand All @@ -35,4 +37,4 @@ example:
TwnNm: Town name
CtrySubDvsn: Country subdivision
Ctry: Country
AdrLine: Address line
AdrLine: Address line
38 changes: 21 additions & 17 deletions fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,33 @@ description: >
institution.
properties:
Id:
description: >
Identification
allOf:
- $ref: ./Max35Text.yaml
- description: >
Identification

Unique and unambiguous identification of a branch of a financial institution.
$ref: ./Max35Text.yaml
Unique and unambiguous identification of a branch of a financial institution.
LEI:
description: >
Legal Entity Identifier
allOf:
- $ref: ./LEIIdentifier.yaml
- description: >
Legal Entity Identifier

Legal entity identification for the branch of the financial institution.
$ref: ./LEIIdentifier.yaml
Legal entity identification for the branch of the financial institution.
Nm:
description: >
Name
allOf:
- $ref: ./Max140Text.yaml
- description: >
Name

Name by which an agent is known and which is usually used to identify that agent.
$ref: ./Max140Text.yaml
Name by which an agent is known and which is usually used to identify that agent.
PstlAdr:
description: >
Postal Address
allOf:
- $ref: ./PostalAddress24.yaml
- description: >
Postal Address

Information that locates and identifies a specific address, as defined by postal services.
$ref: ./PostalAddress24.yaml
Information that locates and identifies a specific address, as defined by postal services.
example:
Id: 123
Nm: Name
Expand All @@ -41,4 +45,4 @@ example:
TwnNm: Town name
CtrySubDvsn: Country subdivision
Ctry: Country
AdrLine: Address line
AdrLine: Address line
Loading